[Swift-commit] r7418 - trunk/docs/designs

[davidk at ci.uchicago.edu]

Author: davidk
Date: 2013-12-13 09:58:47 -0600 (Fri, 13 Dec 2013)
New Revision: 7418

Modified:
   trunk/docs/designs/swiftrun.txt
Log:
Update doc to use new property names


Modified: trunk/docs/designs/swiftrun.txt
===================================================================
--- trunk/docs/designs/swiftrun.txt	2013-12-13 15:21:34 UTC (rev 7417)
+++ trunk/docs/designs/swiftrun.txt	2013-12-13 15:58:47 UTC (rev 7418)
@@ -223,6 +223,17 @@
 site.westmere.queue=fast
 -----
 
+Before the site properties are listed, it's important to understand the
+terminology used.
+
+A *task*, or *app task* is an instance of a program as defined in
+a Swift app() function.
+
+A *worker* is the program that launches app tasks. 
+
+A *job* is related to schedulers. It is the mechanism by which workers
+are launched.
+
 Below is the list of valid site properties, with links to the Swift User Guide
 which explanations of what they do, and an example swift.properties entry.
 
@@ -231,89 +242,49 @@
 |================================
 |Property|Description|Example
 
-|allocationstepsize|
-link:../userguide/userguide.html#_globus_namespace[Swift User Guide entry]
-|site.westmere.allocationstepsize=0.1
+|jobGranularity|
+Specifies the granularity of a job, in nodes
+|site.westmere.jobGranularity=2
 
-|delaybase|
-link:../userguide/userguide.html#_karajan_namespace[Swift User Guide entry]
-|site.westmere.delaybase=1
+|jobManager|
+Specifies how jobs will be launched. The supported job managers are 
+"cobalt", "slurm", "condor", "pbs", "lsf", "local", and "sge". 
+|site.westmere.jobManager=slurm
 
-|highoverallocation|
-link:../userguide/userguide.html#_globus_namespace[Swift User Guide entry]
-|site.westmere.highoverallocation=100
+|jobQueue|
+Set the name of the scheduler queue to use.
+|site.westmere.jobQueue=westmere
 
-|initialscore|
-link:../userguide/userguide.html#_karajan_namespace[Swift User Guide entry]
-|site.westmere.initialscore=10000
+|jobWalltime|
+The maximum number amount of time allocated in a scheduler job, in hh:mm:ss
+format.
+|site.westmere.jobWalltime=01:00:00
 
-|internalhostname|
-link:../userguide/userguide.html#_globus_namespace[Swift User Guide entry]
-|site.westmere.internalhostname=10.x.x.x
+|maxJobs|
+Maximum number of scheduler jobs to submit
+|site.westmere.maxJobs=20
 
-|jobspernode|
-link:../userguide/userguide.html#_globus_namespace[Swift User Guide entry]
-|site.westmere.jobspernode=12
+|maxNodesPerJob|
+The maximum number of nodes to request per scheduler job.
+|site.westmere.maxNodesPerJob=2
 
-|jobthrottle|
-Set the job throttle factor. The value should be (N-1)/100 to run N jobs at a
-time. To run 16 jobs at a time, set jobthrottle to .15.
-|site.westmere.jobthrottle=0.15
+|tasksPerWorker|
+The number of tasks that each worker can run simultaneously.
+|site.westmere.tasksPernode=12
 
-|lowoverallocation|
-link:../userguide/userguide.html#_globus_namespace[Swift User Guide entry]
-|site.westmere.lowoverallocation=100
+|taskThrottle|
+The maximum number of active tasks across all workers.
+|site.westmere.taskThrottle=100
 
-|maxnodes|
-link:../userguide/userguide.html#_globus_namespace[Swift User Guide entry]
-|site.westmere.maxnodes=2
+|taskWalltime|
+The maximum amount of time a task may run, in hh:mm:ss.
+|site.westmere.taskWalltime=01:00:00
 
-|maxsubmitrate|
-link:../userguide/userguide.html#_karajan_namespace[Swift User Guide entry]
-|site.westmere.maxsubmitrate=5
+|site    |
+Name of site or sites to run on. This is the same as running with
+swift -site <sitename>
+|site=westmere
 
-|maxtime|
-link:../userguide/userguide.html#_globus_namespace[Swift User Guide entry]
-|site.westmere.maxtime=3600
-
-|maxwalltime|
-link:../userguide/userguide.html#_globus_namespace[Swift User Guide entry]
-|site.westmere.maxwalltime=00:05:00
-
-|nodegranularity|
-link:../userguide/userguide.html#_globus_namespace[Swift User Guide entry]
-|site.westmere.nodegranularity=2
-
-|overallocationdecayfactor|
-link:../userguide/userguide.html#_globus_namespace[Swift User Guide entry]
-|site.westmere.overallocationdecayfactor=0.001
-
-|provider|
-Set which CoG provider to use. This will assume that you want to use coasters.
-|site.westmere.provider=local:slurm
-
-|queue|
-Set the name of the scheduler queue to use.
-|site.westmere.queue=westmere
-
-|remotemonitorenabled|
-link:../userguide/userguide.html#_globus_namespace[Swift User Guide entry]
-|site.westmere.remotemonitorenabled=true
-
-|reserve|
-link:../userguide/userguide.html#_globus_namespace[Swift User Guide entry]
-|site.westmere.reserve=10
-
-|site    |Name of site or sites to run on. This is the same as running with
-swift -site <sitename>|site=westmere
-
-|slots|
-link:../userguide/userguide.html#_globus_namespace[Swift User Guide entry]
-|site.westmere.slots=20
-
-|spread|
-link:../userguide/userguide.html#_globus_namespace[Swift User Guide entry]
-|site.westmere.spread=0.9
 |================================
 
 Grouping site properties