[Swift-commit] r7666 - SwiftApps/cloud

[ketan at ci.uchicago.edu]

Author: ketan
Date: 2014-03-09 16:37:38 -0500 (Sun, 09 Mar 2014)
New Revision: 7666

Modified:
   SwiftApps/cloud/README
Log:
README improvements

Modified: SwiftApps/cloud/README
===================================================================
--- SwiftApps/cloud/README	2014-03-09 21:27:49 UTC (rev 7665)
+++ SwiftApps/cloud/README	2014-03-09 21:37:38 UTC (rev 7666)
@@ -23,8 +23,8 @@
 
 Installation and setup
 ----------------------
-To install Swift, follow instructions found http://swift-lang.org/downloads/index.php[here]. We use the Swift version 0.94 from the svn repo. Note that Swift
-installation is required only on the submit host and not on cloud nodes. To checkout the current package from svn repository:
+To install Swift, follow the instructions found http://swift-lang.org/downloads/index.php[here]. We use the Swift version 0.94 from the SVN repository. Note that Swift
+installation is required only on the submit host and not on the cloud instances. To checkout the Swift-cloud provision package from SVN repository use the following command: 
 
 ----
 svn co https://svn.ci.uchicago.edu/svn/vdl2/SwiftApps/cloud swift-cloud
@@ -34,7 +34,7 @@
 Configure
 ----------
 
-environment variables
+Environment variables
 ~~~~~~~~~~~~~~~~~~~~~~
 
 Make sure `GLOBUS_TCP_PORT_RANGE` and `GLOBUS_HOSTNAME` are defined. For example:
@@ -44,8 +44,8 @@
 export GLOBUS_HOSTNAME=churn.mcs.anl.gov
 ----
 
-EC2
-~~~~
+EC2 configuration
+~~~~~~~~~~~~~~~~~~
 
 Make sure you have access to an EC2 image `ami-id`, have `security-group` and `keypair` set up. If you already have `keypair` for EC2 installed, you can find via the following command:
 
@@ -64,7 +64,7 @@
 coaster-service.conf
 ~~~~~~~~~~~~~~~~~~~~~
 
-Configure `coaster-service.conf` to your environment. An example `coaster-service.conf` can be
+Configure `coaster-service.conf` according to your environment. An example `coaster-service.conf` can be
 found in the `swift-cloud` directory. Make sure to set the EC2XXX variables to
 the correct values as per your EC2 allocation. For example:
 
@@ -74,14 +74,15 @@
 export EC2SECGRP=Swift
 ----
 
-Set other environment variables
-e.g:
+Set other environment variables to suitable values, for example:
 
 ----
 export WORKER_LOCATION=/home/ubuntu/worker
+#username on instances, can be root
 export WORKER_USERNAME=ubuntu
 export LOG_DIR=logs
 export SHARED_FILESYSTEM=no
+#when instances cannot connect back to submit host
 export SSH_TUNNELING=yes
 ----
 
@@ -94,7 +95,11 @@
 start-coaster-service
 ----
 
-Above command will generate an `apps` and `sites.xml` configuration file. Use these configuration files to run Swift command as shown in the next section. Make sure `coaster-service.conf` configuration is available in the current working directory or use the `-conf` option to use config file located elsewhere.
+Above command will generate an `apps` and `sites.xml` configuration file. Use
+these configuration files to run Swift command as shown in the next section.
+Make sure `coaster-service.conf` configuration is available in the current
+working directory or use the `-conf` option to use config file located
+elsewhere.
 
 Typical output of the above `start-coaster-service` will look as follows: