Skip to content

Commit

Permalink
docs: nomad eval list
Browse files Browse the repository at this point in the history
Also includes note that `nomad eval status -json` is deprecated and
will be replaced with a single evaluation view in a future version of
Nomad.
  • Loading branch information
tgross committed Dec 14, 2021
1 parent 4011e80 commit ab1af24
Show file tree
Hide file tree
Showing 6 changed files with 108 additions and 3 deletions.
23 changes: 23 additions & 0 deletions website/content/docs/commands/eval/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
layout: docs
page_title: 'Commands: eval'
description: |
The eval command is used to interact with evals.
---

# Command: eval

The `eval` command is used to interact with evals.

## Usage

Usage: `nomad eval <subcommand> [options]`

Run `nomad eval <subcommand> -h` for help on that subcommand. The following
subcommands are available:

- [`eval list`][list] - List all evals
- [`eval status`][status] - Display the status of a eval

[list]: /docs/commands/eval/list 'List all evals'
[status]: /docs/commands/eval/status 'Display the status of a eval'
51 changes: 51 additions & 0 deletions website/content/docs/commands/eval/list.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
layout: docs
page_title: 'Commands: eval list'
description: |
The eval list command is used to list evaluations.
---

# Command: eval list

The `eval list` command is used list all evaluations.

## Usage

```plaintext
nomad eval list [options]
```

The `eval list` command requires no arguments.

When ACLs are enabled, this command requires a token with the 'read-job'
capability for the requested namespace.

## General Options

@include 'general_options.mdx'

## List Options

- `-verbose`: Show full information.
- `-per_page`: How many results to show per page.
- `-page_token`: Where to start pagination.
- `-job`: Only show evaluations for this job ID.
- `-status`: Only show evaluations with this status.
- `-json`: Output the evaluation in its JSON format.
- `-t`: Format and display evaluation using a Go template.

## Examples

List all tracked evaluations:

```shell-session
$ nomad eval list -per_page 3 -status complete
ID Priority Triggered By Job ID Status Placement Failures
456e37aa 50 deployment-watcher example complete false
1a1eafe6 50 alloc-stop example complete false
3411e37b 50 job-register example complete false
Results have been paginated. To get the next page run:
nomad eval list -page_token 9ecffbba-73be-d909-5d7e-ac2694c10e0c
```
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,10 @@ indicated by exit code 1.

- `-monitor`: Monitor an outstanding evaluation
- `-verbose`: Show full information.
- `-json` : Output the evaluation in its JSON format.
- `-json` : Output a list of all evaluations in JSON format. This
behavior is deprecated and has been replaced by `nomad eval list
-json`. In Nomad 1.4.0 the behavior of this option will change to
output only the selected evaluation in JSON.
- `-t` : Format and display evaluation using a Go template.

## Examples
Expand Down
10 changes: 10 additions & 0 deletions website/content/docs/upgrade/upgrade-specific.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,16 @@ upgrade. However, specific versions of Nomad may have more details provided for
their upgrades as a result of new features or changed behavior. This page is
used to document those details separately from the standard upgrade flow.

## Nomad 1.2.4

#### `nomad eval status -json` deprecated

Nomad 1.2.4 includes a new `nomad eval list` command that has the
option to display the results in JSON format with the `-json`
flag. This replaces the existing `nomad eval status -json` option. In
Nomad 1.4.0, `nomad eval status -json` will be changed to display only
the selected evaluation in JSON format.

## Nomad 1.2.2

### Panic on node class filtering for system and sysbatch jobs fixed
Expand Down
17 changes: 15 additions & 2 deletions website/data/docs-nav-data.json
Original file line number Diff line number Diff line change
Expand Up @@ -353,8 +353,21 @@
]
},
{
"title": "eval status",
"path": "commands/eval-status"
"title": "eval",
"routes": [
{
"title": "Overview",
"path": "commands/eval"
},
{
"title": "list",
"path": "commands/eval/list"
},
{
"title": "status",
"path": "commands/eval/status"
}
]
},
{
"title": "job",
Expand Down
5 changes: 5 additions & 0 deletions website/redirects.js
Original file line number Diff line number Diff line change
Expand Up @@ -589,6 +589,11 @@ module.exports = [
destination: '/docs/commands/alloc/status',
permanent: true,
},
{
source: '/docs/commands/eval-status',
destination: '/docs/commands/eval/status',
permanent: true,
},
{
source: '/docs/commands/fs',
destination: '/docs/commands/alloc/fs',
Expand Down

0 comments on commit ab1af24

Please sign in to comment.