You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@slider.apache.org by bu...@apache.org on 2014/10/21 15:22:50 UTC
svn commit: r926329 - in /websites/staging/slider/trunk/content: ./
docs/manpage.html
Author: buildbot
Date: Tue Oct 21 13:22:50 2014
New Revision: 926329
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 Tue Oct 21 13:22:50 2014
@@ -1 +1 @@
-1633155
+1633372
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 Tue Oct 21 13:22:50 2014
@@ -230,7 +230,7 @@ and existing but not running "stopped" a
<p>The supported component types depends upon the slider application.</p>
</li>
<li>
-<p>the count of each component must initially be specified when a application instance is created.</p>
+<p>the count of each component must initially be specified when an application instance is created.</p>
</li>
<li>
<p>Users can flex an application instance: adding or removing components dynamically.
@@ -272,7 +272,7 @@ If the application instance is live, the
<h5 id="-package-uri-to-package"><code>--package <uri-to-package></code></h5>
<p>This define the slider application package to be deployed.</p>
<h5 id="-option-name-value"><code>--option <name> <value></code></h5>
-<p>Set a application instance option. </p>
+<p>Set an application instance option. </p>
<p>Example:</p>
<p>Set an option to be passed into the <code>-site.xml</code> file of the target system, reducing
the HDFS replication factor to 2. (</p>
@@ -393,34 +393,39 @@ is used</p>
</pre></div>
-<h3 id="exists-name-live"><code>exists <name> [--live]</code></h3>
+<h3 id="exists-name-live-status-status"><code>exists <name> [--live] [--status status]</code></h3>
<p>Probe the existence of the named Slider application instance. If the <code>--live</code> flag is set, the instance
must actually be running</p>
<p>If not, an error code is returned.</p>
-<p>When the --live` flag is unset, the command looks for the application instance to be
+<p>When the <code>--live</code> flag is unset, the command looks for the application instance to be
defined in the filesystem -its operation state is not checked.</p>
-<p>Return codes</p>
-<div class="codehilite"><pre> 0 <span class="p">:</span> <span class="n">application</span> <span class="n">instance</span> <span class="n">is</span> <span class="n">defined</span> <span class="n">in</span> <span class="n">the</span> <span class="n">filesystem</span>
-70 <span class="p">:</span> <span class="n">application</span> <span class="n">instance</span> <span class="n">is</span> <span class="n">unknown</span>
+<p>it will "succeed" if the definition files of the named application instance
+are found.</p>
+<p>Example:</p>
+<div class="codehilite"><pre><span class="n">slider</span> <span class="n">exists</span> <span class="n">instance4</span>
</pre></div>
-<p>Example:</p>
-<div class="codehilite"><pre><span class="n">slider</span> <span class="n">exists</span> <span class="n">instance4</span>
+<p>Return codes</p>
+<div class="codehilite"><pre> 0 <span class="p">:</span> <span class="n">application</span> <span class="n">instance</span> <span class="n">is</span> <span class="n">running</span>
+<span class="o">-</span>1 <span class="p">:</span> <span class="n">application</span> <span class="n">instance</span> <span class="n">exists</span> <span class="n">but</span> <span class="n">is</span> <span class="n">not</span> <span class="n">running</span>
+69 <span class="p">:</span> <span class="n">application</span> <span class="n">instance</span> <span class="n">is</span> <span class="n">unknown</span>
</pre></div>
<h4 id="live-tests">Live Tests</h4>
-<p>When the <code>--live</code> flag is set, the application instance must be running for the command
-to succeed</p>
-<ol>
-<li>The probe does not check the status of any Slider-deployed services, merely that a application instance has been deployed</li>
-<li>A application instance that is finished or failed is not considered to be live.</li>
-</ol>
+<p>When the <code>--live</code> flag is set, the application instance must be running
+or about to run for the probe to succeed.
+That is, either application is running (<code>RUNNING</code>) or in any of the states
+from which an application can start running. That means the service can be
+in any of the states <code>NEW</code>, <code>NEW_SAVING</code>, <code>SUBMITTED</code>, <code>ACCEPTED</code> or <code>RUNNING</code></p>
+<p>An application instance that is <code>FINISHED</code> or <code>FAILED</code> or <code>KILLED</code> is not considered to be live.</p>
+<p>Note that probe does not check the <em>liveness</em> of the actually deployed application,
+merely that the application instance has been deployed</p>
<p>Return codes</p>
<div class="codehilite"><pre> 0 <span class="p">:</span> <span class="n">application</span> <span class="n">instance</span> <span class="n">is</span> <span class="n">running</span>
<span class="o">-</span>1 <span class="p">:</span> <span class="n">application</span> <span class="n">instance</span> <span class="n">exists</span> <span class="n">but</span> <span class="n">is</span> <span class="n">not</span> <span class="n">running</span>
-70 <span class="p">:</span> <span class="n">application</span> <span class="n">instance</span> <span class="n">is</span> <span class="n">unknown</span>
+69 <span class="p">:</span> <span class="n">application</span> <span class="n">instance</span> <span class="n">is</span> <span class="n">unknown</span>
</pre></div>
@@ -429,6 +434,31 @@ to succeed</p>
</pre></div>
+<p>When the <code>--state</code> flag is set, a specific YARN application state is checked for.</p>
+<p>The allowed YARN states are:</p>
+<div class="codehilite"><pre> <span class="n">NEW</span><span class="p">:</span> <span class="n">Application</span> <span class="n">which</span> <span class="n">was</span> <span class="n">just</span> <span class="n">created</span><span class="p">.</span>
+ <span class="n">NEW_SAVING</span><span class="p">:</span> <span class="n">Application</span> <span class="n">which</span> <span class="n">is</span> <span class="n">being</span> <span class="n">saved</span><span class="p">.</span>
+ <span class="n">SUBMITTED</span><span class="p">:</span> <span class="n">Application</span> <span class="n">which</span> <span class="n">has</span> <span class="n">been</span> <span class="n">submitted</span><span class="p">.</span>
+ <span class="n">ACCEPTED</span><span class="p">:</span> <span class="n">Application</span> <span class="n">has</span> <span class="n">been</span> <span class="n">accepted</span> <span class="n">by</span> <span class="n">the</span> <span class="n">scheduler</span>
+ <span class="n">RUNNING</span><span class="p">:</span> <span class="n">Application</span> <span class="n">which</span> <span class="n">is</span> <span class="n">currently</span> <span class="n">running</span><span class="p">.</span>
+ <span class="n">FINISHED</span><span class="p">:</span> <span class="n">Application</span> <span class="n">which</span> <span class="n">finished</span> <span class="n">successfully</span><span class="p">.</span>
+ <span class="n">FAILED</span><span class="p">:</span> <span class="n">Application</span> <span class="n">which</span> <span class="n">failed</span><span class="p">.</span>
+ <span class="n">KILLED</span><span class="p">:</span> <span class="n">Application</span> <span class="n">which</span> <span class="n">was</span> <span class="n">terminated</span> <span class="n">by</span> <span class="n">a</span> <span class="n">user</span> <span class="n">or</span> <span class="n">admin</span><span class="p">.</span>
+</pre></div>
+
+
+<p>Example:</p>
+<div class="codehilite"><pre><span class="n">slider</span> <span class="n">exists</span> <span class="n">instance4</span> <span class="o">--</span><span class="n">state</span> <span class="n">ACCEPTED</span>
+</pre></div>
+
+
+<p>Return codes</p>
+<div class="codehilite"><pre> 0 <span class="p">:</span> <span class="n">application</span> <span class="n">instance</span> <span class="n">is</span> <span class="n">running</span>
+<span class="o">-</span>1 <span class="p">:</span> <span class="n">application</span> <span class="n">instance</span> <span class="n">exists</span> <span class="n">but</span> <span class="n">is</span> <span class="n">not</span> <span class="n">in</span> <span class="n">the</span> <span class="n">desired</span> <span class="n">state</span>
+69 <span class="p">:</span> <span class="n">application</span> <span class="n">instance</span> <span class="n">is</span> <span class="n">unknown</span>
+</pre></div>
+
+
<h3 id="flex-name-component-component-count"><code>flex <name> [--component component count]*</code></h3>
<p>Flex the number of workers in an application instance to the new value.
If greater than before, new copies of the component will be requested.
@@ -482,7 +512,7 @@ policy.</li>
</pre></div>
-<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>
+<h3 id="registry-list-listconf-getconf-conf-name-name-servicetype-servicetype-out-filename-verbose"><code>registry (--list | --listconf | --getconf <conf> ) [--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
@@ -552,10 +582,14 @@ and save it to a file</p>
<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>
+<h3 id="list-all-entries-and-services-under-a-path-slider-resolve-path-path-list">List all entries and 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
+directly under a path.</p>
+<p>The all entries will be listed to the console,
+followed by the individual service records of those entries that contain
+a service record declaration.</p>
+<p>The service records can be 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>