diff --git a/website/pages/docs/commands/acl/bootstrap.mdx b/website/pages/docs/commands/acl/bootstrap.mdx index 836c720e0..e29c3c18d 100644 --- a/website/pages/docs/commands/acl/bootstrap.mdx +++ b/website/pages/docs/commands/acl/bootstrap.mdx @@ -20,7 +20,7 @@ The `acl bootstrap` command requires no arguments. ## General Options -@include 'general_options.mdx' +@include 'general_options_no_namespace.mdx' ## Examples diff --git a/website/pages/docs/commands/acl/policy-apply.mdx b/website/pages/docs/commands/acl/policy-apply.mdx index 3f7c8d7cc..44eaa864a 100644 --- a/website/pages/docs/commands/acl/policy-apply.mdx +++ b/website/pages/docs/commands/acl/policy-apply.mdx @@ -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 diff --git a/website/pages/docs/commands/acl/policy-delete.mdx b/website/pages/docs/commands/acl/policy-delete.mdx index 95d88b971..cbbb14b62 100644 --- a/website/pages/docs/commands/acl/policy-delete.mdx +++ b/website/pages/docs/commands/acl/policy-delete.mdx @@ -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 diff --git a/website/pages/docs/commands/acl/policy-info.mdx b/website/pages/docs/commands/acl/policy-info.mdx index d2bf26165..f6ee4c764 100644 --- a/website/pages/docs/commands/acl/policy-info.mdx +++ b/website/pages/docs/commands/acl/policy-info.mdx @@ -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 diff --git a/website/pages/docs/commands/acl/policy-list.mdx b/website/pages/docs/commands/acl/policy-list.mdx index 417e797b7..30d0a4c52 100644 --- a/website/pages/docs/commands/acl/policy-list.mdx +++ b/website/pages/docs/commands/acl/policy-list.mdx @@ -18,7 +18,7 @@ nomad acl policy list ## General Options -@include 'general_options.mdx' +@include 'general_options_no_namespace.mdx' ## List Options diff --git a/website/pages/docs/commands/acl/token-create.mdx b/website/pages/docs/commands/acl/token-create.mdx index 678b9756b..c2483074e 100644 --- a/website/pages/docs/commands/acl/token-create.mdx +++ b/website/pages/docs/commands/acl/token-create.mdx @@ -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 diff --git a/website/pages/docs/commands/acl/token-delete.mdx b/website/pages/docs/commands/acl/token-delete.mdx index 6bd65565a..f9b0b4dec 100644 --- a/website/pages/docs/commands/acl/token-delete.mdx +++ b/website/pages/docs/commands/acl/token-delete.mdx @@ -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 diff --git a/website/pages/docs/commands/acl/token-info.mdx b/website/pages/docs/commands/acl/token-info.mdx index 6adcb7d5b..48d7c99ca 100644 --- a/website/pages/docs/commands/acl/token-info.mdx +++ b/website/pages/docs/commands/acl/token-info.mdx @@ -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 diff --git a/website/pages/docs/commands/acl/token-list.mdx b/website/pages/docs/commands/acl/token-list.mdx index 159964355..88be71141 100644 --- a/website/pages/docs/commands/acl/token-list.mdx +++ b/website/pages/docs/commands/acl/token-list.mdx @@ -18,7 +18,7 @@ nomad acl token list ## General Options -@include 'general_options.mdx' +@include 'general_options_no_namespace.mdx' ## List Options diff --git a/website/pages/docs/commands/acl/token-self.mdx b/website/pages/docs/commands/acl/token-self.mdx index a3544208d..f07b62612 100644 --- a/website/pages/docs/commands/acl/token-self.mdx +++ b/website/pages/docs/commands/acl/token-self.mdx @@ -20,7 +20,7 @@ nomad acl token self ## General Options -@include 'general_options.mdx' +@include 'general_options_no_namespace.mdx' ## Examples diff --git a/website/pages/docs/commands/acl/token-update.mdx b/website/pages/docs/commands/acl/token-update.mdx index 6f5004ff6..af7975f9e 100644 --- a/website/pages/docs/commands/acl/token-update.mdx +++ b/website/pages/docs/commands/acl/token-update.mdx @@ -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 diff --git a/website/pages/docs/commands/agent-info.mdx b/website/pages/docs/commands/agent-info.mdx index ddbbe6ac4..57a40344c 100644 --- a/website/pages/docs/commands/agent-info.mdx +++ b/website/pages/docs/commands/agent-info.mdx @@ -20,7 +20,7 @@ nomad agent-info [options] ## General Options -@include 'general_options.mdx' +@include 'general_options_no_namespace.mdx' ## Output diff --git a/website/pages/docs/commands/license/get.mdx b/website/pages/docs/commands/license/get.mdx index 6c96eb91d..a646c5a46 100644 --- a/website/pages/docs/commands/license/get.mdx +++ b/website/pages/docs/commands/license/get.mdx @@ -21,7 +21,7 @@ nomad license get [options] ## General Options -@include 'general_options.mdx' +@include 'general_options_no_namespace.mdx' ## Examples diff --git a/website/pages/docs/commands/license/put.mdx b/website/pages/docs/commands/license/put.mdx index 3c537a121..9a9c86cc4 100644 --- a/website/pages/docs/commands/license/put.mdx +++ b/website/pages/docs/commands/license/put.mdx @@ -21,7 +21,7 @@ nomad license put ## General Options -@include 'general_options.mdx' +@include 'general_options_no_namespace.mdx' ## Put Options diff --git a/website/pages/docs/commands/monitor.mdx b/website/pages/docs/commands/monitor.mdx index 3fa44e165..ff01b10dd 100644 --- a/website/pages/docs/commands/monitor.mdx +++ b/website/pages/docs/commands/monitor.mdx @@ -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 diff --git a/website/pages/docs/commands/namespace/apply.mdx b/website/pages/docs/commands/namespace/apply.mdx index 849c4572b..367cdf9cc 100644 --- a/website/pages/docs/commands/namespace/apply.mdx +++ b/website/pages/docs/commands/namespace/apply.mdx @@ -24,7 +24,7 @@ or updated. ## General Options -@include 'general_options.mdx' +@include 'general_options_no_namespace.mdx' ## Apply Options diff --git a/website/pages/docs/commands/namespace/delete.mdx b/website/pages/docs/commands/namespace/delete.mdx index 66ee82b3f..bd1b5fe23 100644 --- a/website/pages/docs/commands/namespace/delete.mdx +++ b/website/pages/docs/commands/namespace/delete.mdx @@ -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 diff --git a/website/pages/docs/commands/namespace/inspect.mdx b/website/pages/docs/commands/namespace/inspect.mdx index 1b242816a..282b813cf 100644 --- a/website/pages/docs/commands/namespace/inspect.mdx +++ b/website/pages/docs/commands/namespace/inspect.mdx @@ -23,7 +23,7 @@ nomad namespace inspect [options] ## General Options -@include 'general_options.mdx' +@include 'general_options_no_namespace.mdx' ## Inspect Options diff --git a/website/pages/docs/commands/namespace/list.mdx b/website/pages/docs/commands/namespace/list.mdx index 8e3fbc224..dd33aa640 100644 --- a/website/pages/docs/commands/namespace/list.mdx +++ b/website/pages/docs/commands/namespace/list.mdx @@ -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 diff --git a/website/pages/docs/commands/namespace/status.mdx b/website/pages/docs/commands/namespace/status.mdx index ef3857719..95ac628e4 100644 --- a/website/pages/docs/commands/namespace/status.mdx +++ b/website/pages/docs/commands/namespace/status.mdx @@ -23,7 +23,7 @@ nomad namespace status [options] ## General Options -@include 'general_options.mdx' +@include 'general_options_no_namespace.mdx' ## Examples diff --git a/website/pages/docs/commands/node/config.mdx b/website/pages/docs/commands/node/config.mdx index 7477749b6..c339406ee 100644 --- a/website/pages/docs/commands/node/config.mdx +++ b/website/pages/docs/commands/node/config.mdx @@ -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 diff --git a/website/pages/docs/commands/node/drain.mdx b/website/pages/docs/commands/node/drain.mdx index 70fd1b512..76d9ddac5 100644 --- a/website/pages/docs/commands/node/drain.mdx +++ b/website/pages/docs/commands/node/drain.mdx @@ -46,7 +46,7 @@ operation is desired. ## General Options -@include 'general_options.mdx' +@include 'general_options_no_namespace.mdx' ## Drain Options diff --git a/website/pages/docs/commands/node/eligibility.mdx b/website/pages/docs/commands/node/eligibility.mdx index d82dbbbd6..b9ad4aa15 100644 --- a/website/pages/docs/commands/node/eligibility.mdx +++ b/website/pages/docs/commands/node/eligibility.mdx @@ -42,7 +42,7 @@ operation is desired. ## General Options -@include 'general_options.mdx' +@include 'general_options_no_namespace.mdx' ## Eligibility Options diff --git a/website/pages/docs/commands/node/status.mdx b/website/pages/docs/commands/node/status.mdx index 15d38804b..1e5a5b43e 100644 --- a/website/pages/docs/commands/node/status.mdx +++ b/website/pages/docs/commands/node/status.mdx @@ -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 diff --git a/website/pages/docs/commands/operator/autopilot-get-config.mdx b/website/pages/docs/commands/operator/autopilot-get-config.mdx index 2d2c6fecf..975e4b977 100644 --- a/website/pages/docs/commands/operator/autopilot-get-config.mdx +++ b/website/pages/docs/commands/operator/autopilot-get-config.mdx @@ -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: diff --git a/website/pages/docs/commands/operator/autopilot-set-config.mdx b/website/pages/docs/commands/operator/autopilot-set-config.mdx index 9d1e166c3..f57bde8a8 100644 --- a/website/pages/docs/commands/operator/autopilot-set-config.mdx +++ b/website/pages/docs/commands/operator/autopilot-set-config.mdx @@ -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 diff --git a/website/pages/docs/commands/operator/debug.mdx b/website/pages/docs/commands/operator/debug.mdx index a9bf848e7..d18be9f82 100644 --- a/website/pages/docs/commands/operator/debug.mdx +++ b/website/pages/docs/commands/operator/debug.mdx @@ -37,7 +37,7 @@ configured. ## General Options -@include 'general_options.mdx' +@include 'general_options_no_namespace.mdx' ## Debug Options diff --git a/website/pages/docs/commands/operator/raft-list-peers.mdx b/website/pages/docs/commands/operator/raft-list-peers.mdx index a733e2ef0..da48a46ff 100644 --- a/website/pages/docs/commands/operator/raft-list-peers.mdx +++ b/website/pages/docs/commands/operator/raft-list-peers.mdx @@ -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 diff --git a/website/pages/docs/commands/operator/raft-remove-peer.mdx b/website/pages/docs/commands/operator/raft-remove-peer.mdx index bc627a517..cddd2f3c8 100644 --- a/website/pages/docs/commands/operator/raft-remove-peer.mdx +++ b/website/pages/docs/commands/operator/raft-remove-peer.mdx @@ -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 diff --git a/website/pages/docs/commands/operator/snapshot-agent.mdx b/website/pages/docs/commands/operator/snapshot-agent.mdx index f9afb6547..3c6519ef0 100644 --- a/website/pages/docs/commands/operator/snapshot-agent.mdx +++ b/website/pages/docs/commands/operator/snapshot-agent.mdx @@ -101,7 +101,7 @@ nomad operator snapshot agent [options] ## General Options -@include 'general_options.mdx' +@include 'general_options_no_namespace.mdx' ## Snapshot agent Options diff --git a/website/pages/docs/commands/operator/snapshot-restore.mdx b/website/pages/docs/commands/operator/snapshot-restore.mdx index b8e371854..22d482467 100644 --- a/website/pages/docs/commands/operator/snapshot-restore.mdx +++ b/website/pages/docs/commands/operator/snapshot-restore.mdx @@ -33,6 +33,6 @@ nomad operator snapshot restore [options] ## General Options -@include 'general_options.mdx' +@include 'general_options_no_namespace.mdx' [outage recovery]: https://learn.hashicorp.com/tutorials/nomad/outage-recovery diff --git a/website/pages/docs/commands/operator/snapshot-save.mdx b/website/pages/docs/commands/operator/snapshot-save.mdx index 9200c0e30..0861387d2 100644 --- a/website/pages/docs/commands/operator/snapshot-save.mdx +++ b/website/pages/docs/commands/operator/snapshot-save.mdx @@ -36,7 +36,7 @@ nomad operator snapshot save [options] ## General Options -@include 'general_options.mdx' +@include 'general_options_no_namespace.mdx' ## Snapshot Save Options diff --git a/website/pages/docs/commands/plugin/status.mdx b/website/pages/docs/commands/plugin/status.mdx index df1cdf012..aec10d1f1 100644 --- a/website/pages/docs/commands/plugin/status.mdx +++ b/website/pages/docs/commands/plugin/status.mdx @@ -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 diff --git a/website/pages/docs/commands/sentinel/apply.mdx b/website/pages/docs/commands/sentinel/apply.mdx index 8f78ad97b..d4f0e22dd 100644 --- a/website/pages/docs/commands/sentinel/apply.mdx +++ b/website/pages/docs/commands/sentinel/apply.mdx @@ -27,7 +27,7 @@ file name. ## General Options -@include 'general_options.mdx' +@include 'general_options_no_namespace.mdx' ## Apply Options diff --git a/website/pages/docs/commands/sentinel/delete.mdx b/website/pages/docs/commands/sentinel/delete.mdx index a57a18c59..cc681e132 100644 --- a/website/pages/docs/commands/sentinel/delete.mdx +++ b/website/pages/docs/commands/sentinel/delete.mdx @@ -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 diff --git a/website/pages/docs/commands/sentinel/list.mdx b/website/pages/docs/commands/sentinel/list.mdx index b80836ea0..85ef3665b 100644 --- a/website/pages/docs/commands/sentinel/list.mdx +++ b/website/pages/docs/commands/sentinel/list.mdx @@ -24,7 +24,7 @@ The `sentinel list` command requires no arguments. ## General Options -@include 'general_options.mdx' +@include 'general_options_no_namespace.mdx' ## Examples diff --git a/website/pages/docs/commands/sentinel/read.mdx b/website/pages/docs/commands/sentinel/read.mdx index e49c1a38a..bbbae3d14 100644 --- a/website/pages/docs/commands/sentinel/read.mdx +++ b/website/pages/docs/commands/sentinel/read.mdx @@ -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 diff --git a/website/pages/docs/commands/server/force-leave.mdx b/website/pages/docs/commands/server/force-leave.mdx index 61a437888..d65d2337a 100644 --- a/website/pages/docs/commands/server/force-leave.mdx +++ b/website/pages/docs/commands/server/force-leave.mdx @@ -25,7 +25,7 @@ to enter the "left" state. ## General Options -@include 'general_options.mdx' +@include 'general_options_no_namespace.mdx' ## Examples diff --git a/website/pages/docs/commands/server/join.mdx b/website/pages/docs/commands/server/join.mdx index 3f4eba7a5..9e39a268a 100644 --- a/website/pages/docs/commands/server/join.mdx +++ b/website/pages/docs/commands/server/join.mdx @@ -27,7 +27,7 @@ be 1. ## General Options -@include 'general_options.mdx' +@include 'general_options_no_namespace.mdx' ## Examples diff --git a/website/pages/docs/commands/server/members.mdx b/website/pages/docs/commands/server/members.mdx index f45bcc513..e443c086b 100644 --- a/website/pages/docs/commands/server/members.mdx +++ b/website/pages/docs/commands/server/members.mdx @@ -21,7 +21,7 @@ nomad server members [options] ## General Options -@include 'general_options.mdx' +@include 'general_options_no_namespace.mdx' ## Server Members Options diff --git a/website/pages/docs/commands/system/gc.mdx b/website/pages/docs/commands/system/gc.mdx index aff2c3807..fcc9a20c4 100644 --- a/website/pages/docs/commands/system/gc.mdx +++ b/website/pages/docs/commands/system/gc.mdx @@ -19,7 +19,7 @@ nomad system gc [options] ## General Options -@include 'general_options.mdx' +@include 'general_options_no_namespace.mdx' ## Examples diff --git a/website/pages/docs/commands/system/reconcile-summaries.mdx b/website/pages/docs/commands/system/reconcile-summaries.mdx index f8d1cc071..c6920133e 100644 --- a/website/pages/docs/commands/system/reconcile-summaries.mdx +++ b/website/pages/docs/commands/system/reconcile-summaries.mdx @@ -18,7 +18,7 @@ nomad system reconcile summaries [options] ## General Options -@include 'general_options.mdx' +@include 'general_options_no_namespace.mdx' ## Examples diff --git a/website/pages/docs/commands/ui.mdx b/website/pages/docs/commands/ui.mdx index 903032844..35780ec65 100644 --- a/website/pages/docs/commands/ui.mdx +++ b/website/pages/docs/commands/ui.mdx @@ -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 diff --git a/website/pages/partials/general_options_no_namespace.mdx b/website/pages/partials/general_options_no_namespace.mdx new file mode 100644 index 000000000..7ae431c4f --- /dev/null +++ b/website/pages/partials/general_options_no_namespace.mdx @@ -0,0 +1,35 @@ +- `-address=`: The address of the Nomad server. Overrides the `NOMAD_ADDR` + environment variable if set. Defaults to `http://127.0.0.1:4646`. + +- `-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 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 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 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 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=`: 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.