[Swift-commit] r2480 - trunk/docs
noreply at svn.ci.uchicago.edu
noreply at svn.ci.uchicago.edu
Thu Jan 29 09:15:47 CST 2009
Author: benc
Date: 2009-01-29 09:15:46 -0600 (Thu, 29 Jan 2009)
New Revision: 2480
Modified:
trunk/docs/userguide.xml
Log:
formatting of site catalog doc
Modified: trunk/docs/userguide.xml
===================================================================
--- trunk/docs/userguide.xml 2009-01-29 14:53:28 UTC (rev 2479)
+++ trunk/docs/userguide.xml 2009-01-29 15:15:46 UTC (rev 2480)
@@ -2677,29 +2677,29 @@
<para>
By default, the site catalog is stored in <filename>etc/sites.xml</filename>.
-This path can be overridden with the sites.file configuration property,
+This path can be overridden with the <literal>sites.file</literal> configuration property,
either in the Swift configuration file or on the command line.
</para>
<para>
-The sites file is formatted as XML. It consists of <pool> elements,
+The sites file is formatted as XML. It consists of <literal><pool></literal> elements,
one for each site that Swift will use.
</para>
<section><title>Pool element</title>
<para>
-Each pool element must have a handle attribute, giving a symbolic name
+Each <literal>pool</literal> element must have a <literal>handle</literal> attribute, giving a symbolic name
for the site. This can be any name, but must correspond to entries for
that site in the transformation catalog.
</para>
<para>
-Optionally, the gridlaunch attribute can be used to specify the path to
+Optionally, the <literal>gridlaunch</literal> attribute can be used to specify the path to
<link linkend="kickstart">kickstart</link> on the site.
</para>
<para>
-Each pool must specify a file transfer method, an execution method
+Each <literal>pool</literal> must specify a file transfer method, an execution method
and a remote working directory. Optionally, <link linkend="profiles">profile settings</link> can be specified.
</para>
@@ -2707,23 +2707,24 @@
<section><title>File transfer method specification</title>
<para>
-Transfer methods are specified with the <gridftp> element or
-with the <filesystem> element.
+Transfer methods are specified with either
+the <literal><gridftp></literal> element or the
+<literal><filesystem></literal> element.
</para>
<para>
-To use gridftp or local filesystem copy, use the <gridftp>
+To use gridftp or local filesystem copy, use the <literal><gridftp></literal>
element:
<screen>
<gridftp url="gsiftp://evitable.ci.uchicago.edu" />
</screen>
-The URL attribute may specify a GridFTP server, using the gsiftp URI scheme;
+The <literal>url</literal> attribute may specify a GridFTP server, using the gsiftp URI scheme;
or it may specify that filesystem copying will be used (which assumes that
the site has access to the same filesystem as the submitting machine) using
-the URI local://localhost.
+the URI <literal>local://localhost</literal>.
</para>
<para>
Filesystem access using scp (the SSH copy protocol) can be specified using the
-<filesystem> element:
+<literal><filesystem></literal> element:
<screen>
<filesystem url="www11.i2u2.org" provider="ssh"/>
</screen>
@@ -2732,7 +2733,7 @@
</para>
<para>
Filesystem access using <link linkend="coasters">CoG coasters</link> can be
-also be specified using the <filesystem> element. More detail about
+also be specified using the <literal><filesystem></literal> element. More detail about
configuring that can be found in the <link linkend="coasters">CoG
coasters</link> section.
</para>
@@ -2741,52 +2742,55 @@
<section><title>Execution method specification</title>
<para>
-Execution methods may be specified either with a <jobmanager> or
-<execution> element.
+Execution methods may be specified either with the <literal><jobmanager></literal>
+or <literal><execution></literal> element.
</para>
<para>
-The <jobmanager> element can be used to specify execution through
-GRAM2. For example,
+The <literal><jobmanager></literal> element can be used to specify
+execution through GRAM2. For example,
<screen>
<jobmanager universe="vanilla" url="evitable.ci.uchicago.edu/jobmanager-fork" major="2" />
</screen>
-The universe attribute should always be set to vanilla. The url attribute
+The <literal>universe</literal> attribute should always be set to vanilla. The
+<literal>url</literal> attribute
should specify the name of the GRAM2 gatekeeper host, and the name of the
jobmanager to use. The major attribute should always be set to 2.
</para>
<para>
-The <execution> element can be used to specify execution through
-other execution providers:
+The <literal><execution></literal> element can be used to specify
+execution through other execution providers:
</para>
<para>
-To use GRAM4, specify the gt4 provider. For example:
+To use GRAM4, specify the <literal>gt4</literal> provider. For example:
<screen>
<execution provider="gt4" jobmanager="PBS" url="tg-grid.uc.teragrid.org" />
</screen>
-The url attribute should specify the GRAM4 submission site. The jobmanager
+The <literal>url</literal> attribute should specify the GRAM4 submission site.
+The <literal>jobmanager</literal>
attribute should specify which GRAM4 jobmanager will be used.
</para>
<para>
-For local execution, the local provider should be used, like this:
+For local execution, the <literal>local</literal> provider should be used,
+like this:
<screen>
<execution provider="local" url="none" />
</screen>
</para>
<para>
-For PBS execution, the pbs provider should be used:
+For PBS execution, the <literal>pbs</literal> provider should be used:
<screen>
<execution provider="pbs" url="none" />
</screen>
-The <link linkend="profile.globus.queue">GLOBUS::queue</link> profile key
+The <literal><link linkend="profile.globus.queue">GLOBUS::queue</link></literal> profile key
can be used to specify which PBS queue jobs will be submitted to.
</para>
<para>
-For execution through SSH, the ssh provider should be used:
+For execution through SSH, the <literal>ssh</literal> provider should be used:
<screen>
<execution url="www11.i2u2.org" provider="ssh"/>
</screen>
@@ -2801,7 +2805,7 @@
</para>
<para>
For execution using the
-<link linkend="coasters">CoG Coaster mechanism</link>, the coaster provider
+<link linkend="coasters">CoG Coaster mechanism</link>, the <literal>coaster</literal> provider
should be used:
<screen>
<execution provider="coaster" url="tg-grid.uc.teragrid.org"
@@ -2814,13 +2818,13 @@
<section><title>Other site catalog parameters</title>
<para>
-The workdirectory element specifies where on the site files can be
+The <literal>workdirectory</literal> element specifies where on the site files can be
stored.
<screen>
<workdirectory>/home/benc</workdirectory>
</screen>
This file must be accessible through the transfer mechanism specified
-in the <gridftp> element and also mounted on all worker nodes that
+in the <literal><gridftp></literal> element and also mounted on all worker nodes that
will be used for execution. A shared cluster scratch filesystem is
appropriate for this.
</para>
More information about the Swift-commit
mailing list