[Swift-commit] r2841 - trunk/docs
noreply at svn.ci.uchicago.edu
noreply at svn.ci.uchicago.edu
Wed Apr 8 07:26:22 CDT 2009
Author: benc
Date: 2009-04-08 07:26:19 -0500 (Wed, 08 Apr 2009)
New Revision: 2841
Modified:
trunk/docs/userguide.xml
Log:
sort swift.properties documentation by property name
Modified: trunk/docs/userguide.xml
===================================================================
--- trunk/docs/userguide.xml 2009-04-08 12:24:13 UTC (rev 2840)
+++ trunk/docs/userguide.xml 2009-04-08 12:26:19 UTC (rev 2841)
@@ -2189,58 +2189,144 @@
<variablelist>
<title>Swift Properties</title>
-
- <varlistentry>
+
+ <varlistentry id="property.caching.algorithm">
<term>
- <property>sites.file</property>
+ <property>caching.algorithm</property>
</term>
<listitem>
-
+
<para>
- Valid values: <parameter><file></parameter>
+ Valid values: <literal>LRU</literal>
</para>
<para>
- Default value: ${<varname>swift.home</varname>}<literal>/etc/sites.xml</literal>
+ Default value: <literal>LRU</literal>
</para>
<para>
- Points to the location of the site
- catalog, which contains a list of all sites that
- Swift should use.
+ Swift caches files that are staged in on remote
+ resources, and files that are produced remotely
+ by applications, such that they can be re-used
+ if needed without being transfered again.
+ However, the amount of remote file system space
+ to be used for caching can be limited using the
+ <link linkend="profile.swift.storagesize"><property>swift:storagesize</property></link> profile
+ entry in the sites.xml file. Example:
+
+<screen>
+<pool handle="example" sysinfo="INTEL32::LINUX">
+ <gridftp url="gsiftp://example.org" storage="/scratch/swift" major="2" minor="4" patch="3"/>
+ <jobmanager universe="vanilla" url="example.org/jobmanager-pbs" major="2" minor="4" patch="3"/>
+ <workdirectory>/scratch/swift</workdirectory>
+ <profile namespace="SWIFT" key="storagesize">20000000</profile>
+</pool>
+
+</screen>
+
+ The decision of which files to keep in the cache
+ and which files to remove is made considering
+ the value of the
+ <property>caching.algorithm</property> property.
+ Currently, the only available value for this
+ property is <literal>LRU</literal>, which would
+ cause the least recently used files to be
+ deleted first.
+
</para>
</listitem>
</varlistentry>
-
- <varlistentry>
+
+ <varlistentry id="property.clustering.enabled">
<term>
- <property>tc.file</property>
+ <property>clustering.enabled</property>
</term>
<listitem>
+
<para>
- Valid values: <parameter><file></parameter>
+ Valid values: <literal>true</literal>, <literal>false</literal>
</para>
<para>
- Default value: ${<varname>swift.home</varname>}<literal>/etc/tc.data</literal>
+ Default value: <literal>false</literal>
</para>
+
+ <para>
+ Enables <link linkend="clustering">clustering</link>.
+ </para>
+
+ </listitem>
+ </varlistentry>
+ <varlistentry id="property.clustering.min.time">
+ <term>
+ <property>clustering.min.time</property>
+ </term>
+ <listitem>
+
<para>
+ Valid values: <parameter><int></parameter>
+ </para>
- Points to the location of the transformation
- catalog file which contains information about
- installed applications. Details about the format
- of the transformation catalog can be found
- <ulink
- url="http://vds.uchicago.edu/vds/doc/userguide/html/H_TransformationCatalog.html">here</ulink>.
+ <para>
+ Default value: <literal>60</literal>
+ </para>
+
+ <para>
+
+ Indicates the threshold wall time for
+ clustering, in seconds. Jobs that have a
+ wall time smaller than the value of this
+ property will be considered for clustering.
</para>
</listitem>
</varlistentry>
+
+ <varlistentry id="property.clustering.queue.delay">
+ <term>
+ <property>clustering.queue.delay</property>
+ </term>
+ <listitem>
+
+ <para>
+ Valid values: <parameter><int></parameter>
+ </para>
+
+ <para>
+ Default value: <literal>4</literal>
+ </para>
+
+ <para>
+
+ This property indicates the interval, in
+ seconds, at which the clustering queue is
+ processed.
+
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry id="property.execution.retries">
+ <term>execution.retries</term>
+ <listitem>
+ <para>
+ Valid values: positive integers
+ </para>
+ <para>
+ Default value: 2
+ </para>
+ <para>
+ The number of time a job will be retried if it
+ fails (giving a maximum of 1 +
+ execution.retries attempts at execution)
+ </para>
+ </listitem>
+ </varlistentry>
+
<varlistentry>
<term>
<property>ip.address</property>
@@ -2274,11 +2360,10 @@
</para>
</listitem>
</varlistentry>
-
-
+
<varlistentry>
<term>
- <property>lazy.errors</property>
+ <property>kickstart.always.transfer</property>
</term>
<listitem>
@@ -2289,97 +2374,93 @@
<para>
Default value: <literal>false</literal>
</para>
-
+
<para>
- Swift can report application errors in two
- modes, depending on the value of this property.
- If set to <constant>false</constant>, Swift will
- report the first error encountered and
- immediately stop execution. If set to
- <constant>true</constant>, Swift will attempt to
- run as much as possible from a SwiftScript program before
- stopping execution and reporting all errors
- encountered.
+ This property controls when output from
+ Kickstart is transfered back to the submit site,
+ if Kickstart is enabled. When set to
+ <literal>false</literal>, Kickstart output is
+ only transfered for jobs that fail. If set to
+ <literal>true</literal>, Kickstart output is
+ transfered after every job is completed or
+ failed.
+
</para>
- <para>When developing SwiftScript programs, using the
- default value of <constant>false</constant> can
- make the program easier to debug. However
- in production runs, using <constant>true</constant>
- will allow more of a SwiftScript program to be run before
- Swift aborts execution.
- </para>
</listitem>
</varlistentry>
-
- <varlistentry id="property.caching.algorithm">
+
+ <varlistentry>
<term>
- <property>caching.algorithm</property>
+ <property>kickstart.enabled</property>
</term>
<listitem>
-
+
<para>
- Valid values: <literal>LRU</literal>
+ Valid values: <literal>true</literal>, <literal>false</literal>, <literal>maybe</literal>
</para>
<para>
- Default value: <literal>LRU</literal>
+ Default value: <literal>maybe</literal>
</para>
-
+
<para>
-
- Swift caches files that are staged in on remote
- resources, and files that are produced remotely
- by applications, such that they can be re-used
- if needed without being transfered again.
- However, the amount of remote file system space
- to be used for caching can be limited using the
- <link linkend="profile.swift.storagesize"><property>swift:storagesize</property></link> profile
- entry in the sites.xml file. Example:
-<screen>
+ This option allows controlling of
+ when Swift uses <link linkend="kickstart">Kickstart</link>. A value of
+ <literal>false</literal> disables the use of
+ Kickstart, while a value of
+ <literal>true</literal> enables the use of
+ Kickstart, in which case sites specified in the
+ <filename type="file">sites.xml</filename> file
+ must have valid
+ <parameter>gridlaunch</parameter> attributes.
+ The <literal>maybe</literal> value will
+ enable the use of Kickstart only
+ on sites that have the
+ <parameter>gridlaunch</parameter> attribute
+ specified.
-<pool handle="example" sysinfo="INTEL32::LINUX">
- <gridftp url="gsiftp://example.org" storage="/scratch/swift" major="2" minor="4" patch="3"/>
- <jobmanager universe="vanilla" url="example.org/jobmanager-pbs" major="2" minor="4" patch="3"/>
- <workdirectory>/scratch/swift</workdirectory>
- <profile namespace="SWIFT" key="storagesize">20000000</profile>
-</pool>
-
-</screen>
-
-
- The decision of which files to keep in the cache
- and which files to remove is made considering
- the value of the
- <property>caching.algorithm</property> property.
- Currently, the only available value for this
- property is <literal>LRU</literal>, which would
- cause the least recently used files to be
- deleted first.
-
</para>
</listitem>
</varlistentry>
-
- <varlistentry id="property.execution.retries">
- <term>execution.retries</term>
+
+ <varlistentry>
+ <term>
+ <property>lazy.errors</property>
+ </term>
<listitem>
+
<para>
- Valid values: positive integers
+ Valid values: <literal>true</literal>, <literal>false</literal>
</para>
+
<para>
- Default value: 2
+ Default value: <literal>false</literal>
</para>
+
<para>
- The number of time a job will be retried if it
- fails (giving a maximum of 1 +
- execution.retries attempts at execution)
+
+ Swift can report application errors in two
+ modes, depending on the value of this property.
+ If set to <constant>false</constant>, Swift will
+ report the first error encountered and
+ immediately stop execution. If set to
+ <constant>true</constant>, Swift will attempt to
+ run as much as possible from a SwiftScript program before
+ stopping execution and reporting all errors
+ encountered.
</para>
+ <para>When developing SwiftScript programs, using the
+ default value of <constant>false</constant> can
+ make the program easier to debug. However
+ in production runs, using <constant>true</constant>
+ will allow more of a SwiftScript program to be run before
+ Swift aborts execution.
+ </para>
</listitem>
</varlistentry>
-
-
+
<varlistentry>
<term>
<property>pgraph</property>
@@ -2472,173 +2553,113 @@
</para>
</listitem>
</varlistentry>
-
- <varlistentry id="property.clustering.enabled">
+
+ <varlistentry>
<term>
- <property>clustering.enabled</property>
+ <property>sitedir.keep</property>
</term>
<listitem>
-
<para>
- Valid values: <literal>true</literal>, <literal>false</literal>
+ Valid values: <parameter>true</parameter>, <parameter>false</parameter>
</para>
-
+
<para>
Default value: <literal>false</literal>
</para>
-
+
<para>
- Enables <link linkend="clustering">clustering</link>.
+Indicates whether the working directory on the remote site should be
+left intact even when a run completes successfully. This can be
+used to inspect the site working directory for debugging purposes.
</para>
-
</listitem>
</varlistentry>
- <varlistentry id="property.clustering.queue.delay">
+ <varlistentry>
<term>
- <property>clustering.queue.delay</property>
+ <property>sites.file</property>
</term>
<listitem>
-
- <para>
- Valid values: <parameter><int></parameter>
- </para>
<para>
- Default value: <literal>4</literal>
+ Valid values: <parameter><file></parameter>
</para>
<para>
-
- This property indicates the interval, in
- seconds, at which the clustering queue is
- processed.
-
+ Default value: ${<varname>swift.home</varname>}<literal>/etc/sites.xml</literal>
</para>
- </listitem>
- </varlistentry>
-
- <varlistentry id="property.clustering.min.time">
- <term>
- <property>clustering.min.time</property>
- </term>
- <listitem>
<para>
- Valid values: <parameter><int></parameter>
- </para>
- <para>
- Default value: <literal>60</literal>
- </para>
-
- <para>
-
- Indicates the threshold wall time for
- clustering, in seconds. Jobs that have a
- wall time smaller than the value of this
- property will be considered for clustering.
+ Points to the location of the site
+ catalog, which contains a list of all sites that
+ Swift should use.
+
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>
- <property>kickstart.enabled</property>
+ <property>status.mode</property>
</term>
<listitem>
-
<para>
- Valid values: <literal>true</literal>, <literal>false</literal>, <literal>maybe</literal>
+ Valid values: <parameter>files</parameter>, <parameter>provider</parameter>
</para>
-
+
<para>
- Default value: <literal>maybe</literal>
+ Default value: <literal>files</literal>
</para>
-
- <para>
-
- This option allows controlling of
- when Swift uses <link linkend="kickstart">Kickstart</link>. A value of
- <literal>false</literal> disables the use of
- Kickstart, while a value of
- <literal>true</literal> enables the use of
- Kickstart, in which case sites specified in the
- <filename type="file">sites.xml</filename> file
- must have valid
- <parameter>gridlaunch</parameter> attributes.
- The <literal>maybe</literal> value will
- enable the use of Kickstart only
- on sites that have the
- <parameter>gridlaunch</parameter> attribute
- specified.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>
- <property>kickstart.always.transfer</property>
- </term>
- <listitem>
-
<para>
- Valid values: <literal>true</literal>, <literal>false</literal>
+Controls how Swift will communicate the result code of running user programs
+from workers to the submit side. In <literal>files</literal> mode, a file
+indicating success or failure will be created on the site shared filesystem.
+In <literal>provider</literal> mode, the execution provider job status will
+be used.
</para>
-
<para>
- Default value: <literal>false</literal>
+<literal>provider</literal> mode requires the underlying job execution system
+to correctly return exit codes. In at least the cases of GRAM2, and clusters
+used with any provider, exit codes are not returned, and so
+<literal>files</literal> mode must be used in those cases. Otherwise,
+<literal>provider</literal> mode can be used to reduce the amount of
+filesystem access. (since Swift 0.8)
</para>
-
- <para>
-
- This property controls when output from
- Kickstart is transfered back to the submit site,
- if Kickstart is enabled. When set to
- <literal>false</literal>, Kickstart output is
- only transfered for jobs that fail. If set to
- <literal>true</literal>, Kickstart output is
- transfered after every job is completed or
- failed.
-
- </para>
</listitem>
</varlistentry>
<varlistentry>
<term>
- <property>wrapperlog.always.transfer</property>
+ <property>tc.file</property>
</term>
<listitem>
-
<para>
- Valid values: <literal>true</literal>, <literal>false</literal>
+ Valid values: <parameter><file></parameter>
</para>
<para>
- Default value: <literal>false</literal>
+ Default value: ${<varname>swift.home</varname>}<literal>/etc/tc.data</literal>
</para>
-
+
<para>
- This property controls when output from
- the Swift remote wrapper is transfered
- back to the submit site. When set to
- <literal>false</literal>, wrapper logs are
- only transfered for jobs that fail. If set to
- <literal>true</literal>, wrapper logs are
- transfered after every job is completed or
- failed.
+ Points to the location of the transformation
+ catalog file which contains information about
+ installed applications. Details about the format
+ of the transformation catalog can be found
+ <ulink
+ url="http://vds.uchicago.edu/vds/doc/userguide/html/H_TransformationCatalog.html">here</ulink>.
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>
- <property>throttle.submit</property>
+ <property>throttle.file.operations</property>
</term>
<listitem>
@@ -2647,28 +2668,28 @@
</para>
<para>
- Default value: <literal>4</literal>
+ Default value: <literal>8</literal>
</para>
-
+
<para>
- Limits the number of concurrent submissions for
- a run. This throttle only limits
- the number of concurrent tasks (jobs) that are
- being sent to sites, not the total number of
- concurrent jobs that can be run. The submission
- stage in GRAM is one of the most CPU expensive
- stages (due mostly to the mutual authentication
- and delegation). Having too many concurrent
- submissions can overload either or both the
- submit host CPU and the remote host/head node
- causing degraded performance.
+ Limits the total number of concurrent file
+ operations that can happen at any given time.
+ File operations (like transfers) require an
+ exclusive connection to a site. These
+ connections can be expensive to establish. A
+ large number of concurrent file operations may
+ cause Swift to attempt to establish many such
+ expensive connections to various sites. Limiting
+ the number of concurrent file operations causes
+ Swift to use a small number of cached
+ connections and achieve better overall
+ performance.
</para>
-
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>
<property>throttle.host.submit</property>
@@ -2695,68 +2716,7 @@
</para>
</listitem>
</varlistentry>
-
- <varlistentry>
- <term>
- <property>throttle.transfers</property>
- </term>
- <listitem>
-
- <para>
- Valid values: <parameter><int></parameter>, <parameter>off</parameter>
- </para>
-
- <para>
- Default value: <literal>4</literal>
- </para>
-
- <para>
-
- Limits the total number of concurrent file
- transfers that can happen at any given time.
- File transfers consume bandwidth. Too many
- concurrent transfers can cause the network to be
- overloaded preventing various other signaling
- traffic from flowing properly.
-
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <property>throttle.file.operations</property>
- </term>
- <listitem>
-
- <para>
- Valid values: <parameter><int></parameter>, <parameter>off</parameter>
- </para>
-
- <para>
- Default value: <literal>8</literal>
- </para>
-
- <para>
-
- Limits the total number of concurrent file
- operations that can happen at any given time.
- File operations (like transfers) require an
- exclusive connection to a site. These
- connections can be expensive to establish. A
- large number of concurrent file operations may
- cause Swift to attempt to establish many such
- expensive connections to various sites. Limiting
- the number of concurrent file operations causes
- Swift to use a small number of cached
- connections and achieve better overall
- performance.
-
- </para>
- </listitem>
- </varlistentry>
-
-
<varlistentry id="property.throttle.score.job.factor">
<term>
<property>throttle.score.job.factor</property>
@@ -2803,54 +2763,64 @@
<varlistentry>
<term>
- <property>sitedir.keep</property>
+ <property>throttle.submit</property>
</term>
<listitem>
+
<para>
- Valid values: <parameter>true</parameter>, <parameter>false</parameter>
+ Valid values: <parameter><int></parameter>, <parameter>off</parameter>
</para>
-
+
<para>
- Default value: <literal>false</literal>
+ Default value: <literal>4</literal>
</para>
-
+
<para>
-Indicates whether the working directory on the remote site should be
-left intact even when a run completes successfully. This can be
-used to inspect the site working directory for debugging purposes.
+
+ Limits the number of concurrent submissions for
+ a run. This throttle only limits
+ the number of concurrent tasks (jobs) that are
+ being sent to sites, not the total number of
+ concurrent jobs that can be run. The submission
+ stage in GRAM is one of the most CPU expensive
+ stages (due mostly to the mutual authentication
+ and delegation). Having too many concurrent
+ submissions can overload either or both the
+ submit host CPU and the remote host/head node
+ causing degraded performance.
+
</para>
+
</listitem>
</varlistentry>
+
<varlistentry>
<term>
- <property>status.mode</property>
+ <property>throttle.transfers</property>
</term>
<listitem>
+
<para>
- Valid values: <parameter>files</parameter>, <parameter>provider</parameter>
+ Valid values: <parameter><int></parameter>, <parameter>off</parameter>
</para>
-
+
<para>
- Default value: <literal>files</literal>
+ Default value: <literal>4</literal>
</para>
-
+
<para>
-Controls how Swift will communicate the result code of running user programs
-from workers to the submit side. In <literal>files</literal> mode, a file
-indicating success or failure will be created on the site shared filesystem.
-In <literal>provider</literal> mode, the execution provider job status will
-be used.
+
+ Limits the total number of concurrent file
+ transfers that can happen at any given time.
+ File transfers consume bandwidth. Too many
+ concurrent transfers can cause the network to be
+ overloaded preventing various other signaling
+ traffic from flowing properly.
+
</para>
- <para>
-<literal>provider</literal> mode requires the underlying job execution system
-to correctly return exit codes. In at least the cases of GRAM2, and clusters
-used with any provider, exit codes are not returned, and so
-<literal>files</literal> mode must be used in those cases. Otherwise,
-<literal>provider</literal> mode can be used to reduce the amount of
-filesystem access. (since Swift 0.8)
- </para>
</listitem>
</varlistentry>
+
<varlistentry>
<term>
<property>ticker.disable</property>
@@ -2897,7 +2867,34 @@
</listitem>
</varlistentry>
-
+ <varlistentry>
+ <term>
+ <property>wrapperlog.always.transfer</property>
+ </term>
+ <listitem>
+
+ <para>
+ Valid values: <literal>true</literal>, <literal>false</literal>
+ </para>
+
+ <para>
+ Default value: <literal>false</literal>
+ </para>
+
+ <para>
+
+ This property controls when output from
+ the Swift remote wrapper is transfered
+ back to the submit site. When set to
+ <literal>false</literal>, wrapper logs are
+ only transfered for jobs that fail. If set to
+ <literal>true</literal>, wrapper logs are
+ transfered after every job is completed or
+ failed.
+
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
More information about the Swift-commit
mailing list