[Swift-commit] r5789 - trunk/docs/siteguide

[davidk at ci.uchicago.edu]

Author: davidk
Date: 2012-05-11 12:47:42 -0500 (Fri, 11 May 2012)
New Revision: 5789

Added:
   trunk/docs/siteguide/uc3
Modified:
   trunk/docs/siteguide/siteguide.txt
Log:
siteguide documentation for uc3


Modified: trunk/docs/siteguide/siteguide.txt
===================================================================
--- trunk/docs/siteguide/siteguide.txt	2012-05-11 04:28:38 UTC (rev 5788)
+++ trunk/docs/siteguide/siteguide.txt	2012-05-11 17:47:42 UTC (rev 5789)
@@ -23,3 +23,5 @@
 include::mcs[]
 
 include::grid[]
+
+include::uc3[]

Added: trunk/docs/siteguide/uc3
===================================================================
--- trunk/docs/siteguide/uc3	                        (rev 0)
+++ trunk/docs/siteguide/uc3	2012-05-11 17:47:42 UTC (rev 5789)
@@ -0,0 +1,53 @@
+x86 Cluster: UC3
+----------------
+
+Create a coaster-service.conf
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+To begin, copy the text below and paste it into your Swift distribution's etc
+directory. Name the file coaster-service.conf.
+
+-----
+include::../../tests/providers/uc3/coaster-service.conf[]
+-----
+
+Starting the Coaster Service
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Change directories to the location you would like to run a
+Swift script and start the coaster service with this
+command:
+
+-----
+start-coaster-service
+-----
+
+This will create a configuration file that Swift needs
+called sites.xml.
+
+WARNING: Any existing sites.xml files in this directory
+will be overwritten. Be sure to make a copy of any
+custom configuration files you may have.
+
+Run Swift
+~~~~~~~~~
+
+Next, run Swift. If you do not have a particular script
+in mind, you can test Swift by using a Swift script in
+the examples/ directory.
+
+Run the following command to run the script:
+-----
+swift -sites.file sites.xml -tc.file tc.data yourscript.swift
+-----
+
+Stopping the Coaster Service
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The coaster service will run indefinitely. The stop-coaster-service
+script will terminate the coaster service.
+
+-----
+$ stop-coaster-service
+-----
+
+This will kill the coaster service and kill the worker scripts on remote systems.
+