Files
nomad/website/content/docs/commands/alloc/status.mdx
Phil Renaud 35e1ea4328 [cli] UI URL hints for common CLI commands (#24454)
* Basic implementation for server members and node status

* Commands for alloc status and job status

* -ui flag for most commands

* url hints for variables

* url hints for job dispatch, evals, and deployments

* agent config ui.cli_url_links to disable

* Fix an issue where path prefix was presumed for variables

* driver uncomment and general cleanup

* -ui flag on the generic status endpoint

* Job run command gets namespaces, and no longer gets ui hints for --output flag

* Dispatch command hints get a namespace, and bunch o tests

* Lots of tests depend on specific output, so let's not mess with them

* figured out what flagAddress is all about for testServer, oof

* Parallel outside of test instances

* Browser-opening test, sorta

* Env var for disabling/enabling CLI hints

* Addressing a few PR comments

* CLI docs available flags now all have -ui

* PR comments addressed; switched the env var to be consistent and scrunched monitor-adjacent hints a bit more

* ui.Output -> ui.Warn; moves hints from stdout to stderr

* isTerminal check and parseBool on command option

* terminal.IsTerminal check removed for test-runner-not-being-terminal reasons
2025-03-07 13:23:35 -05:00

184 lines
5.3 KiB
Plaintext

---
layout: docs
page_title: 'Commands: alloc status'
description: |
Display status and metadata about existing allocations and their tasks.
---
# Command: alloc status
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.
## Usage
```plaintext
nomad alloc status [options] <allocation>
```
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.
When ACLs are enabled, this command requires a token with the `read-job` and
`list-jobs` capabilities for the allocation's namespace.
## General Options
@include 'general_options.mdx'
## Alloc Status Options
- `-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.
- `-ui` : Open the allocation status page in the browser.
## Examples
Short status of an alloc:
```shell-session
$ nomad alloc status --short 0af996ed
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
Name State Last Event Time
redis running Started 07/25/17 16:12:48 UTC
web running Started 07/25/17 16:12:49 UTC
```
Full status of an alloc, which shows one of the tasks dying and then being restarted:
```shell-session
$ nomad alloc status 0af996ed
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
Task "redis" is "running"
Task Resources
CPU Memory Disk Addresses
1/500 MHz 6.3 MiB/256 MiB 300 MiB db: 127.0.0.1:27908
CSI Volumes:
ID Plugin Provider Schedulable Mount Options
vol-4150af42 ebs0 aws.ebs true <none>
Task Events:
Started At = 07/25/17 16:12:48 UTC
Finished At = N/A
Total Restarts = 0
Last Restart = N/A
Recent Events:
Time Type Description
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
Task "web" is "running"
Task Resources
CPU Memory Disk Addresses
1/500 MHz 6.3 MiB/256 MiB 300 MiB db: 127.0.0.1:30572
Task Events:
Started At = 07/25/17 16:12:49 UTC
Finished At = N/A
Total Restarts = 0
Last Restart = N/A
Recent Events:
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
```
Verbose status can also be accessed:
```shell-session
$ nomad alloc status -verbose 0af996ed
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
Task "redis" is "running"
Task Resources
CPU Memory Disk Addresses
1/500 MHz 6.3 MiB/256 MiB 300 MiB db: 127.0.0.1:27908
Task Events:
Started At = 07/25/17 16:12:48 UTC
Finished At = N/A
Total Restarts = 0
Last Restart = N/A
Recent Events:
Time Type Description
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
Task "web" is "running"
Task Resources
CPU Memory Disk Addresses
1/500 MHz 6.3 MiB/256 MiB 300 MiB db: 127.0.0.1:30572
Task Events:
Started At = 07/25/17 16:12:49 UTC
Finished At = N/A
Total Restarts = 0
Last Restart = N/A
Recent Events:
Time Type Description
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
```