svn commit: r927285 - in /websites/staging/slider/trunk/content: ./ docs/manpage.html

[bu...@apache.org]

Author: buildbot
Date: Wed Oct 29 14:59:23 2014
New Revision: 927285

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 Wed Oct 29 14:59:23 2014
@@ -1 +1 @@
-1634136
+1635166

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 Wed Oct 29 14:59:23 2014
@@ -267,7 +267,6 @@ If the application instance is live, the
 <p>It is not started; this can be done later with a <code>thaw</code> command.</p>
 <h3 id="slider-create-name"><code>slider create &lt;name&gt;</code></h3>
 <p>Build and run an application instance of the given name </p>
-<p>The <code>--wait</code> parameter, if provided, specifies the time in milliseconds to wait until the YARN application is actually running. Even after the YARN application has started, there may be some delay for the instance to start up.</p>
 <h4 id="arguments-for-build-and-create"><strong>Arguments for <code>build</code> and <code>create</code></strong></h4>
 <h5 id="-package-uri-to-package"><code>--package &lt;uri-to-package&gt;</code></h5>
 <p>This define the slider application package to be deployed.</p>
@@ -367,6 +366,11 @@ allocations, which must use the <code>--
 
 <p>If unset, the zookeeper quorum defined in the property <code>slider.zookeeper.quorum</code>
 is used</p>
+<h4 id="-zkpath-zookeeper-path"><code>--zkpath &lt;zookeeper-path&gt;</code></h4>
+<p>A path in the zookeeper cluster to create for an application. This
+is useful for applications which require a path to be created in advance
+of their deployment. When the an application instance is destroyed, this
+path will be deleted.</p>
 <h5 id="-queue-queue-name"><code>--queue &lt;queue name&gt;</code></h5>
 <p>The queue to deploy the application to. By default, YARN will pick the queue.</p>
 <p>Example</p>
@@ -374,6 +378,14 @@ is used</p>
 </pre></div>
 
 
+<h4 id="arguments-purely-for-the-create-operation">Arguments purely for the <code>create</code> operation</h4>
+<h5 id="-wait-milliseconds"><code>--wait &lt;milliseconds&gt;</code></h5>
+<p>The <code>--wait</code> parameter, if provided, specifies the time in milliseconds to wait until the YARN application is actually running. Even after the YARN application has started, there may be some delay for the instance to start up.</p>
+<p>[--out <filename>]</p>
+<h5 id="-out-filename"><code>--out &lt;filename&gt;</code></h5>
+<p>The name of a file to save a YARN application report to as a JSON file. This
+file will contain the YARN application ID and other information about the
+submitted application.</p>
 <h4 id="examples"><code>Examples</code></h4>
 <p>Create an application by providing <code>template</code> and <code>resources</code>.</p>
 <div class="codehilite"><pre><span class="n">create</span> <span class="n">hbase1</span> <span class="o">--</span><span class="n">template</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">work</span><span class="o">/</span><span class="n">hbase</span><span class="o">/</span><span class="n">appConfig</span><span class="p">.</span><span class="n">json</span> <span class="o">--</span><span class="n">resources</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">work</span><span class="o">/</span><span class="n">hbase</span><span class="o">/</span><span class="n">resources</span><span class="p">.</span><span class="n">json</span>
@@ -629,12 +641,17 @@ would be saved to the file <code>service
 
 
 <p>This simplifies path creation, testing a, </p>
-<h3 id="start-name-wait-time"><code>start &lt;name&gt; [--wait time</code>]</h3>
+<h3 id="start-name-wait-milliseconds-out-filename"><code>start &lt;name&gt; [--wait milliseconds] [--out &lt;filename&gt;]</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>
+<p>Start a stopped application instance, recreating it from its previously
+saved state.</p>
+<p>After the application is launched, if an <code>--out</code> argument specified a file,
+the "YARN application report" will be saved as a JSON document into the file
+specified.</p>
 <p>Examples:</p>
 <div class="codehilite"><pre><span class="n">slider</span> <span class="n">start</span> <span class="n">instance2</span>
-<span class="n">slider</span> <span class="n">start</span> <span class="n">instance1</span> <span class="o">--</span><span class="n">wait</span> 60
+<span class="n">slider</span> <span class="n">start</span> <span class="n">instance1</span> <span class="o">--</span><span class="n">wait</span> 60000
+<span class="n">slider</span> <span class="n">start</span> <span class="n">instance1</span> <span class="o">--</span><span class="n">out</span> <span class="n">appreport</span><span class="p">.</span><span class="n">json</span>
 </pre></div>