Skip to content

Commit

Permalink
Merge pull request #3111 from hashicorp/d-status
Browse files Browse the repository at this point in the history 
Document new status command
  • Loading branch information
@dadgar
dadgar authored Aug 28, 2017
2 parents 9383ef6 + 88372e6 commit aaaf2df
Show file tree
Hide file tree
Showing 5 changed files with 328 additions and 177 deletions.
6 changes: 3 additions & 3 deletions command/job_status.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ func (c *JobStatusCommand) Help() string {
helpText := `
Usage: nomad status [options] <job>
Display status information about jobs. If no job ID is given,
a list of all known jobs will be dumped.
Display status information about a job. If no job ID is given, a list of all
known jobs will be displayed.
General Options:
Expand All @@ -57,7 +57,7 @@ Status Options:
}

func (c *JobStatusCommand) Synopsis() string {
return "Display status information about jobs"
return "Display status information about a job"
}

func (c *JobStatusCommand) AutocompleteFlags() complete.Flags {
Expand Down
2 changes: 2 additions & 0 deletions website/source/docs/commands/job.html.md.erb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,11 @@ subcommands are available:
* [`job history`][history] - Display all tracked versions of a job
* [`job promote`][promote] - Promote a job's canaries
* [`job revert`][revert] - Revert to a prior version of the job
* [`job status`][status] - Display status information about a job

[deployments]: /docs/commands/job/deployments.html "List deployments for a job"
[dispatch]: /docs/commands/job/dispatch.html "Dispatch an instance of a parameterized job"
[history]: /docs/commands/job/history.html "Display all tracked versions of a job"
[promote]: /docs/commands/job/promote.html "Promote a job's canaries"
[revert]: /docs/commands/job/revert.html "Revert to a prior version of the job"
[status]: /docs/commands/job/status.html "Display status information about a job"
248 changes: 248 additions & 0 deletions website/source/docs/commands/job/status.html.md.erb
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,248 @@
---
layout: "docs"
page_title: "Commands: job status"
sidebar_current: "docs-commands-job-status"
description: >
Display information and status of jobs.
---

# Command: job status

The `job status` command displays status information for a job.

## Usage

```
nomad job status [options] [job]
```

This command accepts an optional job ID or prefix as the sole argument. If there
is an exact match based on the provided job ID or prefix, then information about
the specific job is queried and displayed. Otherwise, a list of matching jobs and
information will be 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

<%= partial "docs/commands/_general_options" %>

## Status Options

* `-all-allocs`: Display all allocations matching the job ID, even those from an
older instance of the job.

* `-evals`: Display the evaluations associated with the job.

* `-short`: Display short output. Used only when a single node is being queried.
Drops verbose node allocation data from the output.

* `-verbose`: Show full information.

## Examples

List of all jobs:

```
$ nomad job status
ID Type Priority Status Submit Date
job1 service 80 running 07/25/17 15:47:11 UTC
job2 batch 40 complete 07/24/17 19:22:11 UTC
job3 service 50 dead (stopped) 07/22/17 16:34:48 UTC
```

Short view of a specific job:

```
$ nomad job status -short job1
ID = job1
Name = Test Job
Submit Date = 07/25/17 15:47:11 UTC
Type = service
Priority = 3
Datacenters = dc1,dc2,dc3
Status = pending
Periodic = false
Parameterized = false
```

Full status information of a job:

```
$ nomad job status example
ID = example
Name = example
Submit Date = 07/25/17 15:53:04 UTC
Type = service
Priority = 50
Datacenters = dc1
Status = running
Periodic = false
Parameterized = false

Summary
Task Group Queued Starting Running Failed Complete Lost
cache 0 0 1 0 0 0

Latest Deployment
ID = 6294be0c
Status = successful
Description = Deployment completed successfully

Deployed
Task Group Desired Placed Healthy Unhealthy
cache 1 1 1 0

Allocations
ID Node ID Task Group Version Desired Status Created At
478ce836 5ed166e8 cache 0 run running 07/25/17 15:53:04 UTC
```

Full status information of a perodic job:

```
$ nomad job status example
ID = example
Name = example
Submit Date = 07/25/17 15:59:52 UTC
Type = batch
Priority = 50
Datacenters = dc1
Status = running
Periodic = true
Parameterized = false
Next Periodic Launch = 07/25/17 16:00:30 UTC (5s from now)

Children Job Summary
Pending Running Dead
0 3 0

Previously Launched Jobs
ID Status
example/periodic-1500998400 running
example/periodic-1500998410 running
example/periodic-1500998420 running
```

Full status information of a parameterized job:

```
$ nomad job status example
ID = example
Name = example
Submit Date = 07/25/17 15:59:52 UTC
Type = batch
Priority = 50
Datacenters = dc1
Status = running
Periodic = false
Parameterized = true

Parameterized Job
Payload = required
Required Metadata = foo
Optional Metadata = bar

Parameterized Job Summary
Pending Running Dead
0 2 0

Dispatched Jobs
ID Status
example/dispatch-1485411496-58f24d2d running
example/dispatch-1485411499-fa2ee40e running
```

Full status information of a job with placement failures:

```
$ nomad job status example
ID = example
Name = example
Submit Date = 07/25/17 15:55:27 UTC
Type = service
Priority = 50
Datacenters = dc1
Status = running
Periodic = false
Parameterized = false

Summary
Task Group Queued Starting Running Failed Complete Lost
cache 1 0 4 0 0 0

Placement Failure
Task Group "cache":
* Resources exhausted on 1 nodes
* Dimension "cpu exhausted" exhausted on 1 nodes

Latest Deployment
ID = bb4b2fb1
Status = running
Description = Deployment is running

Deployed
Task Group Desired Placed Healthy Unhealthy
cache 5 4 4 0

Allocations
ID Node ID Task Group Version Desired Status Created At
048c1e9e 3f38ecb4 cache 0 run running 07/25/17 15:55:27 UTC
250f9dec 3f38ecb4 cache 0 run running 07/25/17 15:55:27 UTC
2eb772a1 3f38ecb4 cache 0 run running 07/25/17 15:55:27 UTC
a17b7d3d 3f38ecb4 cache 0 run running 07/25/17 15:55:27 UTC
```

Full status information showing evaluations with a placement failure. The in
progress evaluation denotes that Nomad is blocked waiting for resources to
become availables so that it can place the remaining allocations.

```
$ nomad job status -evals example
ID = example
Name = example
Submit Date = 07/25/17 15:55:27 UTC
Type = service
Priority = 50
Datacenters = dc1
Status = running
Periodic = false
Parameterized = false

Summary
Task Group Queued Starting Running Failed Complete Lost
cache 1 0 4 0 0 0

Evaluations
ID Priority Triggered By Status Placement Failures
e44a39e8 50 deployment-watcher canceled false
97018573 50 deployment-watcher complete true
d5a7300c 50 deployment-watcher canceled false
f05a4495 50 deployment-watcher complete true
e3f3bdb4 50 deployment-watcher canceled false
b5f08700 50 deployment-watcher complete true
73bb867a 50 job-register blocked N/A - In Progress
85052989 50 job-register complete true

Placement Failure
Task Group "cache":
* Resources exhausted on 1 nodes
* Dimension "cpu exhausted" exhausted on 1 nodes

Latest Deployment
ID = bb4b2fb1
Status = running
Description = Deployment is running

Deployed
Task Group Desired Placed Healthy Unhealthy
cache 5 4 4 0

Allocations
ID Node ID Task Group Version Desired Status Created At
048c1e9e 3f38ecb4 cache 0 run running 07/25/17 15:55:27 UTC
250f9dec 3f38ecb4 cache 0 run running 07/25/17 15:55:27 UTC
2eb772a1 3f38ecb4 cache 0 run running 07/25/17 15:55:27 UTC
a17b7d3d 3f38ecb4 cache 0 run running 07/25/17 15:55:27 UTC
```
Loading

0 comments on commit aaaf2df

Please sign in to comment.