Author: stevel
Date: Fri Oct 24 20:52:10 2014
New Revision: 1634136
URL: http://svn.apache.org/r1634136
Log:
SLIDER-306 update live options
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=1634136&r1=1634135&r2=1634136&view=diff
==============================================================================
--- incubator/slider/site/trunk/content/docs/manpage.md (original)
+++ incubator/slider/site/trunk/content/docs/manpage.md Fri Oct 24 20:52:10 2014
@@ -277,7 +277,7 @@ Example
slider destroy instance1
-### `exists <name> [--live] [--status status]`
+### `exists <name> [--live] [--state status]`
Probe the existence of the named Slider application instance. If the `--live`
flag is set, the instance
must actually be running
@@ -386,34 +386,48 @@ Example
slider install-package --name HBASE --package
/usr/work/package/hbase/slider-hbase-app-package-0.98.4-hadoop2.zip --replacepkg
-### `list [name] [--live] [--history] `
+### `list [name] [--live] [--status status]`
-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
+List Slider application instances visible to the user. This includes instances
+which are on the filesystem.
If no instance name is specified, all instances matching the criteria are
listed.
-1. `--live` indicates live instances are to be listed
-1. `--history` indicates that historical instances are to be listed
+1. `--live` indicates live instances are to be listed: that is anything
`RUNNING`
+or awaiting execution (e.g `ACCEPTED`) or earlier
+1. `--state <state>` defines an explicit state for which a record of the
cluster
+ must be found in the RM.
-The default is: list all (equivalent to `--live --history`)
+The default is: list all application instances, running or not
-If an instance name is given, then that instance must exist.
+If an instance name is given, then that instance must in the filesystem or
+the operation will fail with the unknown cluster exit code.
-1. If `--live` is set then the application must be live. This is the default
-policy.
-1. If `--history` is set then the instance must be in the historical list.
-
-If there is no running instance with that name, an error is returned.
+If the instance exists but is not in the `-live` state or any state specified
+by a `--state` argument âthe operation will return -1
Example
slider list
slider list instance1
- slider list --live --history
+ slider list --live
+ slider list instance1 --live
+ slider list --state FINISHED
+ slider list --state KILLED
+ slider list --state FAILED
+ slider list instance1 --state FAILED
+
+ 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.
+
+ That is, if an instance is started and then stopped, then a new instance
started,
+ the following two operations may both succeed
+
+ slider list instance1 --live
+ slider list --state FINISHED
+
### `registry (--list | --listconf | --getconf <conf> ) [--name <name>]
[--servicetype <servicetype>] [--out <filename>] [--verbose]`
