Author: stevel
Date: Wed Oct 29 14:59:18 2014
New Revision: 1635166
URL: http://svn.apache.org/r1635166
Log:
SLIDER-579 Add CLI operations/--out args to get the app reports of launched apps
Modified:
incubator/slider/site/trunk/content/docs/manpage.md
Modified: incubator/slider/site/trunk/content/docs/manpage.md
URL:
http://svn.apache.org/viewvc/incubator/slider/site/trunk/content/docs/manpage.md?rev=1635166&r1=1635165&r2=1635166&view=diff
==============================================================================
--- incubator/slider/site/trunk/content/docs/manpage.md (original)
+++ incubator/slider/site/trunk/content/docs/manpage.md Wed Oct 29 14:59:18 2014
@@ -122,8 +122,6 @@ It is not started; this can be done late
Build and run an application instance of the given name
-The `--wait` 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.
-
#### **Arguments for `build` and `create`**
@@ -250,13 +248,36 @@ Example
If unset, the zookeeper quorum defined in the property
`slider.zookeeper.quorum`
is used
+#### `--zkpath <zookeeper-path>`
+
+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.
+
##### `--queue <queue name>`
+
The queue to deploy the application to. By default, YARN will pick the queue.
Example
--queue applications
+#### Arguments purely for the `create` operation
+
+##### `--wait <milliseconds>`
+
+The `--wait` 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.
+
+[--out <filename>]
+
+##### `--out <filename>`
+
+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.
+
+
#### `Examples`
Create an application by providing `template` and `resources`.
@@ -266,6 +287,7 @@ Create an application by providing `temp
create hbase1 --template /usr/work/hbase/appConfig.json --resources
/usr/work/hbase/resources.json --queue default
+
### `destroy <name>`
@@ -566,16 +588,22 @@ The current users base path can be refer
This simplifies path creation, testing a,
-### `start <name> [--wait time`]
+### `start <name> [--wait milliseconds] [--out <filename>]`
(**start** used to be **thaw** in develop branch)
-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.
+Start a stopped application instance, recreating it from its previously
+saved state.
+
+
+After the application is launched, if an `--out` argument specified a file,
+the "YARN application report" will be saved as a JSON document into the file
+specified.
Examples:
slider start instance2
- slider start instance1 --wait 60
-
+ slider start instance1 --wait 60000
+ slider start instance1 --out appreport.json
If the application instance is already running, this command will not affect
it.
