mirror of
https://github.com/kemko/nomad.git
synced 2026-01-03 17:05:43 +03:00
58898e1426
This PR updates the api documentation to reflect 0.6 HTTP API and the JSON job specification as well.
173 lines
4.9 KiB
Plaintext
173 lines
4.9 KiB
Plaintext
---
|
|
layout: "docs"
|
|
page_title: "Commands: alloc-status"
|
|
sidebar_current: "docs-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
|
|
|
|
```
|
|
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.
|
|
|
|
## General Options
|
|
|
|
<%= partial "docs/commands/_general_options" %>
|
|
|
|
## 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 allocation using a Go template.
|
|
|
|
## Examples
|
|
|
|
Short status of an alloc:
|
|
|
|
```
|
|
$ nomad alloc-status --short 13901f26
|
|
ID = 13901f26
|
|
Eval ID = c3c9a1db
|
|
Name = example.cache[0]
|
|
Node ID = 1f029d38
|
|
Job ID = example
|
|
Client Status = running
|
|
Created At = 29/03/16 03:04:53 UTC
|
|
|
|
==> Tasks
|
|
Name State Last Event Time
|
|
redis running Started 29/03/16 03:04:53 UTC
|
|
web running Started 29/03/16 03:04:53 UTC
|
|
```
|
|
|
|
Full status of an alloc, which shows one of the tasks dying and then being restarted:
|
|
|
|
```
|
|
$ nomad alloc-status cfe85e72
|
|
ID = cfe85e72
|
|
Eval ID = cdc88569
|
|
Name = example.cache[0]
|
|
Node ID = bfd3aa86
|
|
Job ID = example
|
|
Job Version = 1
|
|
Client Status = running
|
|
Client Description = <none>
|
|
Desired Status = run
|
|
Desired Description = <none>
|
|
Created At = 07/25/17 23:42:01 UTC
|
|
Deployment ID = dd162708
|
|
Deployment Health = unset
|
|
Canary = true
|
|
|
|
Task "redis" is "running"
|
|
Task Resources
|
|
CPU Memory Disk IOPS Addresses
|
|
4/500 MHz 6.3 MiB/256 MiB 300 MiB 0 db: 127.0.0.1:20055
|
|
|
|
Task Events:
|
|
Started At = 07/25/17 23:42:02 UTC
|
|
Finished At = N/A
|
|
Total Restarts = 0
|
|
Last Restart = N/A
|
|
|
|
Recent Events:
|
|
Time Type Description
|
|
07/25/17 23:42:02 UTC Started Task started by client
|
|
07/25/17 23:42:01 UTC Task Setup Building Task Directory
|
|
07/25/17 23:42:01 UTC Received Task received by client
|
|
|
|
Task "web" is "running"
|
|
Task Resources
|
|
CPU Memory Disk IOPS Addresses
|
|
5/500 MHz 6.3 MiB/256 MiB 300 MiB 0 db: 127.0.0.1:28235
|
|
|
|
Task Events:
|
|
Started At = 07/25/17 23:42:02 UTC
|
|
Finished At = N/A
|
|
Total Restarts = 0
|
|
Last Restart = N/A
|
|
|
|
Recent Events:
|
|
Time Type Description
|
|
07/25/17 23:42:02 UTC Started Task started by client
|
|
07/25/17 23:42:01 UTC Task Setup Building Task Directory
|
|
07/25/17 23:42:01 UTC Received Task received by client
|
|
```
|
|
|
|
Verbose status can also be accessed:
|
|
|
|
```
|
|
$ nomad alloc-status --verbose cfe85e72
|
|
ID = cfe85e72-220e-cb14-edfc-432602ac0981
|
|
Eval ID = cdc88569-bbc3-5549-855f-c0db59d4d4d3
|
|
Name = example.cache[0]
|
|
Node ID = bfd3aa86-ecbf-0f6c-b234-0f4d35792543
|
|
Job ID = example
|
|
Job Version = 1
|
|
Client Status = running
|
|
Client Description = <none>
|
|
Desired Status = run
|
|
Desired Description = <none>
|
|
Created At = 07/25/17 23:42:01 UTC
|
|
Deployment ID = dd162708-d810-a761-53b9-cfb1dc8637e8
|
|
Deployment Health = healthy
|
|
Canary = true
|
|
Evaluated Nodes = 1
|
|
Filtered Nodes = 0
|
|
Exhausted Nodes = 0
|
|
Allocation Time = 152.016µs
|
|
Failures = 0
|
|
|
|
Task "redis" is "running"
|
|
Task Resources
|
|
CPU Memory Disk IOPS Addresses
|
|
2/500 MHz 6.3 MiB/256 MiB 300 MiB 0 db: 127.0.0.1:20055
|
|
|
|
Task Events:
|
|
Started At = 07/25/17 23:42:02 UTC
|
|
Finished At = N/A
|
|
Total Restarts = 0
|
|
Last Restart = N/A
|
|
|
|
Recent Events:
|
|
Time Type Description
|
|
07/25/17 23:42:02 UTC Started Task started by client
|
|
07/25/17 23:42:01 UTC Task Setup Building Task Directory
|
|
07/25/17 23:42:01 UTC Received Task received by client
|
|
|
|
Task "web" is "running"
|
|
Task Resources
|
|
CPU Memory Disk IOPS Addresses
|
|
4/500 MHz 6.3 MiB/256 MiB 300 MiB 0 db: 127.0.0.1:28235
|
|
|
|
Task Events:
|
|
Started At = 07/25/17 23:42:02 UTC
|
|
Finished At = N/A
|
|
Total Restarts = 0
|
|
Last Restart = N/A
|
|
|
|
Recent Events:
|
|
Time Type Description
|
|
07/25/17 23:42:02 UTC Started Task started by client
|
|
07/25/17 23:42:01 UTC Task Setup Building Task Directory
|
|
07/25/17 23:42:01 UTC Received Task received by client
|
|
|
|
Placement Metrics
|
|
* Score "bfd3aa86-ecbf-0f6c-b234-0f4d35792543.binpack" = 9.142490
|
|
* Score "bfd3aa86-ecbf-0f6c-b234-0f4d35792543.job-anti-affinity" = -20.000000
|
|
```
|