luxolus/open-nomad
2
0
Fork 0
Code Issues 1 Pull requests Packages Releases Wiki Activity

docs: remove -namespace option from commands when not applicable

Browse source
This commit is contained in:
Tim Gross 2020-11-19 13:02:48 -05:00
parent d67afa2e21
commit c1a3496a55
44 changed files with 78 additions and 43 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
website/pages/docs/commands/acl/bootstrap.mdx
View file

@ -20,7 +20,7 @@ The `acl bootstrap` command requires no arguments.
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Examples

2
website/pages/docs/commands/acl/policy-apply.mdx
View file

@ -21,7 +21,7 @@ to file. The policy can be read from stdin by setting the path to "-".
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Apply Options

2
website/pages/docs/commands/acl/policy-delete.mdx
View file

@ -20,7 +20,7 @@ The `acl policy delete` command requires the policy name as an argument.
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Examples

2
website/pages/docs/commands/acl/policy-info.mdx
View file

@ -22,7 +22,7 @@ The `acl policy info` command requires the policy name.
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Examples

2
website/pages/docs/commands/acl/policy-list.mdx
View file

@ -18,7 +18,7 @@ nomad acl policy list
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## List Options

2
website/pages/docs/commands/acl/token-create.mdx
View file

@ -20,7 +20,7 @@ The `acl token create` command requires no arguments.
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Create Options

2
website/pages/docs/commands/acl/token-delete.mdx
View file

@ -20,7 +20,7 @@ The `acl token delete` command requires an existing token's AccessorID.
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Examples

2
website/pages/docs/commands/acl/token-info.mdx
View file

@ -21,7 +21,7 @@ The `acl token info` command requires an existing token's AccessorID.
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Examples

2
website/pages/docs/commands/acl/token-list.mdx
View file

@ -18,7 +18,7 @@ nomad acl token list
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## List Options

2
website/pages/docs/commands/acl/token-self.mdx
View file

@ -20,7 +20,7 @@ nomad acl token self
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Examples

2
website/pages/docs/commands/acl/token-update.mdx
View file

@ -20,7 +20,7 @@ The `acl token update` command requires an existing token's accessor ID.
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Create Options

2
website/pages/docs/commands/agent-info.mdx
View file

@ -20,7 +20,7 @@ nomad agent-info [options]
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Output

2
website/pages/docs/commands/license/get.mdx
View file

@ -21,7 +21,7 @@ nomad license get [options]
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Examples

2
website/pages/docs/commands/license/put.mdx
View file

@ -21,7 +21,7 @@ nomad license put
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Put Options

2
website/pages/docs/commands/monitor.mdx
View file

@ -27,7 +27,7 @@ The monitor command also allows you to specify a single client node id to follow
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Monitor Options

2
website/pages/docs/commands/namespace/apply.mdx
View file

@ -24,7 +24,7 @@ or updated.
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Apply Options

2
website/pages/docs/commands/namespace/delete.mdx
View file

@ -23,7 +23,7 @@ The `namespace delete` command requires the name of the namespace to be deleted.
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Examples

2
website/pages/docs/commands/namespace/inspect.mdx
View file

@ -23,7 +23,7 @@ nomad namespace inspect [options] <namespace_name>
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Inspect Options

2
website/pages/docs/commands/namespace/list.mdx
View file

@ -23,7 +23,7 @@ The `namespace list` command requires no arguments.
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## List Options

2
website/pages/docs/commands/namespace/status.mdx
View file

@ -23,7 +23,7 @@ nomad namespace status [options] <namespace_name>
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Examples

2
website/pages/docs/commands/node/config.mdx
View file

@ -23,7 +23,7 @@ description below for specific usage information and requirements.
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Node Config Options

2
website/pages/docs/commands/node/drain.mdx
View file

@ -46,7 +46,7 @@ operation is desired.
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Drain Options

2
website/pages/docs/commands/node/eligibility.mdx
View file

@ -42,7 +42,7 @@ operation is desired.
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Eligibility Options

2
website/pages/docs/commands/node/status.mdx
View file

@ -30,7 +30,7 @@ information will be displayed. If running the command on a Nomad Client, the
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Status Options

2
website/pages/docs/commands/operator/autopilot-get-config.mdx
View file

@ -19,7 +19,7 @@ nomad operator autopilot get-config [options]
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
The output looks like this:

2
website/pages/docs/commands/operator/autopilot-set-config.mdx
View file

@ -19,7 +19,7 @@ nomad operator autopilot set-config [options]
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Set Config Options

2
website/pages/docs/commands/operator/debug.mdx
View file

@ -37,7 +37,7 @@ configured.
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Debug Options

