Docs/mount namespace entry size (#26119)

* Update documentation for namespace/mount entry size limit

* Clarify defaults

* Better wording for storage size partial that appears on different pages

* Active voice!

* No this

* Fix confusing terminology
This commit is contained in:
Paul Banks 2024-04-08 12:43:07 +01:00 committed by GitHub
parent ec7b0335df
commit 9c12a6acc7
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 40 additions and 22 deletions

View file

@ -110,15 +110,16 @@ delay) mode. The maximum allowed value is 10.
See [the section below](#retry_join-stanza) for the parameters accepted by the
[`retry_join`](#retry_join-stanza) stanza.
- `retry_join_as_non_voter` `(boolean: false)` - If set, causes any `retry_join`
config to join the Raft cluster as a non-voter. The node will not participate
in the Raft quorum but will still receive the data replication stream, adding
read scalability to a cluster. This option has the same effect as the
[`-non-voter`](/vault/docs/commands/operator/raft#non-voter) flag for the
`vault operator raft join` command, but only affects voting status when joining
via `retry_join` config. This setting can be overridden to true by setting the
`VAULT_RAFT_RETRY_JOIN_AS_NON_VOTER` environment variable to any non-empty value.
Only valid if there is at least one `retry_join` stanza.
- `retry_join_as_non_voter` `(boolean: false)` - <EnterpriseAlert inline />
Configures this node as a permanent non-voter. The node will not participate
in the Raft quorum but will still receive the data replication stream
enhancing the read throughput of the cluster. This option has the same effect
as the [`-non-voter`](/vault/docs/commands/operator/raft#non-voter) flag for
the `vault operator raft join` command, but only affects voting status when
joining via `retry_join` config. You can override the non-voter configuration
by setting the `VAULT_RAFT_RETRY_JOIN_AS_NON_VOTER` environment variable to
any non-empty value. Configuring a node as a non-voter is only valid if there
is at least one `retry_join` stanza.
- `max_entry_size` `(integer: 1048576)` - This configures the maximum number of
bytes for a Raft entry. It applies to both Put operations and transactions.
@ -135,6 +136,16 @@ delay) mode. The maximum allowed value is 10.
default to a value larger than the Integrated Storage default of 1MB, then you will
need to make the same change in Vault's Integrated Storage config.
- `max_mount_and_namespace_table_entry_size` `(integer)`- <EnterpriseAlert
inline /> Overrides `max_entry_size` to set a different limit for the specific
storage entries that contain mount tables, auth tables and namespace
configuration data. If you are reaching limits on the mount table size, you
can use this to increase the number of mounts and namespaces that can be
stored without the risk of other storage entries becoming too large. All other
notes on [`max_entry_size`](#max-entry-size) apply. Before changing this, read
the [/vault/docs/enterprise/namespaces/namespace-limits](Run Vault Enterprise
with many namespaces) guide regarding important performance considerations.
- `autopilot_reconcile_interval` `(string: "10s")` - This is the interval after
which autopilot will pick up any state changes. State change could mean multiple
things; for example a newly joined voter node, initially added as non-voter to
@ -149,17 +160,16 @@ delay) mode. The maximum allowed value is 10.
configuration, known servers, latest raft index, and stats for all the known servers.
The information that autopilot receives will be used to calculate its next state.
- `autopilot_upgrade_version` `(string: "")` - This is an optional string that, if
provided, will be used reported to autopilot as Vault's version. This is then used
by autopilot when it makes decisions regarding
[automated upgrades](/vault/docs/enterprise/automated-upgrades). If omitted, the
version of Vault currently in use will be used. Note that this string must conform
to [Semantic Versioning](https://semver.org). Use of this feature requires Vault
Enterprise.
- `autopilot_upgrade_version` `(string: "")` - <EnterpriseAlert inline />
Overrides the version used by Autopilot during [automated
upgrades](/vault/docs/enterprise/automated-upgrades). Vault's build version is
used by default. The string provided must be a valid [Semantic
Version](https://semver.org).
- `autopilot_redundancy_zone` `(string: "")` - This is an optional string that specifies
Vault's [redundancy zone](/vault/docs/enterprise/redundancy-zones). This is reported to autopilot
and is used to enhance scaling and resiliency. Use of this feature requires Vault Enterprise.
- `autopilot_redundancy_zone` `(string: "")` - <EnterpriseAlert inline />
Specifies a [redundancy zone](/vault/docs/enterprise/redundancy-zones) which
is used by Autopilot to automatically swap out failed servers for enhanced
reliability.
<Warning title="Experimental">

View file

@ -3,9 +3,17 @@ by that backend.
The default entry size limit for the integrated storage backend, is 1 MiB. You
can configure the allowable entry size with the `max_entry_size` parameter in
your the [storage stanza](/vault/docs/configuration/storage/raft#max_entry_size).
Vault automatically chunks any storage entry that is larger than 512 KiB but
smaller than `max_entry_size` into smaller pieces before writing the entry to Raft.
your the [storage
stanza](/vault/docs/configuration/storage/raft#max_entry_size). Vault
automatically chunks any storage entry that is larger than 512 KiB but smaller
than `max_entry_size` into smaller pieces before writing the entry to Raft.
Vault Enterprise 1.17 and higher also exposes a
`max_mount_and_namespace_table_entry_size` configuration that can increase the
size limit just for KV entries that store mount table and namespace metadata. If
you need to increase mount table size beyond the default value, we recommend
increasing `max_mount_and_namespace_table_entry_size` over `max_entry_size` to
avoid unintentionally allowing other storage entries to grow very large.
For Vault deployments using the Consul storage backend, the default entry size
limit is 512 KiB. The default size is enforced by Consul rather than Vault. You