Documentation updates for short identifiers in the CLI

This commit is contained in:
Ivo Verberk
2015-12-29 12:17:16 +01:00
parent 8218442c43
commit a73aaf128b
10 changed files with 48 additions and 22 deletions

View File

@@ -19,8 +19,8 @@ current state of its tasks.
nomad alloc-status [options] <allocation>
```
An allocation ID must be provided. This specific allocation will be queried
and detailed information for it will be dumped.
An allocation ID (prefix) must be provided. This specific allocation will be
queried and detailed information for it will be dumped.
## General Options

View File

@@ -21,9 +21,9 @@ nomad eval-monitor [options] <eval>
```
The eval-monitor command requires a single argument, specifying the
evaluation ID to monitor. An interactive monitoring session will be
started in the terminal. It is safe to exit the monitor at any time
using ctrl+c.
evaluation ID (prefix) to monitor. An interactive monitoring session
will be started in the terminal. It is safe to exit the monitor at any
time using ctrl+c.
The command will exit when the given evaluation reaches a terminal
state (completed or failed). Exit code 0 is returned on successful

View File

@@ -21,9 +21,9 @@ nicely by providing the current drain status of a given node.
nomad node-drain [options] <node>
```
This command expects exactly one argument to specify the node ID to enable or
disable drain mode for. It is also required to pass one of `-enable` or
`-disable`, depending on which operation is desired.
This command expects exactly one argument to specify the node ID (prefix)
to enable or disable drain mode for. It is also required to pass one of
`-enable` or `-disable`, depending on which operation is desired.
## General Options

View File

@@ -20,9 +20,9 @@ nomad node-status [options] [node]
If no node ID is passed, then the command will enter "list mode" and dump a
high-level list of all known nodes. This list output contains less information
but is a good way to get a bird's-eye view of things. If a node ID is specified,
then that particular node will be queried, and detailed information will be
displayed.
but is a good way to get a bird's-eye view of things. If a node ID (prefix) is
specified, then that particular node will be queried, and detailed information
will be displayed.
## General Options
@@ -50,7 +50,7 @@ Single-node view in short mode:
$ nomad node-status -short 1f3f03ea-a420-b64b-c73b-51290ed7f481
ID = 1f3f03ea-a420-b64b-c73b-51290ed7f481
Name = node2
Class =
Class =
Datacenter = dc1
Drain = false
Status = ready
@@ -62,7 +62,7 @@ Full output for a single node:
$ nomad node-status 1f3f03ea-a420-b64b-c73b-51290ed7f481
ID = 1f3f03ea-a420-b64b-c73b-51290ed7f481
Name = node2
Class =
Class =
Datacenter = dc1
Drain = false
Status = ready

View File

@@ -16,10 +16,10 @@ The `status` command displays status information for jobs.
nomad status [options] [job]
```
This command accepts an optional job ID as the sole argument. If the job ID is
provided, information about the specific job is queried and displayed. If the ID
is omitted, the command lists out all of the existing jobs and a few of the most
useful status fields for each.
This command accepts an optional job ID (prefix) as the sole argument. If the
job ID is provided, information about the specific job is queried and displayed.
If the ID is omitted, the command lists out all of the existing jobs and a few
of the most useful status fields for each.
## General Options

View File

@@ -17,7 +17,7 @@ to cancel all of the running allocations.
nomad stop [options] <job>
```
The stop command requires a single argument, specifying the job ID to
The stop command requires a single argument, specifying the job ID (prefix) to
cancel.
Upon successful deregistration, an interactive monitor session will start to

View File

@@ -28,7 +28,14 @@ be specified using the `?region=` query parameter.
<dt>Parameters</dt>
<dd>
None
<ul>
<li>
<span class="param">prefix</span>
<span class="param-flags">optional</span>
<span class="param-flags">even-length</span>
Filter allocations based on an identifier prefix.
</li>
</ul>
</dd>
<dt>Blocking Queries</dt>

View File

@@ -28,7 +28,14 @@ be specified using the `?region=` query parameter.
<dt>Parameters</dt>
<dd>
None
<ul>
<li>
<span class="param">prefix</span>
<span class="param-flags">optional</span>
<span class="param-flags">even-length</span>
Filter evaluations based on an identifier prefix.
</li>
</ul>
</dd>
<dt>Blocking Queries</dt>

View File

@@ -28,7 +28,13 @@ another region can be specified using the `?region=` query parameter.
<dt>Parameters</dt>
<dd>
None
<ul>
<li>
<span class="param">prefix</span>
<span class="param-flags">optional</span>
Filter jobs based on an identifier prefix.
</li>
</ul>
</dd>
<dt>Blocking Queries</dt>

View File

@@ -28,7 +28,13 @@ be specified using the `?region=` query parameter.
<dt>Parameters</dt>
<dd>
None
<ul>
<li>
<span class="param">prefix</span>
<span class="param-flags">optional</span>
Filter nodes based on an identifier prefix.
</li>
</ul>
</dd>
<dt>Blocking Queries</dt>