Author: buildbot
Date: Fri Oct 24 20:52:18 2014
New Revision: 926729
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 Fri Oct 24 20:52:18 2014
@@ -1 +1 @@
-1634041
+1634136
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 Fri Oct 24 20:52:18
2014
@@ -393,7 +393,7 @@ is used</p>
</pre></div>
-<h3 id="exists-name-live-status-status"><code>exists <name> [--live]
[--status status]</code></h3>
+<h3 id="exists-name-live-state-status"><code>exists <name> [--live]
[--state 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>
@@ -487,28 +487,40 @@ cluster</p>
</pre></div>
-<h3 id="list-name-live-history"><code>list [name] [--live]
[--history]</code></h3>
-<p>List Slider application instances visible to the user. "historical"
instances
-are instances which YARN is aware of, but which are not currently running.
-Live instances are application instances which are running âthere can be
-at most one of these with a specific name</p>
+<h3 id="list-name-live-status-status"><code>list [name] [--live] [--status
status]</code></h3>
+<p>List Slider application instances visible to the user. This includes
instances
+which are on the filesystem.</p>
<p>If no instance name is specified, all instances matching the criteria are
listed.</p>
<ol>
-<li><code>--live</code> indicates live instances are to be listed</li>
-<li><code>--history</code> indicates that historical instances are to be
listed</li>
+<li><code>--live</code> indicates live instances are to be listed: that is
anything <code>RUNNING</code>
+or awaiting execution (e.g <code>ACCEPTED</code>) or earlier</li>
+<li><code>--state <state></code> defines an explicit state for which a
record of the cluster
+ must be found in the RM.</li>
</ol>
-<p>The default is: list all (equivalent to <code>--live --history</code>)</p>
-<p>If an instance name is given, then that instance must exist.</p>
-<ol>
-<li>If <code>--live</code> is set then the application must be live. This is
the default
-policy.</li>
-<li>If <code>--history</code> is set then the instance must be in the
historical list.</li>
-</ol>
-<p>If there is no running instance with that name, an error is returned.</p>
+<p>The default is: list all application instances, running or not</p>
+<p>If an instance name is given, then that instance must in the filesystem or
+the operation will fail with the unknown cluster exit code.</p>
+<p>If the instance exists but is not in the <code>-live</code> state or any
state specified
+by a <code>--state</code> argument âthe operation will return -1</p>
<p>Example</p>
<div class="codehilite"><pre><span class="n">slider</span> <span
class="n">list</span>
<span class="n">slider</span> <span class="n">list</span> <span
class="n">instance1</span>
-<span class="n">slider</span> <span class="n">list</span> <span
class="o">--</span><span class="n">live</span> <span class="o">--</span><span
class="n">history</span>
+<span class="n">slider</span> <span class="n">list</span> <span
class="o">--</span><span class="n">live</span>
+<span class="n">slider</span> <span class="n">list</span> <span
class="n">instance1</span> <span class="o">--</span><span class="n">live</span>
+<span class="n">slider</span> <span class="n">list</span> <span
class="o">--</span><span class="n">state</span> <span class="n">FINISHED</span>
+<span class="n">slider</span> <span class="n">list</span> <span
class="o">--</span><span class="n">state</span> <span class="n">KILLED</span>
+<span class="n">slider</span> <span class="n">list</span> <span
class="o">--</span><span class="n">state</span> <span class="n">FAILED</span>
+<span class="n">slider</span> <span class="n">list</span> <span
class="n">instance1</span> <span class="o">--</span><span
class="n">state</span> <span class="n">FAILED</span>
+</pre></div>
+
+
+<p>Important: listings which search for completed instances may succeed while
+ an instance of the same name is running. This is because the operation lists
+ YARN records âand records of completed applications are retained for some
time.</p>
+<p>That is, if an instance is started and then stopped, then a new instance
started,
+ the following two operations may both succeed</p>
+<div class="codehilite"><pre><span class="n">slider</span> <span
class="n">list</span> <span class="n">instance1</span> <span
class="o">--</span><span class="n">live</span>
+<span class="n">slider</span> <span class="n">list</span> <span
class="o">--</span><span class="n">state</span> <span class="n">FINISHED</span>
</pre></div>
