open-nomad/website/source/docs/commands/eval-status.html.md.erb

88 lines
2.7 KiB
Plaintext
Raw Normal View History

2016-05-26 01:52:14 +00:00
---
layout: "docs"
2018-03-22 20:39:18 +00:00
page_title: "Commands: eval status"
2016-05-26 01:52:14 +00:00
sidebar_current: "docs-commands-eval-status"
description: >
2018-03-22 17:56:06 +00:00
The eval status command is used to see the status and potential failed
2016-05-26 01:52:14 +00:00
allocations of an evaluation.
---
2018-03-22 17:56:06 +00:00
# Command: eval status
2016-05-26 01:52:14 +00:00
2018-03-22 17:56:06 +00:00
The `eval status` command is used to display information about an existing
2016-05-26 01:52:14 +00:00
evaluation. In the case an evaluation could not place all the requested
allocations, this command can be used to determine the failure reasons.
Optionally, it can also be invoked in a monitor mode to track an outstanding
evaluation. In this mode, logs will be output describing state changes to the
2016-05-26 01:52:14 +00:00
evaluation or its associated allocations. The monitor will exit when the
evaluation reaches a terminal state.
## Usage
```
2018-03-22 17:56:06 +00:00
nomad eval status [options] <evaluation>
2016-05-26 01:52:14 +00:00
```
An evaluation ID or prefix must be provided. If there is an exact match, the
the status will be shown. Otherwise, a list of matching evaluations and
information will be displayed.
If the `-monitor` flag is passed, an interactive monitoring session will be
started in the terminal. It is safe to exit the monitor at any time using
ctrl+c. The command will exit when the given evaluation reaches a terminal
state (completed or failed). Exit code 0 is returned on successful
evaluation, and if there are no scheduling problems. If there are
job placement issues encountered (unsatisfiable constraints,
resource exhaustion, etc), then the exit code will be 2. Any other
errors, including client connection issues or internal errors, are
indicated by exit code 1.
## General Options
2016-10-28 00:46:20 +00:00
<%= partial "docs/commands/_general_options" %>
2016-05-26 01:52:14 +00:00
2016-08-09 13:56:26 +00:00
## Eval Status Options
2016-05-26 01:52:14 +00:00
* `-monitor`: Monitor an outstanding evaluation
* `-verbose`: Show full information.
2016-08-06 09:54:30 +00:00
* `-json` : Output the evaluation in its JSON format.
2016-08-05 17:51:22 +00:00
2016-08-06 09:54:30 +00:00
* `-t` : Format and display evaluation using a Go template.
2016-08-05 17:51:22 +00:00
2016-05-26 01:52:14 +00:00
## Examples
Show the status of an evaluation that has placement failures
```
2018-03-22 17:56:06 +00:00
$ nomad eval status 2ae0e6a5
2016-05-26 01:52:14 +00:00
ID = 2ae0e6a5
Status = complete
Status Description = complete
Type = service
TriggeredBy = job-register
Job ID = example
Priority = 50
Placement Failures = true
==> Failed Placements
Task Group "cache" (failed to place 1 allocation):
* Class "foo" filtered 1 nodes
* Constraint "${attr.kernel.name} = windows" filtered 1 nodes
Evaluation "67493a64" waiting for additional capacity to place remainder
```
Monitor an existing evaluation
```
2018-03-22 17:56:06 +00:00
$ nomad eval status -monitor 8262bc83
2016-05-26 01:52:14 +00:00
==> Monitoring evaluation "8262bc83"
Allocation "bd6bd0de" created: node "6f299da5", group "group1"
Evaluation status changed: "pending" -> "complete"
==> Evaluation "8262bc83" finished with status "complete"
```