Author: buildbot
Date: Thu Oct 9 22:56:21 2014
New Revision: 925207
Log:
Staging update by buildbot for slider
Modified:
websites/staging/slider/trunk/content/ (props changed)
websites/staging/slider/trunk/content/docs/manpage.html
Propchange: websites/staging/slider/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Thu Oct 9 22:56:21 2014
@@ -1 +1 @@
-1630266
+1630615
Modified: websites/staging/slider/trunk/content/docs/manpage.html
==============================================================================
--- websites/staging/slider/trunk/content/docs/manpage.html (original)
+++ websites/staging/slider/trunk/content/docs/manpage.html Thu Oct 9 22:56:21
2014
@@ -482,7 +482,7 @@ policy.</li>
</pre></div>
-<h3
id="registry-list-listconf-getconf-conf-name-name-servicetype-servicetype-verbose"><code>registry
(--list | --listconf | --getconf <conf>) [--name <name>]
[--servicetype <servicetype>] [--verbose]</code></h3>
+<h3
id="registry-list-listconf-getconf-conf-resolve-path-name-name-servicetype-servicetype-out-filename-verbose"><code>registry
(--list | --listconf | --getconf <conf> | --resolve <path>)
[--name <name>] [--servicetype <servicetype>] [--out
<filename>] [--verbose]</code></h3>
<p>List registered application instances visible to the user. This is slightly
different from the <code>slider list</code> command in that it does not make
use of the
YARN application list. Instead it communicates with Zookeeper -and works
@@ -490,7 +490,7 @@ with any applications which has register
<p>The <code>--name <name></code> option names the registry entry to
work with. For slider applications,
this is the application instance</p>
<p>The <code>--servicetype <servicetype></code> option allows a
different service type to be chosen.
-The default is <code>"org.apache.slider</code></p>
+The default is <code>org-apache-slider</code></p>
<p>The <code>--verbose</code> flag triggers more verbose output on the
operations</p>
<p>The <code>--internal</code> flag indicates the configurations to be listed
and retrieved
are from the "internal" list of configuration data provided for use within a
@@ -508,10 +508,73 @@ is not found, the command returns the ex
<p>List all services of the service type and optionally the name. </p>
<h4
id="slider-registry-listconf-name-name-internal-servicetype-servicetype"><code>slider
registry --listconf [--name <name>] [--internal] [--servicetype
<servicetype>]</code></h4>
<p>List the configurations exported by of a named application</p>
-<h4
id="slider-registry-getconf-configuration-format-xmljsonproperties-dest-path-internal"><code>slider
registry --getconf <configuration> [--format (xml|json|properties)]
[--dest <path>] [--internal]</code></h4>
+<h4
id="slider-registry-getconf-configuration-format-xmljsonproperties-servicetype-servicetype-name-name-dest-path-internal-get-the-configuration"><code>slider
registry --getconf <configuration> [--format (xml|json|properties)]
[--servicetype <servicetype>] [--name <name>] [--dest <path>]
[--internal]</code> get the configuration</h4>
<p>Get a named configuration in a chosen format. Default: XML</p>
<p><code>--dest <path></code> : the filename or directory to save a
configuration to.
<code>--format (xml|json|properties)</code> defines the output format</p>
+<p>If the <code>--dest</code> argument is set and refers to a directory, the
file is saved
+under that file, with the filename derived from the configuration name
requested:</p>
+<p>Example:</p>
+<div class="codehilite"><pre><span class="n">slider</span> <span
class="n">registry</span> <span class="o">--</span><span
class="n">getconf</span> <span class="n">hbase</span><span
class="o">-</span><span class="n">site</span><span class="p">.</span><span
class="n">xml</span> <span class="o">--</span><span class="n">name</span> <span
class="n">hbase1</span> <span class="o">--</span><span class="n">dest</span>
<span class="n">confdir</span>
+</pre></div>
+
+
+<p>If <code>confdir</code> exists, this downloads the hbase site configuration
to <code>confdir/hbase-site.xml</code>.</p>
+<p>If the destination path refers to a file (or does not exist), the specified
+path is used for the file:</p>
+<div class="codehilite"><pre><span class="n">slider</span> <span
class="n">registry</span> <span class="o">--</span><span
class="n">getconf</span> <span class="n">hbase</span><span
class="o">-</span><span class="n">site</span><span class="p">.</span><span
class="n">xml</span> <span class="o">--</span><span class="n">name</span> <span
class="n">hbase1</span> <span class="o">--</span><span class="n">dest</span>
<span class="n">configfile</span><span class="p">.</span><span
class="n">xml</span>
+</pre></div>
+
+
+<p>This will download the configuration to the file
<code>configfile.xml</code>.</p>
+<h3 id="slider-resolve-path-path-out-filename-list-destdir-dir"><code>slider
resolve --path <path> [--out <filename>] [--list] [--destdir
<dir]</code></h3>
+<p>This command resolves the service record under a path in the registry,
+or lists all service records directly under a path.</p>
+<p>The result can be printed to the console (default) or saved to the
filesystem;
+the means of specifiying the destination varies depending on whether a single
+record or a listing is requested.</p>
+<h3 id="resolve-a-single-entry-slider-resolve-path-path">Resolve a single
entry: <code>slider resolve --path <path></code></h3>
+<p>The basic <code>slider resolve --path <path></code> command, without
the <code>--list</code> option
+will attempt to resolve the service record at the destination. The record
+may be saved to the file specified with the <code>--out</code></p>
+<p><em>Example</em>: resolve and print the record at
<code>/users/hbase/services/org-apache-hbase/instance1</code></p>
+<div class="codehilite"><pre><span class="n">slider</span> <span
class="n">resolve</span> <span class="o">--</span><span class="n">path</span>
<span class="o">/</span><span class="n">users</span><span
class="o">/</span><span class="n">hbase</span><span class="o">/</span><span
class="n">services</span><span class="o">/</span><span
class="n">org</span><span class="o">-</span><span class="n">apache</span><span
class="o">-</span><span class="n">hbase</span><span class="o">/</span><span
class="n">instance1</span>
+</pre></div>
+
+
+<p><em>Example</em>: resolve the record at
<code>/users/hbase/services/org-apache-hbase/instance1</code>
+and save it to a file</p>
+<div class="codehilite"><pre><span class="n">slider</span> <span
class="n">resolve</span> <span class="o">--</span><span class="n">path</span>
<span class="o">/</span><span class="n">users</span><span
class="o">/</span><span class="n">hbase</span><span class="o">/</span><span
class="n">services</span><span class="o">/</span><span
class="n">org</span><span class="o">-</span><span class="n">apache</span><span
class="o">-</span><span class="n">hbase</span><span class="o">/</span><span
class="n">instance1</span> <span class="o">--</span><span class="n">out</span>
<span class="n">hbase</span><span class="p">.</span><span class="n">json</span>
+</pre></div>
+
+
+<p>If the specified path is not in the registry, or the path exists but there
+is no service record there, the return code is <code>EXIT_NOT_FOUND</code>,
77.</p>
+<h3 id="list-all-services-under-a-path-slider-resolve-path-path-list">List all
services under a path: <code>slider resolve --path <path>
--list</code></h3>
+<p><code>slider resolve --path <path> --list</code> command will list
all service records
+directly under a path. The listing can be displayed in the console, or saved
+to a directory, one JSON file per entry. The <code>--destdir</code> option
enables
+this saving of the entries âand identifies the destination directory for
them.
+Each entry will be saved with the entry name suffixed by
<code>.json</code>.</p>
+<p>It is an error if the path does not exist; the exit code will be
<code>EXIT_NOT_FOUND</code>, 77.</p>
+<p>It is <em>not</em> an error if the path does exist but there are no records
underneath
+it.</p>
+<p><em>Example</em>: list services under
<code>/users/hbase/services/org-apache-hbase/</code></p>
+<div class="codehilite"><pre><span class="n">slider</span> <span
class="n">resolve</span> <span class="o">--</span><span class="n">path</span>
<span class="o">/</span><span class="n">users</span><span
class="o">/</span><span class="n">hbase</span><span class="o">/</span><span
class="n">services</span><span class="o">/</span><span
class="n">org</span><span class="o">-</span><span class="n">apache</span><span
class="o">-</span><span class="n">hbase</span><span class="o">/</span> <span
class="o">--</span><span class="n">list</span>
+</pre></div>
+
+
+<p>This will list all services deployed under this path. If a service
<code>"hbase-1"</code>
+had been deployed, it would be printed.</p>
+<p><em>Example</em>: list services under
<code>/users/hbase/services/org-apache-hbase/</code> and
+save the results</p>
+<div class="codehilite"><pre><span class="n">slider</span> <span
class="n">resolve</span> <span class="o">--</span><span class="n">path</span>
<span class="o">/</span><span class="n">users</span><span
class="o">/</span><span class="n">hbase</span><span class="o">/</span><span
class="n">services</span><span class="o">/</span><span
class="n">org</span><span class="o">-</span><span class="n">apache</span><span
class="o">-</span><span class="n">hbase</span><span class="o">/</span> <span
class="o">--</span><span class="n">list</span> <span class="o">--</span><span
class="n">destdir</span> <span class="n">services</span>
+</pre></div>
+
+
+<p>This will create a directory <code>services</code> and save service records
to it.
+If a service <code>"hbase-1"</code> was registered a under this path, its
service record
+would be saved to the file <code>services/hbase-1.json</code>.</p>
<h3 id="start-name-wait-time"><code>start <name> [--wait
time</code>]</h3>
<p>(<strong>start</strong> used to be <strong>thaw</strong> in develop
branch)</p>
<p>Resume a stopped application instance, recreating it from its previously
saved state. This will include a best-effort attempt to create the same number
of nodes as before, though their locations may be different.</p>
