[Swift-commit] r5446 - branches/release-0.93/docs/siteguide

[davidk at ci.uchicago.edu]

Author: davidk
Date: 2011-12-19 13:15:32 -0600 (Mon, 19 Dec 2011)
New Revision: 5446

Modified:
   branches/release-0.93/docs/siteguide/futuregrid
   branches/release-0.93/docs/siteguide/intrepid
Log:
Reflect recent futuregrid changes to siteguide, fix missing link in intrepid guide


Modified: branches/release-0.93/docs/siteguide/futuregrid
===================================================================
--- branches/release-0.93/docs/siteguide/futuregrid	2011-12-19 17:26:40 UTC (rev 5445)
+++ branches/release-0.93/docs/siteguide/futuregrid	2011-12-19 19:15:32 UTC (rev 5446)
@@ -1,26 +1,6 @@
 Futuregrid Quickstart Guide
 ---------------------------
 
-Downloading and Building Swift
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The most recent versions of Swift can be found at 
-http://www.ci.uchicago.edu/swift/downloads/index.php. To run on futuregrid,
-you will need to use Swift 0.93 or later.
-
-Adding Swift to your PATH
-~~~~~~~~~~~~~~~~~~~~~~~~~
-Once you have installed Swift, add the Swift binary to your PATH so you can
-easily run it from any directory. 
-
-In your home directory, edit the file ".bashrc".
-
-If you have installed Swift via a source repository, add the following line
-at the bottom of .bashrc.
-
------
-export PATH=$PATH:$HOME/cog/modules/swift/dist/swift-svn/bin
------
-
 Requesting Futuregrid Access
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 If you do not already have a futuregrid account, you can follow the
@@ -51,45 +31,57 @@
 called vws.repository.s3id and vws.repository.s3key. Copy these
 values for the next step.
 
-Configuring Swift VM Tools
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-Change directories into the swift-vm-boot directory. Edit the file
-called env.sh. There are two settings here that you will need to
-modify: FUTUREGRID_IAAS_ACCESS_KEY and FUTUREGRID_IAAS_SECRET_KEY.
-Paste your access key (s3id) and secret key (s3key) here and save
-the file. By default, env.sh requests 2 nodes on hotel and 2 nodes
-on sierra. Change these values as needed. Run install.sh from the 
-swift-vm-boot directory to complete the installation of Swift VM 
-Tools. The Swift VM Tools may require a fairly recent version of
-Python. If you run into problems while running the install.sh
-script, please try a more recent version of Python and associated
-libraries.
-
 Configuring coaster-service.conf
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Within your swift distribution's etc directory is a file called 
-coaster-service.conf. There are many options here you can modify
-as needed, but these are the settings that will be required
-to run on futuregrid:
+To run on futuregrid, you will need a file called coaster-service.conf. 
+This file contains many options to control how things run. Here is
+an example of a working coaster-service.conf on futuregrid. 
 
 -----
-export WORKER_WORK=/tmp
+# Where to copy worker.pl on the remote machine for sites.xml
+export WORKER_LOCATION=/tmp
+
+# How to launch workers: local, ssh, cobalt, or futuregrid
 export WORKER_MODE=futuregrid
+
+# Do all the worker nodes you're using have a shared filesystem? (yes/no)
 export SHARED_FILESYSTEM=no
+
+# Username to use on worker nodes
 export WORKER_USERNAME=root
+
+# Enable SSH tunneling? (yes/no)
 export SSH_TUNNELING=yes
+
+# Directory to keep log files, relative to working directory when launching start-coaster-service
+export LOG_DIR=logs
+
+# Location of the swift-vm-boot scripts
 export SWIFTVMBOOT_DIR=$HOME/swift-vm-boot
+
+# Futuregrid settings
+export FUTUREGRID_IAAS_ACCESS_KEY=XXXXXXXXXXXXXXXXXXXXX
+export FUTUREGRID_IAAS_SECRET_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+export FUTUREGRID_HOTEL_NODES=0
+export FUTUREGRID_SIERRA_NODES=2
+export FUTUREGRID_CPUS_PER_NODE=1
+
+# Swift information for creating sites.xml
 export WORK=/tmp
+export JOBS_PER_NODE=$FUTUREGRID_CPUS_PER_NODE
+export JOB_THROTTLE=$( echo "scale=5; ($JOBS_PER_NODE * $(($FUTUREGRID_HOTEL_NODES + $FUTUREGRID_SIERRA_NODES)))/100 - 0.00001"|bc )
+
+# Application locations for tc.data
+#app convert=/usr/bin/convert
 -----
 
-These is a brief description of these settings in the coaster-service.conf file.
-Tunneling should be used when you are restricted by a firewall. If your local
-machine has multiple network interfaces, you should also manually set the IP
-address of your machine with export IPADDR=your.ip.address.here.
+Paste your credentials from the hotel.conf file into the FUTUREGRID_IAAS_ACCESS_KEY and FUTUREGRID_IAAS_SECRET_KEY fields.
+Adjust the number of nodes you would like to allocate here by changing the values of FUTUREGRID_HOTEL_NODES and FUTUREGRID_SIERRA_NODES.
+Add a list of any applications you want to run in the format "#app myapp=/path/to/app".
 
 Starting the Coaster Service Script
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Now that everything is configured, change to a temporary directory 
+Now that everything is configured, change to the location of the coaster-service.conf file
 and run this command to start the coaster service:
 
 -----

Modified: branches/release-0.93/docs/siteguide/intrepid
===================================================================
--- branches/release-0.93/docs/siteguide/intrepid	2011-12-19 17:26:40 UTC (rev 5445)
+++ branches/release-0.93/docs/siteguide/intrepid	2011-12-19 19:15:32 UTC (rev 5446)
@@ -125,7 +125,7 @@
 TODO: Update the rest below here
 
 -----
-include::../../tests/providers/local-cobalt/intrepid/sites.template.xml[]
+include::../../tests/providers/intrepid/sites.template.xml[]
 -----
 
 The values to note here are the ones that are listed between underscores. In the example above, they are \_QUEUE_, and \_WORK_. Queue is the PADS queue to use and WORK is the swift work directory. These are placeholder values you will need to modify to fit your needs. Copy and paste this template, replace the values, and call it sites.xml.
@@ -135,7 +135,7 @@
 Below is the tc.data file used by Swift's test suite for running on PADS.
 
 -----
-include::../../tests/providers/local-cobalt/intrepid/tc.template.data[]
+include::../../tests/providers/intrepid/tc.template.data[]
 ------
 
 Copy these commands and save it as tc.data.