From 47cd49d4919d4247b7397134ca34ea8f909e43f3 Mon Sep 17 00:00:00 2001 From: Sarah Chavis <62406755+schavis@users.noreply.github.com> Date: Fri, 22 Nov 2024 15:28:30 -0800 Subject: [PATCH] [DOCS] Revert CLI partials (#29005) * Remove linking added earlier this week and revert to the previous partial template. * Revert template in readme --- website/content/partials/cli/README.md | 21 +++++++------------ .../partials/cli/agent/args/file_path.mdx | 4 +++- .../partials/cli/agent/flags/config.mdx | 3 ++- .../content/partials/cli/agent/flags/exec.mdx | 4 +++- .../cli/agent/flags/exit-after-auth.mdx | 4 +++- .../content/partials/cli/agent/flags/path.mdx | 4 +++- .../content/partials/cli/agent/flags/type.mdx | 4 +++- .../partials/cli/audit/args/device_path.mdx | 4 +++- .../partials/cli/audit/args/device_type.mdx | 4 +++- .../cli/audit/args/file/file_path.mdx | 4 +++- .../partials/cli/audit/args/file/mode.mdx | 4 +++- .../cli/audit/args/socket/address.mdx | 4 +++- .../cli/audit/args/socket/socket_type.mdx | 4 +++- .../cli/audit/args/socket/write_timeout.mdx | 4 +++- .../cli/audit/args/syslog/facility.mdx | 4 +++- .../partials/cli/audit/args/syslog/tag.mdx | 4 +++- .../partials/cli/audit/flags/description.mdx | 4 +++- .../partials/cli/audit/flags/detailed.mdx | 4 +++- .../partials/cli/audit/flags/local.mdx | 6 ++++-- .../content/partials/cli/audit/flags/path.mdx | 4 +++- .../audit/options/elide_list_responses.mdx | 4 +++- .../partials/cli/audit/options/exclude.mdx | 3 ++- .../partials/cli/audit/options/fallback.mdx | 4 +++- .../partials/cli/audit/options/filter.mdx | 4 +++- .../partials/cli/audit/options/format.mdx | 4 +++- .../cli/audit/options/hmac_accessor.mdx | 4 +++- .../partials/cli/audit/options/log_raw.mdx | 4 +++- .../partials/cli/audit/options/prefix.mdx | 4 +++- .../partials/cli/shared/flags/log-file.mdx | 4 +++- .../cli/shared/flags/log-rotate-bytes.mdx | 4 +++- .../cli/shared/flags/log-rotate-duration.mdx | 4 +++- .../cli/shared/flags/log-rotate-max-files.mdx | 4 +++- .../partials/global-settings/both/address.mdx | 5 +++-- .../global-settings/both/agent-address.mdx | 5 +++-- .../partials/global-settings/both/ca-cert.mdx | 5 +++-- .../partials/global-settings/both/ca-path.mdx | 5 +++-- .../global-settings/both/client-cert.mdx | 5 +++-- .../global-settings/both/client-key.mdx | 5 +++-- .../both/disable-redirects.mdx | 5 +++-- .../partials/global-settings/both/format.mdx | 5 +++-- .../global-settings/both/log-format.mdx | 4 +++- .../global-settings/both/log-level.mdx | 5 +++-- .../partials/global-settings/both/mfa.mdx | 6 +++--- .../global-settings/both/namespace.mdx | 5 +++-- .../global-settings/both/tls-server-name.mdx | 5 +++-- .../global-settings/both/tls-skip-verify.mdx | 5 +++-- .../global-settings/both/wrap-ttl.mdx | 5 +++-- .../global-settings/env/cli_no_color.mdx | 6 +++--- .../global-settings/env/client_timeout.mdx | 5 +++-- .../global-settings/env/cluster_addr.mdx | 5 +++-- .../global-settings/env/http_proxy.mdx | 6 +++--- .../partials/global-settings/env/license.mdx | 9 +++----- .../global-settings/env/license_path.mdx | 4 +++- .../global-settings/env/max_retries.mdx | 4 +++- .../global-settings/env/proxy_addr.mdx | 4 +++- .../global-settings/env/rate_limit.mdx | 4 +++- .../global-settings/env/redirect_addr.mdx | 4 +++- .../global-settings/env/skip_verify.mdx | 4 +++- .../global-settings/env/srv_lookup.mdx | 4 +++- .../partials/global-settings/env/token.mdx | 4 +++- .../partials/global-settings/flags/header.mdx | 4 +++- .../global-settings/flags/non-interactive.mdx | 4 +++- .../flags/output-curl-string.mdx | 4 +++- .../global-settings/flags/output-policy.mdx | 4 +++- .../global-settings/flags/policy-override.mdx | 5 +++-- .../global-settings/flags/unlock-key.mdx | 4 +++- 66 files changed, 201 insertions(+), 107 deletions(-) diff --git a/website/content/partials/cli/README.md b/website/content/partials/cli/README.md index 6cd61bf7b9..a73c7fc597 100644 --- a/website/content/partials/cli/README.md +++ b/website/content/partials/cli/README.md @@ -16,6 +16,7 @@ The `agent` family of commands is malformed. Rather than having a root node root command is runnable. + ## Why partials? We document CLI command arguments, options, and flags as partials: @@ -66,20 +67,15 @@ partials/global-settings/both parameters that exits as flags and variables ### Template 1 - command-specific parameters Use the following template for parameters that exist as command-exclusively -arguments, flags, or options. "ANCHOR_ID" is the ID defined in the `` -HTML tag. +arguments, flags, or options. -- Template (start) -- - - **`NAME (TYPE : DEFAULT)`** - - DESCRIPTION **Example**: `EXAMPLE_OF_VALID_USE` @@ -87,22 +83,19 @@ DESCRIPTION -- Template (end) -- - ### Template 2 - shared parameters Use the following template for parameters that exist as arguments, flags, or options that are not global but are shared across more than one command family. -"ANCHOR_ID" is the ID defined in the `` HTML tag. + +-- Template (start) -- - - - **`NAME (TYPE : DEFAULT)`** - - DESCRIPTION -**Example**: `EXAMPLE_OF_VALID_USE` \ No newline at end of file +**Example**: `EXAMPLE_OF_VALID_USE` + +-- Template (end) -- diff --git a/website/content/partials/cli/agent/args/file_path.mdx b/website/content/partials/cli/agent/args/file_path.mdx index 2040d88430..c97f1cd0c5 100644 --- a/website/content/partials/cli/agent/args/file_path.mdx +++ b/website/content/partials/cli/agent/args/file_path.mdx @@ -1,4 +1,6 @@ -- `file_path (string : "./agent.hcl")` ((#agent-arg-file_path)) + + +**`file_path (string : "./agent.hcl")`** The path where Vault should save the generated configuration file. diff --git a/website/content/partials/cli/agent/flags/config.mdx b/website/content/partials/cli/agent/flags/config.mdx index c55cae4ea6..27b0f17757 100644 --- a/website/content/partials/cli/agent/flags/config.mdx +++ b/website/content/partials/cli/agent/flags/config.mdx @@ -1,5 +1,6 @@ -- `-config (string : )` ((#agent-flag-config)) + +**`-config (string : )`** Path to a single [Vault Agent configuration file](/vault/docs/agent-and-proxy/agent#configuration-file-options) diff --git a/website/content/partials/cli/agent/flags/exec.mdx b/website/content/partials/cli/agent/flags/exec.mdx index 9065130a69..ba0e9664cc 100644 --- a/website/content/partials/cli/agent/flags/exec.mdx +++ b/website/content/partials/cli/agent/flags/exec.mdx @@ -1,4 +1,6 @@ -- `-exec (string : "")` ((#agent-flag-exec)) + + +**`-exec (string : "")`** Path to the command for child processes with optional arguments. Relative paths start from the current working directory when executed. Corresponds to diff --git a/website/content/partials/cli/agent/flags/exit-after-auth.mdx b/website/content/partials/cli/agent/flags/exit-after-auth.mdx index 3cd691f615..75e6874ea5 100644 --- a/website/content/partials/cli/agent/flags/exit-after-auth.mdx +++ b/website/content/partials/cli/agent/flags/exit-after-auth.mdx @@ -1,4 +1,6 @@ -- `-exit-after-auth (bool : false)` ((#agent-flag-exit-after-auth)) + + +**`-exit-after-auth (bool : false)`** Exit with code `0` after a single successful auth. Success indicates successful token retrieval and write to sink. diff --git a/website/content/partials/cli/agent/flags/path.mdx b/website/content/partials/cli/agent/flags/path.mdx index 3c44ac7881..bd1a3debd4 100644 --- a/website/content/partials/cli/agent/flags/path.mdx +++ b/website/content/partials/cli/agent/flags/path.mdx @@ -1,4 +1,6 @@ -- `-path (string : "")` ((#agent-flag-path)) + + +**`-path (string : "")`** Path to one or more `kv` secrets store. Paths that end with a wildcard (`*`) include all secrets under that path. diff --git a/website/content/partials/cli/agent/flags/type.mdx b/website/content/partials/cli/agent/flags/type.mdx index dd98280c03..de73638410 100644 --- a/website/content/partials/cli/agent/flags/type.mdx +++ b/website/content/partials/cli/agent/flags/type.mdx @@ -1,4 +1,6 @@ -- `-type (enum : )` ((#agent-flag-type)) + + +**`-type (enum : )`** The configuration file entry to create. diff --git a/website/content/partials/cli/audit/args/device_path.mdx b/website/content/partials/cli/audit/args/device_path.mdx index 5f1abfd2bd..134f7d8727 100644 --- a/website/content/partials/cli/audit/args/device_path.mdx +++ b/website/content/partials/cli/audit/args/device_path.mdx @@ -1,4 +1,6 @@ -- `device_path (string : )` ((#audit-arg-device_path)) + + +**`device_path (string : )`** The internal path where Vault accesses the audit device. Audit device paths are unique across all audit devices. diff --git a/website/content/partials/cli/audit/args/device_type.mdx b/website/content/partials/cli/audit/args/device_type.mdx index ef3808f87b..0e0bc6063e 100644 --- a/website/content/partials/cli/audit/args/device_type.mdx +++ b/website/content/partials/cli/audit/args/device_type.mdx @@ -1,4 +1,6 @@ -- `audit-arg-device_type (enum : )` ((#audit-arg-device_type)) + + +**`device_type (enum : )`** The audit device type to create. diff --git a/website/content/partials/cli/audit/args/file/file_path.mdx b/website/content/partials/cli/audit/args/file/file_path.mdx index 391cfdfa04..964e281a84 100644 --- a/website/content/partials/cli/audit/args/file/file_path.mdx +++ b/website/content/partials/cli/audit/args/file/file_path.mdx @@ -1,4 +1,6 @@ -- `file_path (string : )` ((#audit-arg-file-file_path)) + + +**`file_path (string : )`** Location on the audit log on the Vault server. Must be one of the following: diff --git a/website/content/partials/cli/audit/args/file/mode.mdx b/website/content/partials/cli/audit/args/file/mode.mdx index 7df9c650d0..d285751b46 100644 --- a/website/content/partials/cli/audit/args/file/mode.mdx +++ b/website/content/partials/cli/audit/args/file/mode.mdx @@ -1,4 +1,6 @@ -- `mode (string : "0600")` ((#audit-arg-file-mode)) + + +**`mode (string : "0600")`** The `chmod`-style octal permissions for the audit file. Set `mode` to "0000" to prevent Vault from modifying the file mode. diff --git a/website/content/partials/cli/audit/args/socket/address.mdx b/website/content/partials/cli/audit/args/socket/address.mdx index d2df30584e..8d4083e7a4 100644 --- a/website/content/partials/cli/audit/args/socket/address.mdx +++ b/website/content/partials/cli/audit/args/socket/address.mdx @@ -1,4 +1,6 @@ -- `address (string : "")` ((#audit-arg-socket-address)) + + +**`address (string : "")`** Location of the socket as a server IP and port or a local path. diff --git a/website/content/partials/cli/audit/args/socket/socket_type.mdx b/website/content/partials/cli/audit/args/socket/socket_type.mdx index 622a2586f2..051f370832 100644 --- a/website/content/partials/cli/audit/args/socket/socket_type.mdx +++ b/website/content/partials/cli/audit/args/socket/socket_type.mdx @@ -1,4 +1,6 @@ -- `socket_type (string : "tcp")` ((#audit-arg-socket-socket_type)) + + +**`socket_type (string : "tcp")`** Communication protocol expected by the socket. Vault can write to any [net.Dialer](https://pkg.go.dev/net#Dialer)-compatible socket. If a TCP socket diff --git a/website/content/partials/cli/audit/args/socket/write_timeout.mdx b/website/content/partials/cli/audit/args/socket/write_timeout.mdx index c6b5fd4c8a..f5921bf9b8 100644 --- a/website/content/partials/cli/audit/args/socket/write_timeout.mdx +++ b/website/content/partials/cli/audit/args/socket/write_timeout.mdx @@ -1,4 +1,6 @@ -- `write_timeout (string : "2s")` ((#audit-arg-socket-write_timeout)) + + +**`write_timeout (string : "2s")`** Duration in seconds that Vault will wait for a write to complete over the socket. Setting `write_timeout` to `0` disables time outs and forces Vault to diff --git a/website/content/partials/cli/audit/args/syslog/facility.mdx b/website/content/partials/cli/audit/args/syslog/facility.mdx index b540210b40..8c923ed9be 100644 --- a/website/content/partials/cli/audit/args/syslog/facility.mdx +++ b/website/content/partials/cli/audit/args/syslog/facility.mdx @@ -1,4 +1,6 @@ -- `facility (string : "AUTH")` ((#audit-arg-syslog-facility)) + + +**`facility (string : "AUTH")`** The process that generated the syslog entry (the syslog facility). diff --git a/website/content/partials/cli/audit/args/syslog/tag.mdx b/website/content/partials/cli/audit/args/syslog/tag.mdx index 1f376f7bbf..de7cfc6dd5 100644 --- a/website/content/partials/cli/audit/args/syslog/tag.mdx +++ b/website/content/partials/cli/audit/args/syslog/tag.mdx @@ -1,4 +1,6 @@ -- `tag (string : "vault")` ((#audit-arg-syslog-tag)) + + +**`tag (string : "vault")`** The program that generated the syslog entry. diff --git a/website/content/partials/cli/audit/flags/description.mdx b/website/content/partials/cli/audit/flags/description.mdx index c71ab32b38..d106c4c16c 100644 --- a/website/content/partials/cli/audit/flags/description.mdx +++ b/website/content/partials/cli/audit/flags/description.mdx @@ -1,4 +1,6 @@ -- `-description (string : "")` ((#audit-flag-description)) + + +**`-description (string : "")`** A human-friendly string that explains the purpose of the audit device. diff --git a/website/content/partials/cli/audit/flags/detailed.mdx b/website/content/partials/cli/audit/flags/detailed.mdx index 5b1a8c6f16..3584a9e377 100644 --- a/website/content/partials/cli/audit/flags/detailed.mdx +++ b/website/content/partials/cli/audit/flags/detailed.mdx @@ -1,4 +1,6 @@ -- `-detailed (bool : false)` ((#audit-flag-detailed)) + + +**`-detailed (bool : false)`** Print detailed information such as options and replication status about each audit device. diff --git a/website/content/partials/cli/audit/flags/local.mdx b/website/content/partials/cli/audit/flags/local.mdx index 352c377ea1..110cdf430c 100644 --- a/website/content/partials/cli/audit/flags/local.mdx +++ b/website/content/partials/cli/audit/flags/local.mdx @@ -1,6 +1,8 @@ -- `-local (bool : false)` ((#audit-flag-local)) + + +**`-local (bool : false)`** Indicates that the audit device is local to the Vault server and ignored by replication. -**Example**: `-local` +**Example**: `-local` \ No newline at end of file diff --git a/website/content/partials/cli/audit/flags/path.mdx b/website/content/partials/cli/audit/flags/path.mdx index fa8181daff..2f355410bb 100644 --- a/website/content/partials/cli/audit/flags/path.mdx +++ b/website/content/partials/cli/audit/flags/path.mdx @@ -1,4 +1,6 @@ -- `-path (string : "/")` ((#audit-flag-path)) + + +**`-path (string : "/")`** The internal path where Vault will access the audit device. Audit device paths must be unique across all audit devices. diff --git a/website/content/partials/cli/audit/options/elide_list_responses.mdx b/website/content/partials/cli/audit/options/elide_list_responses.mdx index 1c99326c26..51170a7bcc 100644 --- a/website/content/partials/cli/audit/options/elide_list_responses.mdx +++ b/website/content/partials/cli/audit/options/elide_list_responses.mdx @@ -1,4 +1,6 @@ -- `elide_list_responses (bool : false)` ((#audit-option-elide_list_responses)) + + +**`elide_list_responses (bool : false)`** Replace the details for `response.data.keys` and `response.data.key_info` with the number of entries to reduce the size of audit records. See diff --git a/website/content/partials/cli/audit/options/exclude.mdx b/website/content/partials/cli/audit/options/exclude.mdx index 4298c1f24c..ccb6caf6e7 100644 --- a/website/content/partials/cli/audit/options/exclude.mdx +++ b/website/content/partials/cli/audit/options/exclude.mdx @@ -1,5 +1,6 @@ -- `exclude (string : "")` ((#audit-option-exclude)) + +**`exclude (string : "")`** Remove any fields matching the provided [exclusion filtering rules](/vault/docs/enterprise/audit/exclusion) from the diff --git a/website/content/partials/cli/audit/options/fallback.mdx b/website/content/partials/cli/audit/options/fallback.mdx index e0498377d1..31c6453c43 100644 --- a/website/content/partials/cli/audit/options/fallback.mdx +++ b/website/content/partials/cli/audit/options/fallback.mdx @@ -1,4 +1,6 @@ -- `fallback (bool : false)` ((#audit-option-fallback)) + + +**`fallback (bool : false)`** The audit device is the fallback for filtering purposes. **Vault only supports one fallback audit device at a time**. diff --git a/website/content/partials/cli/audit/options/filter.mdx b/website/content/partials/cli/audit/options/filter.mdx index 4bd3c42f22..1721fe9874 100644 --- a/website/content/partials/cli/audit/options/filter.mdx +++ b/website/content/partials/cli/audit/options/filter.mdx @@ -1,4 +1,6 @@ -- `filter (string : "")` ((#audit-option-filter)) + + +**`filter (string : "")`** Only write audit log entries matching the provided [filtering expression](/vault/docs/enterprise/audit/filtering) to the audit diff --git a/website/content/partials/cli/audit/options/format.mdx b/website/content/partials/cli/audit/options/format.mdx index dc2fd1576c..b39bd5e0ef 100644 --- a/website/content/partials/cli/audit/options/format.mdx +++ b/website/content/partials/cli/audit/options/format.mdx @@ -1,4 +1,6 @@ -- `format (enum : json)` ((#audit-option-format)) + + +**`format (enum : json)`** Write audit log entries in the provided format. diff --git a/website/content/partials/cli/audit/options/hmac_accessor.mdx b/website/content/partials/cli/audit/options/hmac_accessor.mdx index f9db35d3ae..e7ff746bce 100644 --- a/website/content/partials/cli/audit/options/hmac_accessor.mdx +++ b/website/content/partials/cli/audit/options/hmac_accessor.mdx @@ -1,4 +1,6 @@ -- `hmac_accessor (bool : true)` ((#audit-option-hmac_accessor)) + + +**`hmac_accessor (bool : true)`** Hash all token accessor data before writing to the audit device. diff --git a/website/content/partials/cli/audit/options/log_raw.mdx b/website/content/partials/cli/audit/options/log_raw.mdx index 4127c6d9e3..176cbb9317 100644 --- a/website/content/partials/cli/audit/options/log_raw.mdx +++ b/website/content/partials/cli/audit/options/log_raw.mdx @@ -1,4 +1,6 @@ -- `log_raw (bool : false)` ((#audit-option-log_raw)) + + +**`log_raw (bool : false)`** Hash all sensitive security information before writing to the audit device. diff --git a/website/content/partials/cli/audit/options/prefix.mdx b/website/content/partials/cli/audit/options/prefix.mdx index 9c6f18839b..77822d0e4e 100644 --- a/website/content/partials/cli/audit/options/prefix.mdx +++ b/website/content/partials/cli/audit/options/prefix.mdx @@ -1,4 +1,6 @@ -- `prefix (string : "")` ((#audit-option-prefix)) + + +**`prefix (string : "")`** Prepend the provided string to each log entry when writing to the audit device. diff --git a/website/content/partials/cli/shared/flags/log-file.mdx b/website/content/partials/cli/shared/flags/log-file.mdx index 07b5cda686..465716eba8 100644 --- a/website/content/partials/cli/shared/flags/log-file.mdx +++ b/website/content/partials/cli/shared/flags/log-file.mdx @@ -1,4 +1,6 @@ -- `-log-file (string : "./.log")` ((#shared-flag-log-file)) + + +**`-log-file (string : "./.log")`** Absolute path where Vault Agent saves logging data. diff --git a/website/content/partials/cli/shared/flags/log-rotate-bytes.mdx b/website/content/partials/cli/shared/flags/log-rotate-bytes.mdx index a73aaf7c71..c871442eb1 100644 --- a/website/content/partials/cli/shared/flags/log-rotate-bytes.mdx +++ b/website/content/partials/cli/shared/flags/log-rotate-bytes.mdx @@ -1,4 +1,6 @@ -- `-log-rotate-bytes (int : )` ((#shared-flag-log-rotate-bytes)) + + +**`-log-rotate-bytes (int : )`** File size, in bytes, after which log files must rotate. Leave `log-rotate-bytes` unset if you prefer not to limit log file size. diff --git a/website/content/partials/cli/shared/flags/log-rotate-duration.mdx b/website/content/partials/cli/shared/flags/log-rotate-duration.mdx index df5efa841d..487d3e7718 100644 --- a/website/content/partials/cli/shared/flags/log-rotate-duration.mdx +++ b/website/content/partials/cli/shared/flags/log-rotate-duration.mdx @@ -1,4 +1,6 @@ -- `-log-rotate-duration (string : "24h")` ((#shared-flag-log-rotate-duration)) + + +**`-log-rotate-duration (string : "24h")`** Amount of time, in `[s|m|h|d]` format, after which log files must rotate. diff --git a/website/content/partials/cli/shared/flags/log-rotate-max-files.mdx b/website/content/partials/cli/shared/flags/log-rotate-max-files.mdx index 34f3e32dc1..e0294617d0 100644 --- a/website/content/partials/cli/shared/flags/log-rotate-max-files.mdx +++ b/website/content/partials/cli/shared/flags/log-rotate-max-files.mdx @@ -1,4 +1,6 @@ -- `-log-rotate-max-files (int : 0)` ((#shared-flag-log-rotate-max-files)) + + +**`-log-rotate-max-files (int : 0)`** The number of log file archives to preserve over time: diff --git a/website/content/partials/global-settings/both/address.mdx b/website/content/partials/global-settings/both/address.mdx index 9827678ac2..86dbdf5a8d 100644 --- a/website/content/partials/global-settings/both/address.mdx +++ b/website/content/partials/global-settings/both/address.mdx @@ -1,4 +1,6 @@ -- `[-address | VAULT_ADDR] (string : 'https://127.0.0.1:8200')` ((#global-address)) + + +**`[-address | VAULT_ADDR] (string : 'https://127.0.0.1:8200')`** Address of the Vault server. @@ -6,4 +8,3 @@ Address of the Vault server. - CLI flag: `-address "https://mydomain/vault:8200"` - Environment variable: `export VAULT_ADDR="https://mydomain/vault:8200"` - diff --git a/website/content/partials/global-settings/both/agent-address.mdx b/website/content/partials/global-settings/both/agent-address.mdx index 8ac4ca3b8a..ba5f8de3dd 100644 --- a/website/content/partials/global-settings/both/agent-address.mdx +++ b/website/content/partials/global-settings/both/agent-address.mdx @@ -1,4 +1,6 @@ -- `[-agent-address | VAULT_AGENT_ADDR] (string : "")` ((#global-agent-address)) + + +**`[-agent-address | VAULT_AGENT_ADDR] (string : "")`** Address of the Vault Agent, if used. @@ -6,4 +8,3 @@ Address of the Vault Agent, if used. - CLI flag: `-agent-address "https://mydomain/vault-agent:8200"` - Environment variable: `export VAULT_AGENT_ADDR="https://mydomain/vault-agent:8200"` - diff --git a/website/content/partials/global-settings/both/ca-cert.mdx b/website/content/partials/global-settings/both/ca-cert.mdx index 2b754ee43b..d23ccb2345 100644 --- a/website/content/partials/global-settings/both/ca-cert.mdx +++ b/website/content/partials/global-settings/both/ca-cert.mdx @@ -1,4 +1,6 @@ -- `[-ca-cert | VAULT_CACERT] (string : "")` ((#global-ca-cert)) + + +**`[-ca-cert | VAULT_CACERT] (string : "")`** Path to a PEM-encoded CA certificate file on the local disk. Used to verify SSL certificates for the server. **Takes precedence over `-ca_path`**. @@ -7,4 +9,3 @@ certificates for the server. **Takes precedence over `-ca_path`**. - CLI flag: `-ca-cert "/path/to/certs/mycert.pem"` - Environment variable: `export VAULT_CACERT="/path/to/certs/mycert.pem"` - diff --git a/website/content/partials/global-settings/both/ca-path.mdx b/website/content/partials/global-settings/both/ca-path.mdx index 57d166edaa..e7efd349f3 100644 --- a/website/content/partials/global-settings/both/ca-path.mdx +++ b/website/content/partials/global-settings/both/ca-path.mdx @@ -1,4 +1,6 @@ -- `[-ca-path | VAULT_CAPATH] (string : "")` ((#global-ca-path)) + + +**`[-ca-path | VAULT_CAPATH] (string : "")`** Path to a directory with PEM-encoded CA certificate files on the local disk. Used to verify SSL certificates for the server. @@ -7,4 +9,3 @@ Used to verify SSL certificates for the server. - CLI flag: `-ca-path "/path/to/certs/dir"` - Environment variable: `export VAULT_CAPATH="/path/to/certs/dir"` - diff --git a/website/content/partials/global-settings/both/client-cert.mdx b/website/content/partials/global-settings/both/client-cert.mdx index 7435eab349..049d484623 100644 --- a/website/content/partials/global-settings/both/client-cert.mdx +++ b/website/content/partials/global-settings/both/client-cert.mdx @@ -1,4 +1,6 @@ -- `[-client-cert | VAULT_CLIENT_CERT] (string : "")` ((#global-client-cert)) + + +**`[-client-cert | VAULT_CLIENT_CERT] (string : "")`** Path to a PEM-encoded CA certificate file on the local disk. Used for TLS communication with the server. **The specified certificate must match to the @@ -8,4 +10,3 @@ private key specified with `-client-cert`**. - CLI flag: `-client-cert "/path/to/certs/mycert.pem"` - Environment variable: `export VAULT_CLIENT_CERT="/path/to/certs/mycert.pem"` - diff --git a/website/content/partials/global-settings/both/client-key.mdx b/website/content/partials/global-settings/both/client-key.mdx index b2940afd07..e3389874ea 100644 --- a/website/content/partials/global-settings/both/client-key.mdx +++ b/website/content/partials/global-settings/both/client-key.mdx @@ -1,4 +1,6 @@ -- `[-client-key | VAULT_CLIENT_KEY] (string : "")` ((#global-client-key)) + + +**`[-client-key | VAULT_CLIENT_KEY] (string : "")`** Path to a PEM-encoded private key that matches the client certificate set with `-client-cert`. @@ -7,4 +9,3 @@ Path to a PEM-encoded private key that matches the client certificate set with - CLI flag: `-client-key "/path/to/keys/myprivatekey.pem"` - Environment variable: `export VAULT_CLIENT_KEY="/path/to/keys/myprivatekey.pem"` - diff --git a/website/content/partials/global-settings/both/disable-redirects.mdx b/website/content/partials/global-settings/both/disable-redirects.mdx index 6a3739ef84..a9225e79e4 100644 --- a/website/content/partials/global-settings/both/disable-redirects.mdx +++ b/website/content/partials/global-settings/both/disable-redirects.mdx @@ -1,4 +1,6 @@ -- `[-disable-redirects | VAULT_DISABLE_REDIRECTS] (bool : false)` ((#global-disable-redirects)) + + +**`[-disable-redirects | VAULT_DISABLE_REDIRECTS] (bool : false)`** Disable the default CLI redirect behavior so the CLI honors the first redirect response from the underlying API instead of following the full HTTP redirect @@ -16,4 +18,3 @@ chain. misbehave. - diff --git a/website/content/partials/global-settings/both/format.mdx b/website/content/partials/global-settings/both/format.mdx index d37213dca4..3912e0458f 100644 --- a/website/content/partials/global-settings/both/format.mdx +++ b/website/content/partials/global-settings/both/format.mdx @@ -1,4 +1,6 @@ -- `[-format | VAULT_FORMAT] (enum: table)` ((#global-format)) + + +**`[-format | VAULT_FORMAT] (enum: table)`** Set the CLI output format. @@ -13,4 +15,3 @@ Value | Description - CLI flag: `-format json` - Environment variable: `export VAULT_FORMAT=json` - diff --git a/website/content/partials/global-settings/both/log-format.mdx b/website/content/partials/global-settings/both/log-format.mdx index 0cc0c78885..8f960d7568 100644 --- a/website/content/partials/global-settings/both/log-format.mdx +++ b/website/content/partials/global-settings/both/log-format.mdx @@ -1,4 +1,6 @@ -- `[-log-format | VAULT_LOG_FORMAT] (enum : standard)` ((#global-log-format)) + + +**`[-log-format | VAULT_LOG_FORMAT] (enum : standard)`** Format of log data: diff --git a/website/content/partials/global-settings/both/log-level.mdx b/website/content/partials/global-settings/both/log-level.mdx index a6221d710f..8f5300cd30 100644 --- a/website/content/partials/global-settings/both/log-level.mdx +++ b/website/content/partials/global-settings/both/log-level.mdx @@ -1,4 +1,6 @@ -- `[-log-level | VAULT_LOG_LEVEL] (enum : info)` ((#global-vault_log-level)) + + +**`[-log-level | VAULT_LOG_LEVEL] (enum : info)`** Default logging level for the Vault server. @@ -14,4 +16,3 @@ Enum | Logging behavior - CLI flag: `-log-level debug` - Environment variable: `export VAULT_LOG_LEVEL=debug` - diff --git a/website/content/partials/global-settings/both/mfa.mdx b/website/content/partials/global-settings/both/mfa.mdx index 0500797f8d..bd0bf79b74 100644 --- a/website/content/partials/global-settings/both/mfa.mdx +++ b/website/content/partials/global-settings/both/mfa.mdx @@ -1,4 +1,6 @@ -- `[-mfa | VAULT_MFA] (string : "")` ((#global-mfa)) + + +**`[-mfa | VAULT_MFA] (string : "")`** A multi-factor authentication (MFA) credential, in the format `mfa_method_name[:key[=value]]`, that the CLI should use to authenticate to @@ -17,5 +19,3 @@ underlying API endpoint. MFA methods, use the `-mfa` CLI flag and repeat the flag as needed. - - diff --git a/website/content/partials/global-settings/both/namespace.mdx b/website/content/partials/global-settings/both/namespace.mdx index 89f3c122c8..e5d463560c 100644 --- a/website/content/partials/global-settings/both/namespace.mdx +++ b/website/content/partials/global-settings/both/namespace.mdx @@ -1,4 +1,6 @@ -- `[-namespace | -ns | VAULT_NAMESPACE] (string : )` ((#global-namespace)) + + +**`[-namespace | -ns | VAULT_NAMESPACE] (string : )`** Root namespace for the CLI command. Setting a default namespace allow relative mount paths. @@ -7,4 +9,3 @@ mount paths. - CLI flag: `-namespace "admin"` - Environment variable: `export VAULT_NAMESPACE="admin"` - diff --git a/website/content/partials/global-settings/both/tls-server-name.mdx b/website/content/partials/global-settings/both/tls-server-name.mdx index 8646968cde..edafe13781 100644 --- a/website/content/partials/global-settings/both/tls-server-name.mdx +++ b/website/content/partials/global-settings/both/tls-server-name.mdx @@ -1,4 +1,6 @@ -- `[-tls-server-name | VAULT_TLS_SERVER_NAME] (string : "")` ((#global-tls-server-name)) + + +**`[-tls-server-name | VAULT_TLS_SERVER_NAME] (string : "")`** Name of the SNI host for TLS handshake resolution for TLS connections to Vault. @@ -6,4 +8,3 @@ Name of the SNI host for TLS handshake resolution for TLS connections to Vault. - CLI flag: `-tls-server-name "hostname.domain"` - Environment variable: `export VAULT_TLS_SERVER_NAME="hostname.domain"` - diff --git a/website/content/partials/global-settings/both/tls-skip-verify.mdx b/website/content/partials/global-settings/both/tls-skip-verify.mdx index fb9782831e..be3a2c1f37 100644 --- a/website/content/partials/global-settings/both/tls-skip-verify.mdx +++ b/website/content/partials/global-settings/both/tls-skip-verify.mdx @@ -1,4 +1,6 @@ -- `[-tls-skip-verify | VAULT_SKIP_VERIFY] (bool : false)` ((#global-tls-skip-verify)) + + +**`[-tls-skip-verify | VAULT_SKIP_VERIFY] (bool : false)`** Disable verification for all TLS certificates. **Use with caution**. Disabling TLS certificate verification decreases the security of data transmissions to and @@ -8,4 +10,3 @@ from the Vault server. - CLI flag: `-tls-skip-verify` - Environment variable: `export VAULT_SKIP_VERIFY=1` - diff --git a/website/content/partials/global-settings/both/wrap-ttl.mdx b/website/content/partials/global-settings/both/wrap-ttl.mdx index cfc5d27baf..ac2104fedc 100644 --- a/website/content/partials/global-settings/both/wrap-ttl.mdx +++ b/website/content/partials/global-settings/both/wrap-ttl.mdx @@ -1,4 +1,6 @@ -- `[-wrap-ttl | VAULT_WRAP_TTL] (string : "")` ((#global-wrap-ttl)) + + +**`[-wrap-ttl | VAULT_WRAP_TTL] (string : "")`** Default time-to-live in `[s|m|h|d]` format for the Cubbyhole token used to wrap CLI responses. You must use `vault unwrap` to view response data before @@ -8,4 +10,3 @@ the duration expires. Leave `wrap_ttl` unset to leave CLI responses unwrapped. - CLI flag: `-wrap-ttl "5m"` - Environment variable: `export VAULT_WRAP_TTL="5m"` - diff --git a/website/content/partials/global-settings/env/cli_no_color.mdx b/website/content/partials/global-settings/env/cli_no_color.mdx index 4fd725c371..e840e5490a 100644 --- a/website/content/partials/global-settings/env/cli_no_color.mdx +++ b/website/content/partials/global-settings/env/cli_no_color.mdx @@ -1,7 +1,7 @@ -- `VAULT_CLI_NO_COLOR (bool : true)` ((#global-cli_no_color)) + + +**`VAULT_CLI_NO_COLOR (bool : true)`** Exclude ANSI color escape sequence characters from the CLI output. **Example**: `export VAULT_CLI_NO_COLOR=0` - - diff --git a/website/content/partials/global-settings/env/client_timeout.mdx b/website/content/partials/global-settings/env/client_timeout.mdx index bef1b5e2a0..1fb2f6a1be 100644 --- a/website/content/partials/global-settings/env/client_timeout.mdx +++ b/website/content/partials/global-settings/env/client_timeout.mdx @@ -1,7 +1,8 @@ -- `VAULT_CLIENT_TIMEOUT (string : "60s")` ((#standard-vault_client_timeout)) + + +**`VAULT_CLIENT_TIMEOUT (string : "60s")`** Amount of time, in `[s|m|h|d]` format, the CLI should wait on a response from Vault. **Example**: `export VAULT_CLIENT_TIMEOUT="2m"` - diff --git a/website/content/partials/global-settings/env/cluster_addr.mdx b/website/content/partials/global-settings/env/cluster_addr.mdx index 7f1d356ea9..2bdbebeb70 100644 --- a/website/content/partials/global-settings/env/cluster_addr.mdx +++ b/website/content/partials/global-settings/env/cluster_addr.mdx @@ -1,7 +1,8 @@ -- `VAULT_CLUSTER_ADDR (string : "")` ((#global-vault_cluster_addr)) + + +**`VAULT_CLUSTER_ADDR (string : "")`** Address of the local Vault node. Vault uses cluster addresses for cluster-to-cluster communication when running in high-availability mode. **Example**: `export VAULT_CLUSTER_ADDR="https://127.0.0.1:8201"` - diff --git a/website/content/partials/global-settings/env/http_proxy.mdx b/website/content/partials/global-settings/env/http_proxy.mdx index ae313c06ab..5d5de6f53d 100644 --- a/website/content/partials/global-settings/env/http_proxy.mdx +++ b/website/content/partials/global-settings/env/http_proxy.mdx @@ -1,5 +1,5 @@ -- `VAULT_HTTP_PROXY (string : "")` ((#global-vault_http_proxy)) + + +**`VAULT_HTTP_PROXY (string : "")`** Legacy alias for `VAULT_PROXY_ADDR`. - - diff --git a/website/content/partials/global-settings/env/license.mdx b/website/content/partials/global-settings/env/license.mdx index 81dd46a12e..6c66d400b9 100644 --- a/website/content/partials/global-settings/env/license.mdx +++ b/website/content/partials/global-settings/env/license.mdx @@ -1,12 +1,9 @@ -- `VAULT_LICENSE (string : "")` ((#global-vault_license)) + + +**`VAULT_LICENSE (string : "")`** Vault Enterprise license string for the local server or node. `VAULT_LICENSE` takes precedence over `VAULT_LICENSE_PATH` **and** the `license_path` parameter in the Vault configuration file. **Example**: `export VAULT_LICENSE="02MV4UU43BK5..."` - - - - - diff --git a/website/content/partials/global-settings/env/license_path.mdx b/website/content/partials/global-settings/env/license_path.mdx index 99094ec61e..ae4d61faaa 100644 --- a/website/content/partials/global-settings/env/license_path.mdx +++ b/website/content/partials/global-settings/env/license_path.mdx @@ -1,4 +1,6 @@ -- `VAULT_LICENSE_PATH (string : "")` ((#global-vault_license_path)) + + +**`VAULT_LICENSE_PATH (string : "")`** Local path to a file containing a valid Vault Enterprise license for the server or node. `VAULT_LICENSE_PATH` takes precedence over the `license_path` parameter diff --git a/website/content/partials/global-settings/env/max_retries.mdx b/website/content/partials/global-settings/env/max_retries.mdx index dfae44fbad..111126a153 100644 --- a/website/content/partials/global-settings/env/max_retries.mdx +++ b/website/content/partials/global-settings/env/max_retries.mdx @@ -1,4 +1,6 @@ -- `VAULT_MAX_RETRIES (integer : 2)` ((#global-vault_max_retries)) + + +**`VAULT_MAX_RETRIES (integer : 2)`** The number of times the CLI should retry a request to the Vault server when the CLI receives one of the following recoverable error codes: diff --git a/website/content/partials/global-settings/env/proxy_addr.mdx b/website/content/partials/global-settings/env/proxy_addr.mdx index d67e59d074..eb862b0b1d 100644 --- a/website/content/partials/global-settings/env/proxy_addr.mdx +++ b/website/content/partials/global-settings/env/proxy_addr.mdx @@ -1,4 +1,6 @@ -- `VAULT_PROXY_ADDR (string : "")` ((#global-vault_proxy_addr)) + + +**`VAULT_PROXY_ADDR (string : "")`** The HTTPS or HTTP address, including server and port, where clients can access Vault. Setting `VAULT_HTTP_PROXY` overrides the default proxy resolution diff --git a/website/content/partials/global-settings/env/rate_limit.mdx b/website/content/partials/global-settings/env/rate_limit.mdx index 4271f6a46e..1fde590935 100644 --- a/website/content/partials/global-settings/env/rate_limit.mdx +++ b/website/content/partials/global-settings/env/rate_limit.mdx @@ -1,4 +1,6 @@ -- `VAULT_RATE_LIMIT (string : unset)` ((#global-vault_rate_limit)) + + +**`VAULT_RATE_LIMIT (string : unset)`** The number of operations per second, in `rate[:burst]` format, used to throttle requests between the CLI and the server. The `burst` value is optional and diff --git a/website/content/partials/global-settings/env/redirect_addr.mdx b/website/content/partials/global-settings/env/redirect_addr.mdx index 7bb8bff43e..7c400efb6d 100644 --- a/website/content/partials/global-settings/env/redirect_addr.mdx +++ b/website/content/partials/global-settings/env/redirect_addr.mdx @@ -1,4 +1,6 @@ -- `VAULT_REDIRECT_ADDR (string : "")` ((#global-vault_redirect_addr)) + + +**`VAULT_REDIRECT_ADDR (string : "")`** Local node address that listens for redirected client communication when Vault runs in high-availability mode. diff --git a/website/content/partials/global-settings/env/skip_verify.mdx b/website/content/partials/global-settings/env/skip_verify.mdx index 62d7dc6ef2..86e7ec9295 100644 --- a/website/content/partials/global-settings/env/skip_verify.mdx +++ b/website/content/partials/global-settings/env/skip_verify.mdx @@ -1,4 +1,6 @@ -- `VAULT_SKIP_VERIFY (bool : false)` ((#global-vault_skip_verify)) + + +**`VAULT_SKIP_VERIFY (bool : false)`** Allow communication between the CLI and Vault server before verifying the authentication certificate presented by Vault. diff --git a/website/content/partials/global-settings/env/srv_lookup.mdx b/website/content/partials/global-settings/env/srv_lookup.mdx index 18d23b4813..195ce532d5 100644 --- a/website/content/partials/global-settings/env/srv_lookup.mdx +++ b/website/content/partials/global-settings/env/srv_lookup.mdx @@ -1,4 +1,6 @@ -- `VAULT_SRV_LOOKUP (bool : false)` ((#global-vault_srv_lookup)) + + +**`VAULT_SRV_LOOKUP (bool : false)`** Use SRV records instead of standard DNS to look up hostnames as described in the Network Working Group draft diff --git a/website/content/partials/global-settings/env/token.mdx b/website/content/partials/global-settings/env/token.mdx index 79b8995bcc..11e1161899 100644 --- a/website/content/partials/global-settings/env/token.mdx +++ b/website/content/partials/global-settings/env/token.mdx @@ -1,4 +1,6 @@ -- `VAULT_TOKEN (string : "")` ((#global-vault_token)) + + +**`VAULT_TOKEN (string : "")`** A Vault-issued service token that authenticates the CLI user to Vault. See the [tokens concepts page](/vault/docs/concepts/tokens) for more information diff --git a/website/content/partials/global-settings/flags/header.mdx b/website/content/partials/global-settings/flags/header.mdx index 53d7b87528..3699d39447 100644 --- a/website/content/partials/global-settings/flags/header.mdx +++ b/website/content/partials/global-settings/flags/header.mdx @@ -1,4 +1,6 @@ -- `-header (string : "")` ((#global-header)) + + +**`-header (string : "")`** Optional HTTP header in the form `"="` for the CLI request. Repeat the `-header` flag as needed with one string per flag. User-defined headers diff --git a/website/content/partials/global-settings/flags/non-interactive.mdx b/website/content/partials/global-settings/flags/non-interactive.mdx index 5ff01ff591..43725e8ad7 100644 --- a/website/content/partials/global-settings/flags/non-interactive.mdx +++ b/website/content/partials/global-settings/flags/non-interactive.mdx @@ -1,4 +1,6 @@ -- `-non-interactive (bool : false)` ((#global-non-interactive)) + + +**`-non-interactive (bool : false)`** Prevent the CLI from asking users for input through the terminal. diff --git a/website/content/partials/global-settings/flags/output-curl-string.mdx b/website/content/partials/global-settings/flags/output-curl-string.mdx index 692fe3a89e..a10a86f01b 100644 --- a/website/content/partials/global-settings/flags/output-curl-string.mdx +++ b/website/content/partials/global-settings/flags/output-curl-string.mdx @@ -1,4 +1,6 @@ -- `-output-curl-string (bool : false)` ((#global-output-curl-string)) + + +**`-output-curl-string (bool : false)`** Print the API call(s) required to execute the CLI command as `cURL` strings then exit without running the command. diff --git a/website/content/partials/global-settings/flags/output-policy.mdx b/website/content/partials/global-settings/flags/output-policy.mdx index 171f6bb795..457a178690 100644 --- a/website/content/partials/global-settings/flags/output-policy.mdx +++ b/website/content/partials/global-settings/flags/output-policy.mdx @@ -1,4 +1,6 @@ -- `-output-policy (bool : false)` ((#global-output-policy)) + + +**`-output-policy (bool : false)`** Print the Vault policy required to execute the CLI command as HCL then exit without running the command. diff --git a/website/content/partials/global-settings/flags/policy-override.mdx b/website/content/partials/global-settings/flags/policy-override.mdx index 23caa939c6..1d129e16c7 100644 --- a/website/content/partials/global-settings/flags/policy-override.mdx +++ b/website/content/partials/global-settings/flags/policy-override.mdx @@ -1,6 +1,7 @@ -- `-policy-override (bool : false)` ((#global-policy-override)) + + +**`-policy-override (bool : false)`** Overrides any Sentinel policy where `enforcement_level` is "soft-mandatory". **Example**: `-policy-override` - diff --git a/website/content/partials/global-settings/flags/unlock-key.mdx b/website/content/partials/global-settings/flags/unlock-key.mdx index bb6dec5e06..38f8c01e3d 100644 --- a/website/content/partials/global-settings/flags/unlock-key.mdx +++ b/website/content/partials/global-settings/flags/unlock-key.mdx @@ -1,4 +1,6 @@ -- `-unlock-key (string : )` ((#global-unlock-key)) + + +**`-unlock-key (string : )`** Plaintext key that unlocks the underlying API endpoint for a given namespace.