luxolus/open-nomad
2
0
Fork 0
Code Issues 1 Pull requests Packages Releases Wiki Activity
open-nomad/website/pages/docs/commands/alloc/status.mdx

185 lines
5.4 KiB
Plaintext
Raw Normal View History

website: document alloc-status command
2015-09-27 21:20:09 +00:00
---
new website :sparkles:
2020-02-06 23:45:31 +00:00
layout: docs
page_title: 'Commands: alloc status'
sidebar_title: status
description: |
Add docs
2015-11-17 02:36:13 +00:00
Display status and metadata about existing allocations and their tasks.
website: document alloc-status command
2015-09-27 21:20:09 +00:00
---
nested command docs
2018-03-22 17:56:06 +00:00
# Command: alloc status
website: document alloc-status command
2015-09-27 21:20:09 +00:00
Documentation for CSI command line and jobspec (#7439) Includes: * changes `nomad alloc status` and `nomad node status` * changes to `volume` block in jobspec * new `csi_plugin` block in jobspec * new `nomad volume register/deregister/status` commands * new `nomad plugin status` command
2020-03-24 15:09:46 +00:00
The `alloc status` command displays status information and metadata
about an existing allocation and its tasks. It can be useful while
debugging to reveal the underlying reasons for scheduling decisions or
failures, as well as the current state of its tasks. As of Nomad
0.7.1, alloc status also shows allocation modification time in
addition to create time. As of Nomad 0.8, alloc status shows
information about reschedule attempts. As of Nomad 0.11, alloc status
shows volume claims when a job claims volumes.
website: document alloc-status command
2015-09-27 21:20:09 +00:00
## Usage
Fixup for command section of website * changed list indicator from * -> - * moved in-text links to reference links * made commands `plaintext` * made command examples `console` * rewrapped text
2019-10-22 13:44:00 +00:00
```plaintext
nested command docs
2018-03-22 17:56:06 +00:00
nomad alloc status [options] <allocation>
website: document alloc-status command
2015-09-27 21:20:09 +00:00
```
Improvements for short identifiers * Fix tests * Update documentation
2016-01-06 21:46:57 +00:00
An allocation ID or prefix must be provided. If there is an exact match, the
full details of the allocation will be displayed. Otherwise, a list of matching
allocations and information will be displayed.
website: document alloc-status command
2015-09-27 21:20:09 +00:00
## General Options
new website :sparkles:
2020-02-06 23:45:31 +00:00
@include 'general_options.mdx'
Update website documentation
2016-01-19 23:01:26 +00:00
docs: Update command options subtitles
2016-08-09 13:56:26 +00:00
## Alloc Status Options
Add docs
2015-11-17 02:36:13 +00:00
Fixup for command section of website * changed list indicator from * -> - * moved in-text links to reference links * made commands `plaintext` * made command examples `console` * rewrapped text
2019-10-22 13:44:00 +00:00
- `-short`: Display short output. Shows only the most recent task event.
- `-verbose`: Show full information.
- `-json` : Output the allocation in its JSON format.
- `-t` : Format and display the allocation using a Go template.
website: document alloc-status command
2015-09-27 21:20:09 +00:00
## Examples
Add docs
2015-11-17 02:36:13 +00:00
Short status of an alloc:
fix shell-session snippet error
2020-05-18 20:53:06 +00:00
```shell-session
$ nomad alloc status --short 0af996ed
alloc-status
2017-07-25 16:15:31 +00:00
ID = 0af996ed
Eval ID = be9bde98
Name = example.cache[0]
Node ID = 43c0b14e
Job ID = example
Job Version = 0
Client Status = running
Client Description = <none>
Desired Status = run
Desired Description = <none>
Created At = 07/25/17 16:12:48 UTC
Deployment ID = 0c83a3b1
Deployment Health = healthy
Tasks
node-status -self command and docs
2016-03-29 19:36:24 +00:00
Name State Last Event Time
alloc-status
2017-07-25 16:15:31 +00:00
redis running Started 07/25/17 16:12:48 UTC
web running Started 07/25/17 16:12:49 UTC
Add docs
2015-11-17 02:36:13 +00:00
```
Full status of an alloc, which shows one of the tasks dying and then being restarted:
fix shell-session snippet error
2020-05-18 20:53:06 +00:00
```shell-session
$ nomad alloc status 0af996ed
Documentation for reschedule attempts in CLI/API
2018-01-31 21:54:10 +00:00
ID = 0af996ed
Eval ID = be9bde98
Name = example.cache[0]
Node ID = 43c0b14e
Job ID = example
Job Version = 0
Client Status = running
Client Description = <none>
Desired Status = run
Desired Description = <none>
Created = 5m ago
Modified = 5m ago
Deployment ID = 0c83a3b1
Deployment Health = healthy
Replacement Alloc ID = 0bc894ca
Reschedule Attempts = 1/3
Update API and JSON Job Documentation This PR updates the api documentation to reflect 0.6 HTTP API and the JSON job specification as well.
2017-07-26 00:18:15 +00:00
Task "redis" is "running"
Task Resources
Deprecate IOPS IOPS have been modelled as a resource since Nomad 0.1 but has never actually been detected and there is no plan in the short term to add detection. This is because IOPS is a bit simplistic of a unit to define the performance requirements from the underlying storage system. In its current state it adds unnecessary confusion and can be removed without impacting any users. This PR leaves IOPS defined at the jobspec parsing level and in the api/ resources since these are the two public uses of the field. These should be considered deprecated and only exist to allow users to stop using them during the Nomad 0.9.x release. In the future, there should be no expectation that the field will exist.
2018-12-06 23:09:26 +00:00
CPU Memory Disk Addresses
1/500 MHz 6.3 MiB/256 MiB 300 MiB db: 127.0.0.1:27908
Update API and JSON Job Documentation This PR updates the api documentation to reflect 0.6 HTTP API and the JSON job specification as well.
2017-07-26 00:18:15 +00:00
Documentation for CSI command line and jobspec (#7439) Includes: * changes `nomad alloc status` and `nomad node status` * changes to `volume` block in jobspec * new `csi_plugin` block in jobspec * new `nomad volume register/deregister/status` commands * new `nomad plugin status` command
2020-03-24 15:09:46 +00:00
CSI Volumes:
ID Plugin Provider Schedulable Mount Options
vol-4150af42 ebs0 aws.ebs true <none>
Update API and JSON Job Documentation This PR updates the api documentation to reflect 0.6 HTTP API and the JSON job specification as well.
2017-07-26 00:18:15 +00:00
Task Events:
alloc-status
2017-07-25 16:15:31 +00:00
Started At = 07/25/17 16:12:48 UTC
Update API and JSON Job Documentation This PR updates the api documentation to reflect 0.6 HTTP API and the JSON job specification as well.
2017-07-26 00:18:15 +00:00
Finished At = N/A
Total Restarts = 0
Last Restart = N/A
node-status -self command and docs
2016-03-29 19:36:24 +00:00
Update API and JSON Job Documentation This PR updates the api documentation to reflect 0.6 HTTP API and the JSON job specification as well.
2017-07-26 00:18:15 +00:00
Recent Events:
Time Type Description
alloc-status
2017-07-25 16:15:31 +00:00
07/25/17 16:12:48 UTC Started Task started by client
07/25/17 16:12:48 UTC Task Setup Building Task Directory
07/25/17 16:12:48 UTC Received Task received by client
node-status -self command and docs
2016-03-29 19:36:24 +00:00
Update API and JSON Job Documentation This PR updates the api documentation to reflect 0.6 HTTP API and the JSON job specification as well.
2017-07-26 00:18:15 +00:00
Task "web" is "running"
Task Resources
Deprecate IOPS IOPS have been modelled as a resource since Nomad 0.1 but has never actually been detected and there is no plan in the short term to add detection. This is because IOPS is a bit simplistic of a unit to define the performance requirements from the underlying storage system. In its current state it adds unnecessary confusion and can be removed without impacting any users. This PR leaves IOPS defined at the jobspec parsing level and in the api/ resources since these are the two public uses of the field. These should be considered deprecated and only exist to allow users to stop using them during the Nomad 0.9.x release. In the future, there should be no expectation that the field will exist.
2018-12-06 23:09:26 +00:00
CPU Memory Disk Addresses
1/500 MHz 6.3 MiB/256 MiB 300 MiB db: 127.0.0.1:30572
Add docs
2015-11-17 02:36:13 +00:00
Update API and JSON Job Documentation This PR updates the api documentation to reflect 0.6 HTTP API and the JSON job specification as well.
2017-07-26 00:18:15 +00:00
Task Events:
alloc-status
2017-07-25 16:15:31 +00:00
Started At = 07/25/17 16:12:49 UTC
Update API and JSON Job Documentation This PR updates the api documentation to reflect 0.6 HTTP API and the JSON job specification as well.
2017-07-26 00:18:15 +00:00
Finished At = N/A
Total Restarts = 0
Last Restart = N/A
Add docs
2015-11-17 02:36:13 +00:00
Recent Events:
alloc-status
2017-07-25 16:15:31 +00:00
07/25/17 16:12:49 UTC Started Task started by client
07/25/17 16:12:48 UTC Task Setup Building Task Directory
07/25/17 16:12:48 UTC Received Task received by client
node-status -self command and docs
2016-03-29 19:36:24 +00:00
```
Add docs
2015-11-17 02:36:13 +00:00
node-status -self command and docs
2016-03-29 19:36:24 +00:00
Verbose status can also be accessed:
fix shell-session snippet error
2020-05-18 20:53:06 +00:00
```shell-session
$ nomad alloc status -verbose 0af996ed
Initial docs for new delayed rescheduling options
2018-03-21 20:22:29 +00:00
ID = 0af996ed-aff4-8ddb-a566-e55ebf8969c9
Eval ID = be9bde98-0490-1beb-ced0-012d10ddf22e
Name = example.cache[0]
Node ID = 43c0b14e-7f96-e432-a7da-06605257ce0c
Job ID = example
Job Version = 0
Client Status = running
Client Description = <none>
Desired Status = run
Desired Description = <none>
Created = 07/25/17 16:12:48 UTC
Modified = 07/25/17 16:12:48 UTC
Deployment ID = 0c83a3b1-8a7b-136b-0e11-8383dc6c9276
Deployment Health = healthy
Reschedule Eligibility = 2m from now
Evaluated Nodes = 1
Filtered Nodes = 0
Exhausted Nodes = 0
Allocation Time = 38.474µs
Failures = 0
Update API and JSON Job Documentation This PR updates the api documentation to reflect 0.6 HTTP API and the JSON job specification as well.
2017-07-26 00:18:15 +00:00
Task "redis" is "running"
Task Resources
Deprecate IOPS IOPS have been modelled as a resource since Nomad 0.1 but has never actually been detected and there is no plan in the short term to add detection. This is because IOPS is a bit simplistic of a unit to define the performance requirements from the underlying storage system. In its current state it adds unnecessary confusion and can be removed without impacting any users. This PR leaves IOPS defined at the jobspec parsing level and in the api/ resources since these are the two public uses of the field. These should be considered deprecated and only exist to allow users to stop using them during the Nomad 0.9.x release. In the future, there should be no expectation that the field will exist.
2018-12-06 23:09:26 +00:00
CPU Memory Disk Addresses
1/500 MHz 6.3 MiB/256 MiB 300 MiB db: 127.0.0.1:27908
Update API and JSON Job Documentation This PR updates the api documentation to reflect 0.6 HTTP API and the JSON job specification as well.
2017-07-26 00:18:15 +00:00
Task Events:
alloc-status
2017-07-25 16:15:31 +00:00
Started At = 07/25/17 16:12:48 UTC
Update API and JSON Job Documentation This PR updates the api documentation to reflect 0.6 HTTP API and the JSON job specification as well.
2017-07-26 00:18:15 +00:00
Finished At = N/A
Total Restarts = 0
Last Restart = N/A
node-status -self command and docs
2016-03-29 19:36:24 +00:00
Recent Events:
Update API and JSON Job Documentation This PR updates the api documentation to reflect 0.6 HTTP API and the JSON job specification as well.
2017-07-26 00:18:15 +00:00
Time Type Description
alloc-status
2017-07-25 16:15:31 +00:00
07/25/17 16:12:48 UTC Started Task started by client
07/25/17 16:12:48 UTC Task Setup Building Task Directory
07/25/17 16:12:48 UTC Received Task received by client
Update API and JSON Job Documentation This PR updates the api documentation to reflect 0.6 HTTP API and the JSON job specification as well.
2017-07-26 00:18:15 +00:00
Task "web" is "running"
Task Resources
Deprecate IOPS IOPS have been modelled as a resource since Nomad 0.1 but has never actually been detected and there is no plan in the short term to add detection. This is because IOPS is a bit simplistic of a unit to define the performance requirements from the underlying storage system. In its current state it adds unnecessary confusion and can be removed without impacting any users. This PR leaves IOPS defined at the jobspec parsing level and in the api/ resources since these are the two public uses of the field. These should be considered deprecated and only exist to allow users to stop using them during the Nomad 0.9.x release. In the future, there should be no expectation that the field will exist.
2018-12-06 23:09:26 +00:00
CPU Memory Disk Addresses
1/500 MHz 6.3 MiB/256 MiB 300 MiB db: 127.0.0.1:30572
Update API and JSON Job Documentation This PR updates the api documentation to reflect 0.6 HTTP API and the JSON job specification as well.
2017-07-26 00:18:15 +00:00
Task Events:
alloc-status
2017-07-25 16:15:31 +00:00
Started At = 07/25/17 16:12:49 UTC
Update API and JSON Job Documentation This PR updates the api documentation to reflect 0.6 HTTP API and the JSON job specification as well.
2017-07-26 00:18:15 +00:00
Finished At = N/A
Total Restarts = 0
Last Restart = N/A
node-status -self command and docs
2016-03-29 19:36:24 +00:00
Recent Events:
Time Type Description
alloc-status
2017-07-25 16:15:31 +00:00
07/25/17 16:12:49 UTC Started Task started by client
07/25/17 16:12:48 UTC Task Setup Building Task Directory
07/25/17 16:12:48 UTC Received Task received by client
website: document alloc-status command
2015-09-27 21:20:09 +00:00
```
Reference in a new issue Copy permalink