website: update usage and examples for status commands

This commit is contained in:
Ryan Uber
2015-09-15 13:09:47 -07:00
parent 92cf7b64d9
commit 729fd3cd5f
2 changed files with 49 additions and 3 deletions

View File

@@ -29,6 +29,11 @@ displayed.
* `-address`: The address of the Nomad server. Overrides the `NOMAD_ADDR`
environment variable if set. Defaults to `http://127.0.0.1:4646`.
## Node Status Options
* `-short`: Display short output. Used only when querying a single node. Drops
verbose information about node allocations.
## Examples
List view:
@@ -40,7 +45,19 @@ a72dfba2-c01f-49de-5ac6-e3391de2c50c dc1 node1 false ready
1f3f03ea-a420-b64b-c73b-51290ed7f481 dc1 node2 false ready
```
Single-node view:
Single-node view in short mode:
```
$ nomad node-status -short 1f3f03ea-a420-b64b-c73b-51290ed7f481
ID = 1f3f03ea-a420-b64b-c73b-51290ed7f481
Name = node2
Class =
Datacenter = dc1
Drain = false
Status = ready
```
Full output for a single node:
```
$ nomad node-status 1f3f03ea-a420-b64b-c73b-51290ed7f481
@@ -50,4 +67,8 @@ Class =
Datacenter = dc1
Drain = false
Status = ready
Allocations
ID EvalID JobID TaskGroup DesiredStatus ClientStatus
678c51dc-6c55-0ac8-d92d-675a1e8ea6b0 193229c4-aa02-bbe6-f996-fd7d6974a309 job8 grp8 failed failed
```

View File

@@ -26,9 +26,14 @@ useful status fields for each.
* `-address`: The address of the Nomad server. Overrides the `NOMAD_ADDR`
environment variable if set. Defaults to `http://127.0.0.1:4646`.
## Status Options
* `-short`: Display short output. Used only when a single node is being queried.
Drops verbose node allocation data from the output.
## Examples
Short list of all jobs:
List of all jobs:
```
$ nomad status
@@ -39,7 +44,19 @@ job3 service 2 pending
job4 service 1 complete
```
Detailed information of a single job:
Short view of a specific job:
```
$ nomad status -short job1
ID = job1
Name = Test Job
Type = service
Priority = 3
Datacenters = dc1,dc2,dc3
Status = pending
```
Full status information of a job:
```
$ nomad status job1
@@ -49,4 +66,12 @@ Type = service
Priority = 3
Datacenters = dc1,dc2,dc3
Status = pending
Evaluations
ID Priority Type TriggeredBy NodeID Status
193229c4-aa02-bbe6-f996-fd7d6974a309 3 service job-register node2 complete
Allocations
ID EvalID NodeID TaskGroup DesiredStatus ClientStatus
678c51dc-6c55-0ac8-d92d-675a1e8ea6b0 193229c4-aa02-bbe6-f996-fd7d6974a309 node2 grp8 failed failed
```