nested command docs

This commit is contained in:
Alex Dadgar 2018-03-22 10:56:06 -07:00
parent ee463f1a28
commit 43eae87ed0
24 changed files with 307 additions and 212 deletions

View File

@ -0,0 +1,26 @@
---
layout: "docs"
page_title: "Commands: alloc"
sidebar_current: "docs-commands-alloc"
description: >
The alloc command is used to interact with allocations.
---
# Command: alloc
The `alloc` command is used to interact with allocations.
## Usage
Usage: `nomad alloc <subcommand> [options]`
Run `nomad alloc <subcommand> -h` for help on that subcommand. The following
subcommands are available:
* [`alloc fs`][fs] - Inspect the contents of an allocation directory
* [`alloc logs`][logs] - Streams the logs of a task
* [`alloc status`][status] - Display allocation status information and metadata
[fs]: /docs/commands/alloc/fs.html "Inspect the contents of an allocation directory"
[logs]: /docs/commands/alloc/logs.html "Streams the logs of a task"
[status]: /docs/commands/alloc/status.html "Display allocation status information and metadata"

View File

@ -1,14 +1,14 @@
---
layout: "docs"
page_title: "Commands: fs"
sidebar_current: "docs-commands-fs"
page_title: "Commands: alloc fs"
sidebar_current: "docs-commands-alloc-fs"
description: >
Introspect an allocation directory on a Nomad client
---
# Command: fs
# Command: alloc fs
The `fs` command allows a user to navigate an allocation directory on a Nomad
The `alloc fs` command allows a user to navigate an allocation directory on a Nomad
client. The following functionalities are available - `cat`, `tail`, `ls` and
`stat`.
@ -23,7 +23,7 @@ client. The following functionalities are available - `cat`, `tail`, `ls` and
## Usage
```
nomad fs [options] <allocation> <path>
nomad alloc fs [options] <allocation> <path>
```
This command accepts a single allocation ID (unless the `-job` flag is specified,
@ -61,29 +61,29 @@ end of the file.
## Examples
```
$ nomad fs eb17e557
$ nomad alloc fs eb17e557
Mode Size Modified Time Name
drwxrwxr-x 4096 28 Jan 16 05:39 UTC alloc/
drwxrwxr-x 4096 28 Jan 16 05:39 UTC redis/
-rw-rw-r-- 0 28 Jan 16 05:39 UTC redis_exit_status
$ nomad fs eb17e557 redis/local
$ nomad alloc fs eb17e557 redis/local
Mode Size Modified Time Name
-rw-rw-rw- 0 28 Jan 16 05:39 UTC redis.stderr
-rw-rw-rw- 17 28 Jan 16 05:39 UTC redis.stdout
$ nomad fs -stat eb17e557 redis/local/redis.stdout
$ nomad alloc fs -stat eb17e557 redis/local/redis.stdout
Mode Size Modified Time Name
-rw-rw-rw- 17 28 Jan 16 05:39 UTC redis.stdout
$ nomad fs eb17e557 redis/local/redis.stdout
$ nomad alloc fs eb17e557 redis/local/redis.stdout
foobar
baz
$ nomad fs -tail -f -n 3 eb17e557 redis/local/redis.stdout
$ nomad alloc fs -tail -f -n 3 eb17e557 redis/local/redis.stdout
foobar
baz
bam
@ -98,7 +98,7 @@ if no running allocations for the job are found, Nomad will use a dead
allocation.
```
nomad fs -job <job-id> <path>
nomad alloc fs -job <job-id> <path>
```

View File

@ -1,19 +1,19 @@
---
layout: "docs"
page_title: "Commands: logs"
sidebar_current: "docs-commands-logs"
page_title: "Commands: alloc logs"
sidebar_current: "docs-commands-alloc-logs"
description: >
Stream the logs of a task.
---
# Command: logs
# Command: alloc logs
The `logs` command displays the log of a given task.
The `alloc logs` command displays the log of a given task.
## Usage
```
nomad logs [options] <allocation> <task>
nomad alloc logs [options] <allocation> <task>
```
This command streams the logs of the given task in the allocation. If the
@ -48,24 +48,24 @@ end of the logs.
## Examples
```
$ nomad logs eb17e557 redis
$ nomad alloc logs eb17e557 redis
foobar
baz
bam
$ nomad logs -stderr eb17e557 redis
$ nomad alloc logs -stderr eb17e557 redis
[ERR]: foo
[ERR]: bar
$ nomad logs -job example
$ nomad alloc logs -job example
[ERR]: foo
[ERR]: bar
$ nomad logs -tail -n 2 eb17e557 redis
$ nomad alloc logs -tail -n 2 eb17e557 redis
foobar
baz
$ nomad logs -tail -f -n 3 eb17e557 redis
$ nomad alloc logs -tail -f -n 3 eb17e557 redis
foobar
baz
bam
@ -80,7 +80,7 @@ if no running allocations for the job are found, Nomad will use a dead
allocation.
```
nomad logs -job <job-id> <task>
nomad alloc logs -job <job-id> <task>
```

View File

@ -1,14 +1,14 @@
---
layout: "docs"
page_title: "Commands: alloc-status"
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
# Command: alloc status
The `alloc-status` command displays status information and metadata about an
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
@ -18,7 +18,7 @@ information about reschedule attempts.
## Usage
```
nomad alloc-status [options] <allocation>
nomad alloc status [options] <allocation>
```
An allocation ID or prefix must be provided. If there is an exact match, the
@ -41,7 +41,7 @@ allocations and information will be displayed.
Short status of an alloc:
```
$ nomad alloc-status --short 0af996ed
$ nomad alloc status --short 0af996ed
ID = 0af996ed
Eval ID = be9bde98
Name = example.cache[0]
@ -65,7 +65,7 @@ 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:
```
$ nomad alloc-status 0af996ed
$ nomad alloc status 0af996ed
ID = 0af996ed
Eval ID = be9bde98
Name = example.cache[0]
@ -107,7 +107,6 @@ CPU Memory Disk IOPS Addresses
Task Events:
Started At = 07/25/17 16:12:49 UTC
>>>>>>> alloc-status
Finished At = N/A
Total Restarts = 0
Last Restart = N/A
@ -121,7 +120,7 @@ Recent Events:
Verbose status can also be accessed:
```
$ nomad alloc-status -verbose 0af996ed
$ nomad alloc status -verbose 0af996ed
ID = 0af996ed-aff4-8ddb-a566-e55ebf8969c9
Eval ID = be9bde98-0490-1beb-ced0-012d10ddf22e
Name = example.cache[0]

View File

@ -6,10 +6,8 @@ description: >
The deployment command is used to interact with deployments.
---
# Nomad Deployment
# Command: deployment
Command: `nomad deployment`
The `deployment` command is used to interact with deployments.
## Usage

View File

@ -3,13 +3,13 @@ layout: "docs"
page_title: "Commands: eval-status"
sidebar_current: "docs-commands-eval-status"
description: >
The eval-status command is used to see the status and potential failed
The eval status command is used to see the status and potential failed
allocations of an evaluation.
---
# Command: eval-status
# Command: eval status
The `eval-status` command is used to display information about an existing
The `eval status` command is used to display information about an existing
evaluation. In the case an evaluation could not place all the requested
allocations, this command can be used to determine the failure reasons.
@ -21,7 +21,7 @@ evaluation reaches a terminal state.
## Usage
```
nomad eval-status [options] <evaluation>
nomad eval status [options] <evaluation>
```
An evaluation ID or prefix must be provided. If there is an exact match, the
@ -57,7 +57,7 @@ indicated by exit code 1.
Show the status of an evaluation that has placement failures
```
$ nomad eval-status 2ae0e6a5
$ nomad eval status 2ae0e6a5
ID = 2ae0e6a5
Status = complete
Status Description = complete
@ -79,7 +79,7 @@ Evaluation "67493a64" waiting for additional capacity to place remainder
Monitor an existing evaluation
```
$ nomad eval-status -monitor 8262bc83
$ nomad eval status -monitor 8262bc83
==> Monitoring evaluation "8262bc83"
Allocation "bd6bd0de" created: node "6f299da5", group "group1"
Evaluation status changed: "pending" -> "complete"

View File

@ -1,14 +1,14 @@
---
layout: "docs"
page_title: "Commands: init"
sidebar_current: "docs-commands-init"
page_title: "Commands: job init"
sidebar_current: "docs-commands-job-init"
description: >
Generate a skeleton jobspec template.
The job init command is used to generate a skeleton jobspec template.
---
# Command: init
# Command: job init
The `init` command creates an example [job specification][jobspec] in the
The `job init` command creates an example [job specification][jobspec] in the
current directory that demonstrates some common configurations for tasks, task
groups, runtime constraints, and resource allocation.
@ -20,7 +20,7 @@ pages to learn how to customize the template.
Generate an example job file:
```text
$ nomad init
$ nomad job init
Example job file written to example.nomad
```

View File

@ -1,22 +1,22 @@
---
layout: "docs"
page_title: "Commands: inspect"
sidebar_current: "docs-commands-inspect"
page_title: "Commands: job inspect"
sidebar_current: "docs-commands-job-inspect"
description: >
The inspect command is used to inspect a submitted job.
The job inspect command is used to inspect a submitted job.
---
# Command: inspect
# Command: job inspect
The `inspect` command is used to inspect the content of a submitted job.
The `job inspect` command is used to inspect the content of a submitted job.
## Usage
```
nomad inspect [options] <job>
nomad job inspect [options] <job>
```
The `inspect` command requires a single argument, a submitted job's name, and
The `job inspect` command requires a single argument, a submitted job's name, and
will retrieve the JSON version of the job. This JSON is valid to be submitted to
the [Job HTTP API](/api/jobs.html). This command is useful to inspect what
version of a job Nomad is running.
@ -38,7 +38,7 @@ version of a job Nomad is running.
Inspect a submitted job:
```
$ nomad inspect redis
$ nomad job inspect redis
{
"Job": {
"Region": "global",

View File

@ -1,14 +1,14 @@
---
layout: "docs"
page_title: "Commands: plan"
sidebar_current: "docs-commands-plan"
page_title: "Commands: job plan"
sidebar_current: "docs-commands-job-plan"
description: >
The plan command is used to dry-run a job update to determine its effects.
The job plan command is used to dry-run a job update to determine its effects.
---
# Command: plan
# Command: job plan
The `plan` command can be used to invoke the scheduler in a dry-run mode with
The `job plan` command can be used to invoke the scheduler in a dry-run mode with
new jobs or when updating existing jobs to determine what would happen if the
job is submitted. Job files must conform to the [job
specification](/docs/job-specification/index.html) format.
@ -16,10 +16,10 @@ specification](/docs/job-specification/index.html) format.
## Usage
```
nomad plan [options] <path>
nomad job plan [options] <path>
```
The plan command requires a single argument, specifying the path to a file
The `job plan` command requires a single argument, specifying the path to a file
containing a [HCL job specification](/docs/job-specification/index.html). This
file will be read and the resulting parsed job will be validated. If the
supplied path is "-", the job file is read from STDIN. Otherwise it is read
@ -69,8 +69,8 @@ Plan will return one of the following exit codes:
Plan a new job that has not been previously submitted:
```
$ nomad run job1.nomad
nomad plan example.nomad
$ nomad job plan job1.nomad
nomad job plan example.nomad
+ Job: "example"
+ Task Group: "cache" (1 create)
+ Task: "redis" (forces create)
@ -93,7 +93,7 @@ potentially invalid.
Increase the count of an existing without sufficient cluster capacity:
```
$ nomad plan example.nomad
$ nomad job plan example.nomad
+/- Job: "example"
+/- Task Group: "cache" (7 create, 1 in-place update)
+/- Count: "1" => "8" (forces create)
@ -119,7 +119,7 @@ potentially invalid.
Update an existing job such that it would cause a rolling update:
```
$ nomad plan example.nomad
$ nomad job plan example.nomad
+/- Job: "example"
+/- Task Group: "cache" (3 create/destroy update)
+/- Task: "redis" (forces create/destroy update)
@ -146,7 +146,7 @@ potentially invalid.
Add a task to the task group using verbose mode:
```
$ nomad plan -verbose example.nomad
$ nomad job plan -verbose example.nomad
+/- Job: "example"
+/- Task Group: "cache" (3 create/destroy update)
+ Task: "my-website" (forces create/destroy update)

View File

@ -1,24 +1,24 @@
---
layout: "docs"
page_title: "Commands: run"
sidebar_current: "docs-commands-run"
page_title: "Commands: job run"
sidebar_current: "docs-commands-job-run"
description: >
The run command is used to run a new job.
The job run command is used to run a new job.
---
# Command: run
# Command: job run
The `run` command is used to submit new jobs to Nomad or to update existing
The `job run` command is used to submit new jobs to Nomad or to update existing
jobs. Job files must conform to the [job specification](/docs/job-specification/index.html)
format.
## Usage
```
nomad run [options] <job file>
nomad job run [options] <job file>
```
The run command requires a single argument, specifying the path to a file
The `job run` command requires a single argument, specifying the path to a file
containing a valid [job specification](/docs/job-specification/index.html). This file
will be read and the job will be submitted to Nomad for scheduling. If the
supplied path is "-", the job file is read from STDIN. Otherwise it is read
@ -77,7 +77,7 @@ precedence, going from highest to lowest: the `-vault-token` flag, the
Schedule the job contained in the file `job1.nomad`, monitoring placement:
```
$ nomad run job1.nomad
$ nomad job run job1.nomad
==> Monitoring evaluation "52dee78a"
Evaluation triggered by job "example"
Evaluation within deployment: "62eb607c"
@ -90,11 +90,11 @@ $ nomad run job1.nomad
<a id="check-index"></a> Update the job using `check-index`:
```
$ nomad run -check-index 5 example.nomad
$ nomad job run -check-index 5 example.nomad
Enforcing job modify index 5: job exists with conflicting job modify index: 6
Job not updated
$ nomad run -check-index 6 example.nomad
$ nomad job run -check-index 6 example.nomad
==> Monitoring evaluation "5ef16dff"
Evaluation triggered by job "example"
Evaluation within deployment: "62eb607c"
@ -106,7 +106,7 @@ $ nomad run -check-index 6 example.nomad
Schedule the job contained in `job1.nomad` and return immediately:
```
$ nomad run -detach job1.nomad
$ nomad job run -detach job1.nomad
4947e728
```
@ -114,7 +114,7 @@ Schedule a job which cannot be successfully placed. This results in a scheduling
failure and the specifics of the placement are printed:
```
$ nomad run failing.nomad
$ nomad job run failing.nomad
==> Monitoring evaluation "2ae0e6a5"
Evaluation triggered by job "example"
Evaluation status changed: "pending" -> "complete"

View File

@ -1,23 +1,23 @@
---
layout: "docs"
page_title: "Commands: stop"
sidebar_current: "docs-commands-stop"
page_title: "Commands: job stop"
sidebar_current: "docs-commands-job-stop"
description: >
The stop command is used to stop a running job.
The job stop command is used to stop a running job.
---
# Command: stop
# Command: job stop
The `stop` command is used to stop a running job and signals the scheduler
The `job stop` command is used to stop a running job and signals the scheduler
to cancel all of the running allocations.
## Usage
```
nomad stop [options] <job>
nomad job stop [options] <job>
```
The stop command requires a single argument, specifying the job ID or prefix to
The `job stop` command requires a single argument, specifying the job ID or prefix to
cancel. If there is an exact match based on the provided job ID or prefix, then
the job will be cancelled. Otherwise, a list of matching jobs and information
will be displayed.
@ -51,7 +51,7 @@ collector.
Stop the job with ID "job1":
```
$ nomad stop job1
$ nomad job stop job1
==> Monitoring evaluation "43bfe672"
Evaluation status changed: "pending" -> "complete"
==> Evaluation "43bfe672" finished with status "complete"
@ -60,6 +60,6 @@ $ nomad stop job1
Stop the job with ID "job1" and return immediately:
```
$ nomad stop -detach job1
$ nomad job stop -detach job1
507d26cb
```

View File

@ -1,23 +1,23 @@
---
layout: "docs"
page_title: "Commands: validate"
sidebar_current: "docs-commands-validate"
page_title: "Commands: job validate"
sidebar_current: "docs-commands-job-validate"
description: >
The validate command is used to check a job specification for syntax errors and validation problems.
The job validate command is used to check a job specification for syntax errors and validation problems.
---
# Command: validate
# Command: job validate
The `validate` command is used to check a [HCL job specification](/docs/job-specification/index.html)
The `job validate` command is used to check a [HCL job specification](/docs/job-specification/index.html)
for any syntax errors or validation problems.
## Usage
```
nomad validate <file>
nomad job validate <file>
```
The validate command requires a single argument, specifying the path to a file
The `job validate` command requires a single argument, specifying the path to a file
containing a [HCL job specification](/docs/job-specification/index.html). This file
will be read and the job checked for any problems. If the
supplied path is "-", the job file is read from STDIN. Otherwise it is read
@ -33,7 +33,7 @@ of 1 indicates an error.
Validate a job with invalid syntax:
```
$ nomad validate example.nomad
$ nomad job validate example.nomad
Job validation errors:
1 error(s) occurred:
@ -45,7 +45,7 @@ Job validation errors:
Validate a job that has a configuration that causes warnings:
```
$ nomad validate example.nomad
$ nomad job validate example.nomad
Job Warnings:
1 warning(s):

View File

@ -0,0 +1,26 @@
---
layout: "docs"
page_title: "Commands: node"
sidebar_current: "docs-commands-node"
description: >
The node command is used to interact with nodes.
---
# Command: node
The `node` command is used to interact with nodes.
## Usage
Usage: `nomad node <subcommand> [options]`
Run `nomad node <subcommand> -h` for help on that subcommand. The following
subcommands are available:
* [`node config`][config] - View or modify client configuration details
* [`node drain`][drain] - Toggle drain mode on a given node
* [`node status`][status] - Display status information about nodes
[config]: /docs/commands/node/config.html "View or modify client configuration details"
[drain]: /docs/commands/node/drain.html "Toggle drain mode on a given node"
[status]: /docs/commands/node/status.html "Display status information about nodes"

View File

@ -1,21 +1,21 @@
---
layout: "docs"
page_title: "Commands: client-config"
sidebar_current: "docs-commands-client-config"
page_title: "Commands: node config"
sidebar_current: "docs-commands-node-config"
description: >
The client-config command is used to view or modify client configuration.
The node config command is used to view or modify client configuration.
---
# Command: client-config
# Command: node config
The `client-config` command is used to view or modify client configuration
The `node config` command is used to view or modify client configuration
details. This command only works on client nodes, and can be used to update
the running client configurations it supports.
## Usage
```
nomad client-config [options]
nomad node config [options]
```
The arguments behave differently depending on the flags given. See each flag's
@ -25,7 +25,7 @@ description below for specific usage information and requirements.
<%= partial "docs/commands/_general_options" %>
## Client Config Options
## Node Config Options
* `-servers`: List the client's known servers. Client nodes do not participate
in the gossip pool, and instead register with these servers periodically over
@ -45,7 +45,7 @@ description below for specific usage information and requirements.
Query the currently known servers:
```
$ nomad client-config -servers
$ nomad node config -servers
server1:4647
server2:4647
```
@ -53,5 +53,5 @@ server2:4647
Update the list of servers:
```
$ nomad client-config -update-servers server1:4647 server2:4647 server3:4647 server4
$ nomad node config -update-servers server1:4647 server2:4647 server3:4647 server4
```

View File

@ -3,22 +3,22 @@ layout: "docs"
page_title: "Commands: node-drain"
sidebar_current: "docs-commands-node-drain"
description: >
Toggle drain mode for a given node.
The node drain command is used to configure a node's drain strategy.
---
# Command: node-drain
# Command: node drain
The `node-drain` command is used to toggle drain mode on a given node. Drain
The `node drain` command is used to toggle drain mode on a given node. Drain
mode prevents any new tasks from being allocated to the node, and begins
migrating all existing allocations away.
The [node-status](/docs/commands/node-status.html) command compliments this
The [node status](/docs/commands/node/status.html) command compliments this
nicely by providing the current drain status of a given node.
## Usage
```
nomad node-drain [options] <node>
nomad node drain [options] <node>
```
A `-self` flag can be used to drain the local node. If this is not supplied, a
@ -33,7 +33,7 @@ operation is desired.
<%= partial "docs/commands/_general_options" %>
## Node Drain Options
## Drain Options
* `-enable`: Enable node drain mode.
* `-disable`: Disable node drain mode.
@ -45,11 +45,11 @@ operation is desired.
Enable drain mode on node with ID prefix "4d2ba53b":
```
$ nomad node-drain -enable 4d2ba53b
$ nomad node drain -enable 4d2ba53b
```
Enable drain mode on the local node:
```
$ nomad node-drain -enable -self
$ nomad node drain -enable -self
```

View File

@ -3,19 +3,19 @@ layout: "docs"
page_title: "Commands: node-status"
sidebar_current: "docs-commands-node-status"
description: >
Display information about nodes.
The node status command is used to display information about nodes.
---
# Command: node-status
# Command: node status
The `node-status` command is used to display information about client nodes. A
The `node status` command is used to display information about client nodes. A
node must first be registered with the servers before it will be visible in this
output.
## Usage
```
nomad node-status [options] [node]
nomad node status [options] [node]
```
If no node ID is passed, then the command will enter "list mode" and dump a
@ -32,7 +32,7 @@ information will be displayed. If running the command on a Nomad Client, the
<%= partial "docs/commands/_general_options" %>
## Node Status Options
## Status Options
* `-self`: Query the status of the local node.
@ -55,7 +55,7 @@ information will be displayed. If running the command on a Nomad Client, the
List view:
```
$ nomad node-status
$ nomad node status
ID DC Name Drain Status
a72dfba2 dc1 node1 false ready
1f3f03ea dc1 node2 false ready
@ -64,7 +64,7 @@ a72dfba2 dc1 node1 false ready
List view, with running allocations:
```
$ nomad node-status -allocs
$ nomad node status -allocs
ID DC Name Class Drain Status Running Allocs
4d2ba53b dc1 node1 <none> false ready 1
34dfba32 dc1 node2 <none> false ready 3
@ -73,7 +73,7 @@ ID DC Name Class Drain Status Running Allocs
Single-node view in short mode:
```
$ nomad node-status -short 1f3f03ea
$ nomad node status -short 1f3f03ea
ID = c754da1f
Name = nomad
Class = <none>
@ -90,7 +90,7 @@ ID Eval ID Job ID Task Group Desired Status Client Status
Full output for a single node:
```
$ nomad node-status 1f3f03ea
$ nomad node status 1f3f03ea
ID = c754da1f
Name = nomad-server01
Class = <none>
@ -119,7 +119,7 @@ ID Eval ID Job ID Task Group Desired Status Client Status
Using `-self` when on a Nomad Client:
```
$ nomad node-status -self
$ nomad node status -self
ID = c754da1f
Name = nomad-client01
Class = <none>
@ -170,7 +170,7 @@ the following:
Using `-stats` to see detailed to resource usage information on the node:
```
$ nomad node-status -stats c754da1f
$ nomad node status -stats c754da1f
ID = c754da1f
Name = nomad-client01
Class = <none>
@ -237,7 +237,7 @@ ed3665f5 8bf94335 example cache run running
To view verbose information about the node:
```
$ nomad node-status -verbose c754da1f
$ nomad node status -verbose c754da1f
ID = c754da1f-6337-b86d-47dc-2ef4c71aca14
Name = nomad
Class = <none>

View File

@ -28,12 +28,16 @@ Usage: `nomad operator <subcommand> <subcommand> [options]`
Run `nomad operator <subcommand>` with no arguments for help on that subcommand.
The following subcommands are available:
* [`autopilot get-config`][get-config] - Display the current Autopilot configuration
* [`autopilot set-config`][set-config] - Modify the current Autopilot configuration
* [`raft list-peers`][list] - Display the current Raft peer configuration
* [`raft remove-peer`][remove] - Remove a Nomad server from the Raft configuration
* [`operator autopilot get-config`][get-config] - Display the current Autopilot configuration
* [`operator autopilot set-config`][set-config] - Modify the current Autopilot configuration
* [`operator keygen`][keygen] - Generates a new encryption key
* [`operator keyring`][keyring] - Manages gossip layer encryption keys
* [`operator raft list-peers`][list] - Display the current Raft peer configuration
* [`operator raft remove-peer`][remove] - Remove a Nomad server from the Raft configuration
[get-config]: /docs/commands/operator/autopilot-get-config.html "Autopilot Get Config command"
[set-config]: /docs/commands/operator/autopilot-set-config.html "Autopilot Set Config command"
[keygen]: /docs/commands/operator/keygen.html "Generates a new encryption key"
[keyring]: /docs/commands/operator/keyring.html "Manages gossip layer encryption keys"
[list]: /docs/commands/operator/raft-list-peers.html "Raft List Peers command"
[remove]: /docs/commands/operator/raft-remove-peer.html "Raft Remove Peer command"

View File

@ -1,30 +1,29 @@
---
layout: "docs"
page_title: "Commands: keygen"
sidebar_current: "docs-commands-keygen"
page_title: "Commands: operator keygen"
sidebar_current: "docs-commands-operator-keygen"
description: >
The `keygen` command generates an encryption key that can be used for Nomad
The `operator keygen` command generates an encryption key that can be used for Nomad
server's gossip traffic encryption. The keygen command uses a
cryptographically strong pseudo-random number generator to generate the key.
---
# Command: `operator keygen`
# Command: `keygen`
The `keygen` command generates an encryption key that can be used for Nomad
The `operator keygen` command generates an encryption key that can be used for Nomad
server's gossip traffic encryption. The keygen command uses a cryptographically
strong pseudo-random number generator to generate the key.
## Usage
```
nomad keygen
nomad operator keygen
```
## Example
```
nomad keygen
nomad operator keygen
YgZOXLMhC7TtZqeghMT8+w==
```

View File

@ -1,15 +1,15 @@
---
layout: "docs"
page_title: "Commands: keyring"
sidebar_current: "docs-commands-keyring"
page_title: "Commands: operator keyring"
sidebar_current: "docs-commands-operator-keyring"
---
# Command: `keyring`
# Command: `operator keyring`
The `keyring` command is used to examine and modify the encryption keys used in
Nomad server. It is capable of distributing new encryption keys to the cluster,
retiring old encryption keys, and changing the keys used by the cluster to
encrypt messages.
The `operator keyring` command is used to examine and modify the encryption keys
used in Nomad server. It is capable of distributing new encryption keys to the
cluster, retiring old encryption keys, and changing the keys used by the cluster
to encrypt messages.
Nomad allows multiple encryption keys to be in use simultaneously. This is
intended to provide a transition state while the cluster converges. It is the
@ -27,7 +27,7 @@ will be 1.
## Usage
Usage: `nomad keyring [options]`
Usage: `nomad operator keyring [options]`
Only one actionable argument may be specified per run, including `-list`,
`-install`, `-remove`, and `-use`.
@ -47,7 +47,7 @@ The list of available flags are:
## Output
The output of the `nomad keyring -list` command consolidates information from
The output of the `nomad operator keyring -list` command consolidates information from
all the Nomad servers from all datacenters and regions to provide a simple and
easy to understand view of the cluster.

View File

@ -0,0 +1,28 @@
---
layout: "docs"
page_title: "Commands: server"
sidebar_current: "docs-commands-server"
description: >
The server command is used to interact with Nomad servers.
---
# Command: server
Command: `nomad server`
The `server` command is used to interact with servers.
## Usage
Usage: `nomad server <subcommand> [options]`
Run `nomad server <subcommand> -h` for help on that subcommand. The following
subcommands are available:
* [`server force-leave`][force-leave] - Force a server into the 'left' state
* [`server join`][join] - Join server nodes together
* [`server members`][members] - Display a list of known servers and their status
[force-leave]: /docs/commands/server/force-leave.html "Force a server into the 'left' state"
[join]: /docs/commands/server/join.html "Join server nodes together"
[members]: /docs/commands/server/members.html "Display a list of known servers and their status"

View File

@ -1,14 +1,14 @@
---
layout: "docs"
page_title: "Commands: server-force-leave"
page_title: "Commands: server force-leave"
sidebar_current: "docs-commands-server-force-leave"
description: >
Force a server into the "left" state.
The server force-leave command is used to force a server into the "left" state.
---
# Command: server-force-leave
# Command: server force-leave
The `server-force-leave` command forces a server to enter the "left" state.
The `server force-leave` command forces a server to enter the "left" state.
This can be used to eject server nodes which have failed and will not rejoin
the cluster. Note that if the server is actually still alive, it will
eventually rejoin the cluster again.
@ -16,7 +16,7 @@ eventually rejoin the cluster again.
## Usage
```
nomad server-force-leave [options] <node>
nomad server force-leave [options] <node>
```
This command expects only one argument - the node which should be forced
@ -31,5 +31,5 @@ to enter the "left" state.
Force-leave the server "node1":
```
$ nomad server-force-leave node1
$ nomad server force-leave node1
```

View File

@ -1,14 +1,14 @@
---
layout: "docs"
page_title: "Commands: server-join"
page_title: "Commands: server join"
sidebar_current: "docs-commands-server-join"
description: >
Joins the local server to one or more Nomad servers.
The server join command is used to join the local server to one or more Nomad servers.
---
# Command: server-join
# Command: server join
The `server-join` command joins the local server to one or more Nomad servers.
The `server join` command joins the local server to one or more Nomad servers.
Joining is only required for server nodes, and only needs to succeed against
one or more of the provided addresses. Once joined, the gossip layer will
handle discovery of the other server nodes in the cluster.
@ -16,7 +16,7 @@ handle discovery of the other server nodes in the cluster.
## Usage
```
nomad server-join [options] <addr> [<addr>...]
nomad server join [options] <addr> [<addr>...]
```
One or more server addresses are required. If multiple server addresses are
@ -33,6 +33,6 @@ be 1.
Join the local server to a remote server:
```
$ nomad server-join 10.0.0.8:4648
$ nomad server join 10.0.0.8:4648
Joined 1 servers successfully
```

View File

@ -3,19 +3,19 @@ layout: "docs"
page_title: "Commands: server-members"
sidebar_current: "docs-commands-server-members"
description: >
Display a list of the known server members and their status.
The server members command is used to display a list of the known server members and their status.
---
# Command: server-members
# Command: server members
The `server-members` command displays a list of the known servers in the cluster
The `server members` command displays a list of the known servers in the cluster
and their current status. Member information is provided by the gossip protocol,
which is only run on server nodes.
## Usage
```
nomad server-members [options]
nomad server members [options]
```
## General Options
@ -33,7 +33,7 @@ nomad server-members [options]
Default view:
```
$ nomad server-members
$ nomad server members
Name Addr Port Status Proto Build DC Region
node1.global 10.0.0.8 4648 alive 2 0.1.0dev dc1 global
node2.global 10.0.0.9 4648 alive 2 0.1.0dev dc1 global
@ -42,7 +42,7 @@ node2.global 10.0.0.9 4648 alive 2 0.1.0dev dc1 global
Detailed view:
```
$ nomad server-members -detailed
$ nomad server members -detailed
Name Addr Port Tags
node1 10.0.0.8 4648 bootstrap=1,build=0.1.0dev,vsn=1,vsn_max=1,dc=dc1,port=4647,region=global,role=nomad,vsn_min=1
node2 10.0.0.9 4648 bootstrap=0,build=0.1.0dev,vsn=1,vsn_max=1,dc=dc1,port=4647,region=global,role=nomad,vsn_min=1

View File

@ -214,11 +214,19 @@
<li<%= sidebar_current("docs-commands-agent-info") %>>
<a href="/docs/commands/agent-info.html">agent-info</a>
</li>
<li<%= sidebar_current("docs-commands-alloc-status") %>>
<a href="/docs/commands/alloc-status.html">alloc-status</a>
</li>
<li<%= sidebar_current("docs-commands-client-config") %>>
<a href="/docs/commands/client-config.html">client-config</a>
<li<%= sidebar_current("docs-commands-alloc") %>>
<a href="/docs/commands/alloc.html">alloc</a>
<ul class="nav">
<li<%= sidebar_current("docs-commands-alloc-fs") %>>
<a href="/docs/commands/alloc/fs.html">alloc fs</a>
</li>
<li<%= sidebar_current("docs-commands-alloc-logs") %>>
<a href="/docs/commands/alloc/logs.html">alloc logs</a>
</li>
<li<%= sidebar_current("docs-commands-alloc-status") %>>
<a href="/docs/commands/alloc/status.html">alloc status</a>
</li>
</ul>
</li>
<li<%= sidebar_current("docs-commands-deployment") %>>
<a href="/docs/commands/deployment.html">deployment</a>
@ -244,16 +252,7 @@
</ul>
</li>
<li<%= sidebar_current("docs-commands-eval-status") %>>
<a href="/docs/commands/eval-status.html">eval-status</a>
</li>
<li<%= sidebar_current("docs-commands-fs") %>>
<a href="/docs/commands/fs.html">fs</a>
</li>
<li<%= sidebar_current("docs-commands-init") %>>
<a href="/docs/commands/init.html">init</a>
</li>
<li<%= sidebar_current("docs-commands-inspect") %>>
<a href="/docs/commands/inspect.html">inspect</a>
<a href="/docs/commands/eval-status.html">eval status</a>
</li>
<li<%= sidebar_current("docs-commands-job") %>>
<a href="/docs/commands/job.html">job</a>
@ -267,26 +266,35 @@
<li<%= sidebar_current("docs-commands-job-history") %>>
<a href="/docs/commands/job/history.html">job history</a>
</li>
<li<%= sidebar_current("docs-commands-job-init") %>>
<a href="/docs/commands/job/init.html">job init</a>
</li>
<li<%= sidebar_current("docs-commands-job-inspect") %>>
<a href="/docs/commands/job/inspect.html">job inspect</a>
</li>
<li<%= sidebar_current("docs-commands-job-plan") %>>
<a href="/docs/commands/job/plan.html">job plan</a>
</li>
<li<%= sidebar_current("docs-commands-job-promote") %>>
<a href="/docs/commands/job/promote.html">job promote</a>
</li>
<li<%= sidebar_current("docs-commands-job-revert") %>>
<a href="/docs/commands/job/revert.html">job revert</a>
</li>
<li<%= sidebar_current("docs-commands-job-run") %>>
<a href="/docs/commands/job/run.html">job run</a>
</li>
<li<%= sidebar_current("docs-commands-job-status") %>>
<a href="/docs/commands/job/status.html">job status</a>
</li>
<li<%= sidebar_current("docs-commands-job-stop") %>>
<a href="/docs/commands/job/stop.html">job stop</a>
</li>
<li<%= sidebar_current("docs-commands-job-validate") %>>
<a href="/docs/commands/job/validate.html">job validate</a>
</li>
</ul>
</li>
<li<%= sidebar_current("docs-commands-keygen") %>>
<a href="/docs/commands/keygen.html">keygen</a>
</li>
<li<%= sidebar_current("docs-commands-keyring") %>>
<a href="/docs/commands/keyring.html">keyring</a>
</li>
<li<%= sidebar_current("docs-commands-logs") %>>
<a href="/docs/commands/logs.html">logs</a>
</li>
<li<%= sidebar_current("docs-commands-namespace") %>>
<a href="/docs/commands/namespace.html">namespace</a>
<ul class="nav">
@ -307,11 +315,19 @@
</li>
</ul>
</li>
<li<%= sidebar_current("docs-commands-node-drain") %>>
<a href="/docs/commands/node-drain.html">node-drain</a>
</li>
<li<%= sidebar_current("docs-commands-node-status") %>>
<a href="/docs/commands/node-status.html">node-status</a>
<li<%= sidebar_current("docs-commands-node") %>>
<a href="/docs/commands/node.html">node</a>
<ul class="nav">
<li<%= sidebar_current("docs-commands-node-config") %>>
<a href="/docs/commands/node/config.html">node config</a>
</li>
<li<%= sidebar_current("docs-commands-node-drain") %>>
<a href="/docs/commands/node/drain.html">node drain</a>
</li>
<li<%= sidebar_current("docs-commands-node-status") %>>
<a href="/docs/commands/node/status.html">node status</a>
</li>
</ul>
</li>
<li<%= sidebar_current("docs-commands-operator") %>>
<a href="/docs/commands/operator.html">operator</a>
@ -322,6 +338,12 @@
<li<%= sidebar_current("docs-commands-operator-autopilot-set-config") %>>
<a href="/docs/commands/operator/autopilot-set-config.html">autopilot set-config</a>
</li>
<li<%= sidebar_current("docs-commands-operator-keygen") %>>
<a href="/docs/commands/operator/keygen.html">keygen</a>
</li>
<li<%= sidebar_current("docs-commands-operator-keyring") %>>
<a href="/docs/commands/operator/keyring.html">keyring</a>
</li>
<li<%= sidebar_current("docs-commands-operator-raft-list-peers") %>>
<a href="/docs/commands/operator/raft-list-peers.html">raft list-peers</a>
</li>
@ -330,9 +352,6 @@
</li>
</ul>
</li>
<li<%= sidebar_current("docs-commands-plan") %>>
<a href="/docs/commands/plan.html">plan</a>
</li>
<li<%= sidebar_current("docs-commands-quota") %>>
<a href="/docs/commands/quota.html">quota</a>
<ul class="nav">
@ -356,9 +375,6 @@
</li>
</ul>
</li>
<li<%= sidebar_current("docs-commands-run") %>>
<a href="/docs/commands/run.html">run</a>
</li>
<li<%= sidebar_current("docs-commands-sentinel") %>>
<a href="/docs/commands/sentinel.html">sentinel</a>
<ul class="nav">
@ -376,27 +392,26 @@
</li>
</ul>
</li>
<li<%= sidebar_current("docs-commands-server-force-leave") %>>
<a href="/docs/commands/server-force-leave.html">server-force-leave</a>
</li>
<li<%= sidebar_current("docs-commands-server-join") %>>
<a href="/docs/commands/server-join.html">server-join</a>
</li>
<li<%= sidebar_current("docs-commands-server-members") %>>
<a href="/docs/commands/server-members.html">server-members</a>
<li<%= sidebar_current("docs-commands-server") %>>
<a href="/docs/commands/server.html">server</a>
<ul class="nav">
<li<%= sidebar_current("docs-commands-server-force-leave") %>>
<a href="/docs/commands/server/force-leave.html">server force-leave</a>
</li>
<li<%= sidebar_current("docs-commands-server-join") %>>
<a href="/docs/commands/server/join.html">server join</a>
</li>
<li<%= sidebar_current("docs-commands-server-members") %>>
<a href="/docs/commands/server/members.html">server members</a>
</li>
</ul>
</li>
<li<%= sidebar_current("docs-commands-status") %>>
<a href="/docs/commands/status.html">status</a>
</li>
<li<%= sidebar_current("docs-commands-stop") %>>
<a href="/docs/commands/stop.html">stop</a>
</li>
<li<%= sidebar_current("docs-commands-ui") %>>
<a href="/docs/commands/ui.html">ui</a>
</li>
<li<%= sidebar_current("docs-commands-validate") %>>
<a href="/docs/commands/validate.html">validate</a>
</li>
<li<%= sidebar_current("docs-commands-version") %>>
<a href="/docs/commands/version.html">version</a>
</li>