Skip to content

Commit

Permalink
Fix old references
Browse files Browse the repository at this point in the history
  • Loading branch information
dadgar committed Mar 22, 2018
1 parent 1c2cfdc commit f5ebe7d
Show file tree
Hide file tree
Showing 69 changed files with 282 additions and 255 deletions.
2 changes: 1 addition & 1 deletion command/job_plan.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import (
const (
jobModifyIndexHelp = `To submit the job with version verification run:
nomad run -check-index %d %s
nomad job run -check-index %d %s
When running the job with the check-index flag, the job will only be run if the
server side version matches the job modify index returned. If the index has
Expand Down
2 changes: 1 addition & 1 deletion website/source/api/json-jobs.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This guide covers the JSON syntax for submitting jobs to Nomad. A useful command
for generating valid JSON versions of HCL jobs is:

```shell
$ nomad run -output my-job.nomad
$ nomad job run -output my-job.nomad
```

## Syntax
Expand Down
5 changes: 3 additions & 2 deletions website/source/docs/agent/encryption.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,11 @@ starting the Nomad server. The key can be set via the
of this setting is a server configuration file containing the encryption key.

The key must be 16 bytes, base64 encoded. As a convenience, Nomad provides the
[`nomad keygen`](/docs/commands/keygen.html) command to generate a cryptographically suitable key:
[`nomad operator keygen`](/docs/commands/operator/keygen.html) command to
generate a cryptographically suitable key:

```sh
$ nomad keygen
$ nomad operator keygen
cg8StVXbQJ0gPvMd9o7yrg==
```

Expand Down
4 changes: 2 additions & 2 deletions website/source/docs/agent/index.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ leave the [consensus](/docs/internals/consensus.html) peer set.
It is especially important that a server node be allowed to leave gracefully
so that there will be a minimal impact on availability as the server leaves
the consensus peer set. If a server does not gracefully leave, and will not
return into service, the [`server-force-leave` command](/docs/commands/server-force-leave.html)
return into service, the [`server force-leave` command](/docs/commands/server/force-leave.html)
should be used to eject it from the consensus peer set.

## Lifecycle
Expand Down Expand Up @@ -125,7 +125,7 @@ participate in a [gossip protocol](/docs/internals/gossip.html) both to cluster
within a region and to support multi-region configurations. When a server is
first started, it does not know the address of other servers in the cluster.
To discover its peers, it must _join_ the cluster. This is done with the
[`server-join` command](/docs/commands/server-join.html) or by providing the
[`server join` command](/docs/commands/server/join.html) or by providing the
proper configuration on start. Once a node joins, this information is gossiped
to the entire cluster, meaning all nodes will eventually be aware of each other.

Expand Down
4 changes: 1 addition & 3 deletions website/source/docs/commands/acl.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,7 @@ description: >
The acl command is used to interact with ACL policies and tokens.
---

# Nomad ACL

Command: `nomad acl`
# Command: acl

The `acl` command is used to interact with ACL policies and tokens.

Expand Down
2 changes: 1 addition & 1 deletion website/source/docs/commands/deployment/fail.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ prefix.

* `-detach`: Return immediately instead of monitoring. A new evaluation ID
will be output, which can be used to examine the evaluation using the
[eval-status](/docs/commands/eval-status.html) command.
[eval status](/docs/commands/eval-status.html) command.

* `-verbose`: Show full information.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ select particular groups to promote.

* `-detach`: Return immediately instead of monitoring. A new evaluation ID
will be output, which can be used to examine the evaluation using the
[eval-status](/docs/commands/eval-status.html) command
[eval status](/docs/commands/eval-status.html) command

* `-verbose`: Show full information.

Expand Down
2 changes: 1 addition & 1 deletion website/source/docs/commands/deployment/resume.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ prefix.

* `-detach`: Return immediately instead of monitoring. A new evaluation ID
will be output, which can be used to examine the evaluation using the
[eval-status](/docs/commands/eval-status.html) command
[eval status](/docs/commands/eval-status.html) command

* `-verbose`: Show full information.

Expand Down
2 changes: 1 addition & 1 deletion website/source/docs/commands/eval-status.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: "docs"
page_title: "Commands: eval-status"
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
Expand Down
4 changes: 2 additions & 2 deletions website/source/docs/commands/index.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,10 @@ the CLI is most commonly used to manipulate or query jobs, you can assume that
any given command is working in that context unless the command name implies
otherwise.

For example, the `nomad run` command is used to run a new job, the `nomad
For example, the `nomad job run` command is used to run a new job, the `nomad
status` command queries information about existing jobs, etc. Conversely,
commands with a prefix in their name likely operate in a different context.
Examples include the `nomad agent-info` or `nomad node-drain` commands,
Examples include the `nomad agent-info` or `nomad node drain` commands,
which operate in the agent or node contexts respectively.

### Remote Usage
Expand Down
4 changes: 1 addition & 3 deletions website/source/docs/commands/job.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,8 @@ description: >
The job command is used to interact with jobs.
---

# Nomad Job
# Command: job

Command: `nomad job`

The `job` command is used to interact with jobs.

## Usage
Expand Down
2 changes: 1 addition & 1 deletion website/source/docs/commands/job/dispatch.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ client connection issues or internal errors, are indicated by exit code 1.

* `-detach`: Return immediately instead of monitoring. A new evaluation ID
will be output, which can be used to examine the evaluation using the
[eval-status](/docs/commands/eval-status.html) command
[eval status](/docs/commands/eval-status.html) command

* `-verbose`: Show full information.

Expand Down
12 changes: 6 additions & 6 deletions website/source/docs/commands/job/plan.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ changes to the cluster but gives insight into whether the job could be run
successfully and how it would affect existing allocations.

A job modify index is returned with the plan. This value can be used when
submitting the job using [`nomad run
-check-index`](/docs/commands/run.html#check-index), which will check that the
submitting the job using [`nomad job run
-check-index`](/docs/commands/job/run.html#check-index), which will check that the
job was not modified between the plan and run command before invoking the
scheduler. This ensures the job has not been modified since the plan.

Expand Down Expand Up @@ -82,7 +82,7 @@ Scheduler dry-run:
Job Modify Index: 0
To submit the job with version verification run:

nomad run -check-index 0 example.nomad
nomad job run -check-index 0 example.nomad

When running the job with the check-index flag, the job will only be run if the
server side version matches the job modify index returned. If the index has
Expand All @@ -109,7 +109,7 @@ Scheduler dry-run:
Job Modify Index: 15
To submit the job with version verification run:

nomad run -check-index 15 example.nomad
nomad job run -check-index 15 example.nomad

When running the job with the check-index flag, the job will only be run if the
server side version matches the job modify index returned. If the index has
Expand All @@ -136,7 +136,7 @@ Scheduler dry-run:
Job Modify Index: 7
To submit the job with version verification run:

nomad run -check-index 7 example.nomad
nomad job run -check-index 7 example.nomad

When running the job with the check-index flag, the job will only be run if the
server side version matches the job modify index returned. If the index has
Expand Down Expand Up @@ -195,7 +195,7 @@ Scheduler dry-run:
Job Modify Index: 7
To submit the job with version verification run:

nomad run -check-index 7 example.nomad
nomad job run -check-index 7 example.nomad

When running the job with the check-index flag, the job will only be run if the
server side version matches the job modify index returned. If the index has
Expand Down
2 changes: 1 addition & 1 deletion website/source/docs/commands/job/promote.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ select particular groups to promote.

* `-detach`: Return immediately instead of monitoring. A new evaluation ID
will be output, which can be used to examine the evaluation using the
[eval-status](/docs/commands/eval-status.html) command
[eval status](/docs/commands/eval-status.html) command

* `-verbose`: Show full information.

Expand Down
2 changes: 1 addition & 1 deletion website/source/docs/commands/job/revert.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ to revert to.

* `-detach`: Return immediately instead of monitoring. A new evaluation ID
will be output, which can be used to examine the evaluation using the
[eval-status](/docs/commands/eval-status.html) command
[eval status](/docs/commands/eval-status.html) command

* `-verbose`: Show full information.

Expand Down
4 changes: 2 additions & 2 deletions website/source/docs/commands/job/run.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,11 @@ precedence, going from highest to lowest: the `-vault-token` flag, the
If a check-index value of zero is passed, the job is only registered if it does
not yet exist. If a non-zero value is passed, it ensures that the job is being
updated from a known state. The use of this flag is most common in conjunction
with [plan command](/docs/commands/plan.html).
with [`job plan` command](/docs/commands/job/plan.html).

* `-detach`: Return immediately instead of monitoring. A new evaluation ID
will be output, which can be used to examine the evaluation using the
[eval-status](/docs/commands/eval-status.html) command
[eval status](/docs/commands/eval-status.html) command

* `-output`: Output the JSON that would be submitted to the HTTP API without
submitting the job.
Expand Down
2 changes: 1 addition & 1 deletion website/source/docs/commands/job/stop.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ the request. It is safe to exit the monitor early using ctrl+c.
* `-detach`: Return immediately instead of entering monitor mode. After the
deregister command is submitted, a new evaluation ID is printed to the screen,
which can be used to examine the evaluation using the
[eval-status](/docs/commands/eval-status.html) command.
[eval status](/docs/commands/eval-status.html) command.

* `-verbose`: Show full information.

Expand Down
7 changes: 4 additions & 3 deletions website/source/docs/commands/namespace.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,13 @@ description: >
The namespace command is used to interact with namespaces.
---

# Nomad Namespace

Command: `nomad namespace`
# Command: namespace

The `namespace` command is used to interact with namespaces.

~> Namespace commands are new in Nomad 0.7 and are only available with Nomad
Enterprise.

## Usage

Usage: `nomad namespace <subcommand> [options]`
Expand Down
3 changes: 3 additions & 0 deletions website/source/docs/commands/namespace/inspect.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ description: >
The `namespace inspect` command is used to view raw information about a particular
namespace.

~> Namespace commands are new in Nomad 0.7 and are only available with Nomad
Enterprise.

## Usage

```
Expand Down
3 changes: 3 additions & 0 deletions website/source/docs/commands/namespace/status.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ description: >
The `namespace status` command is used to view the status of a particular
namespace.

~> Namespace commands are new in Nomad 0.7 and are only available with Nomad
Enterprise.

## Usage

```
Expand Down
2 changes: 1 addition & 1 deletion website/source/docs/commands/node/drain.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: "docs"
page_title: "Commands: node-drain"
page_title: "Commands: node drain"
sidebar_current: "docs-commands-node-drain"
description: >
The node drain command is used to configure a node's drain strategy.
Expand Down
2 changes: 1 addition & 1 deletion website/source/docs/commands/node/status.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: "docs"
page_title: "Commands: node-status"
page_title: "Commands: node status"
sidebar_current: "docs-commands-node-status"
description: >
The node status command is used to display information about nodes.
Expand Down
4 changes: 1 addition & 3 deletions website/source/docs/commands/operator.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,7 @@ description: >
The operator command provides cluster-level tools for Nomad operators.
---

# Nomad Operator

Command: `nomad operator`
# Command: operator

The `operator` command provides cluster-level tools for Nomad operators, such
as interacting with the Raft subsystem. This was added in Nomad 0.5.5.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: >
Display the current Autopilot configuration.
---

# Command: `operator autopilot get-config`
# Command: operator autopilot get-config

The Autopilot operator command is used to view the current Autopilot configuration. See the
[Autopilot Guide](/guides/cluster/autopilot.html) for more information about Autopilot.
Expand Down Expand Up @@ -60,4 +60,4 @@ UpgradeMigrationTag = ""

- `UpgradeVersionTag` - Controls the node-meta key to use for
version info when performing upgrade migrations. If left blank, the Nomad
version will be used.
version will be used.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: >
Modify the current Autopilot configuration.
---

# Command: `operator autopilot set-config`
# Command: operator autopilot set-config

The Autopilot operator command is used to set the current Autopilot configuration. See the
[Autopilot Guide](/guides/cluster/autopilot.html) for more information about Autopilot.
Expand Down
2 changes: 1 addition & 1 deletion website/source/docs/commands/operator/keygen.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: >
cryptographically strong pseudo-random number generator to generate the key.
---

# Command: `operator keygen`
# Command: operator keygen

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
Expand Down
2 changes: 1 addition & 1 deletion website/source/docs/commands/operator/keyring.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ page_title: "Commands: operator keyring"
sidebar_current: "docs-commands-operator-keyring"
---

# Command: `operator keyring`
# Command: operator keyring

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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: >
Display the current Raft peer configuration.
---

# Command: `operator raft list-peers`
# Command: operator raft list-peers

The Raft list-peers command is used to display the current Raft peer
configuration.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@ description: >
Remove a Nomad server from the Raft configuration.
---

# Command: `operator raft remove-peer`
# Command: operator raft remove-peer

Remove the Nomad server with given address from the Raft configuration.

There are rare cases where a peer may be left behind in the Raft quorum even
though the server is no longer present and known to the cluster. This command
can be used to remove the failed server so that it is no longer affects the Raft
quorum. If the server still shows in the output of the [`nomad
server-members`](/docs/commands/server-members.html) command, it is preferable
server members`](/docs/commands/server/members.html) command, it is preferable
to clean up by simply running [`nomad
server-force-leave`](/docs/commands/server-force-leave.html) instead of this
server force-leave`](/docs/commands/server/force-leave.html) instead of this
command.

See the [Outage Recovery](/guides/outage.html) guide for some examples of how
Expand Down
7 changes: 4 additions & 3 deletions website/source/docs/commands/quota.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,13 @@ description: >
The quota command is used to interact with quota specifications.
---

# Nomad Quota

Command: `nomad quota`
# Command: quota

The `quota` command is used to interact with quota specifications.

~> Quota commands are new in Nomad 0.7 and are only available with Nomad
Enterprise.

## Usage

Usage: `nomad quota <subcommand> [options]`
Expand Down
3 changes: 3 additions & 0 deletions website/source/docs/commands/quota/apply.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ description: >

The `quota apply` command is used to create or update quota specifications.

~> Quota commands are new in Nomad 0.7 and are only available with Nomad
Enterprise.

## Usage

```
Expand Down
3 changes: 3 additions & 0 deletions website/source/docs/commands/quota/delete.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ description: >

The `quota delete` command is used to delete an existing quota specification.

~> Quota commands are new in Nomad 0.7 and are only available with Nomad
Enterprise.

## Usage

```
Expand Down
Loading

0 comments on commit f5ebe7d

Please sign in to comment.