2
website/pages/docs/commands/operator/raft-list-peers.mdx
View file

@ -23,7 +23,7 @@ nomad operator raft list-peers [options]
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## List Peers Options

2
website/pages/docs/commands/operator/raft-remove-peer.mdx
View file

@ -29,7 +29,7 @@ nomad operator raft remove-peer [options]
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Remove Peer Options

2
website/pages/docs/commands/operator/snapshot-agent.mdx
View file

@ -101,7 +101,7 @@ nomad operator snapshot agent [options] <config_file>
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Snapshot agent Options

2
website/pages/docs/commands/operator/snapshot-restore.mdx
View file

@ -33,6 +33,6 @@ nomad operator snapshot restore [options] <file>
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
[outage recovery]: https://learn.hashicorp.com/tutorials/nomad/outage-recovery

2
website/pages/docs/commands/operator/snapshot-save.mdx
View file

@ -36,7 +36,7 @@ nomad operator snapshot save [options] <file>
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Snapshot Save Options

2
website/pages/docs/commands/plugin/status.mdx
View file

@ -27,7 +27,7 @@ of the most useful status fields for each.
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Status Options

2
website/pages/docs/commands/sentinel/apply.mdx
View file

@ -27,7 +27,7 @@ file name.
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Apply Options

2
website/pages/docs/commands/sentinel/delete.mdx
View file

@ -23,7 +23,7 @@ The `sentinel delete` command requires a single argument, the policy name.
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Examples

2
website/pages/docs/commands/sentinel/list.mdx
View file

@ -24,7 +24,7 @@ The `sentinel list` command requires no arguments.
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Examples

2
website/pages/docs/commands/sentinel/read.mdx
View file

@ -23,7 +23,7 @@ The `sentinel read` command requires a single argument, the policy name.
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Read Options

2
website/pages/docs/commands/server/force-leave.mdx
View file

@ -25,7 +25,7 @@ to enter the "left" state.
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Examples

2
website/pages/docs/commands/server/join.mdx
View file

@ -27,7 +27,7 @@ be 1.
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Examples

2
website/pages/docs/commands/server/members.mdx
View file

@ -21,7 +21,7 @@ nomad server members [options]
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Server Members Options

2
website/pages/docs/commands/system/gc.mdx
View file

@ -19,7 +19,7 @@ nomad system gc [options]
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Examples

2
website/pages/docs/commands/system/reconcile-summaries.mdx
View file

@ -18,7 +18,7 @@ nomad system reconcile summaries [options]
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Examples

2
website/pages/docs/commands/ui.mdx
View file

@ -24,7 +24,7 @@ details for that object. Supported identifiers are jobs, allocations and nodes.
## General Options
@include 'general_options.mdx'
@include 'general_options_no_namespace.mdx'
## Examples

35
website/pages/partials/general_options_no_namespace.mdx Normal file
View file

@ -0,0 +1,35 @@
- `-address=<addr>`: The address of the Nomad server. Overrides the `NOMAD_ADDR`
environment variable if set. Defaults to `http://127.0.0.1:4646`.
- `-region=<region>`: The region of the Nomad server to forward commands to.
Overrides the `NOMAD_REGION` environment variable if set. Defaults to the
Agent's local region.
- `-no-color`: Disables colored command output. Alternatively,
`NOMAD_CLI_NO_COLOR` may be set.
- `-ca-cert=<path>`: Path to a PEM encoded CA cert file to use to verify the
Nomad server SSL certificate. Overrides the `NOMAD_CACERT` environment
variable if set.
- `-ca-path=<path>`: Path to a directory of PEM encoded CA cert files to verify
the Nomad server SSL certificate. If both `-ca-cert` and `-ca-path` are
specified, `-ca-cert` is used. Overrides the `NOMAD_CAPATH` environment
variable if set.
- `-client-cert=<path>`: Path to a PEM encoded client certificate for TLS
authentication to the Nomad server. Must also specify `-client-key`. Overrides
the `NOMAD_CLIENT_CERT` environment variable if set.
- `-client-key=<path>`: Path to an unencrypted PEM encoded private key matching
the client certificate from `-client-cert`. Overrides the `NOMAD_CLIENT_KEY`
environment variable if set.
- `-tls-server-name=<value>`: The server name to use as the SNI host when connecting
via TLS. Overrides the `NOMAD_TLS_SERVER_NAME` environment variable if set.
- `-tls-skip-verify`: Do not verify TLS certificate. This is highly not
recommended. Verification will also be skipped if `NOMAD_SKIP_VERIFY` is set.
- `-token`: The SecretID of an ACL token to use to authenticate API requests with.
Overrides the `NOMAD_TOKEN` environment variable if set.