Backport of docs/consul: rename the Vault secret engine for Consul integration into release/1.13.x #20136
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
There was feedback from our Support team about customers facing an issue following the documentation from the Vault for Consul: System integration into the Vault for Consul: Data integration. The former defines a
consul
-named Vault secret engine, but the latter runs commands and config against asecrets
-named Vault secret engine - no doubt a leftover from times where the default secret engine from running Vault in-dev
mode was used to showcase functionality in the docs.Furthermore, because of the secret engine name
consul
, the customers were confused and expected the secret engine to be of the Consul type and not the KV type.With that in mind, this PR changes the docs in the following way:
consul-kv
secrets
is being used for all token-related configuration so that in Production environments, that specific path can be allowed/disallowed read/write access easier for separate admin and non-admin user roles.Testing & Reproduction steps
N/A
Links
Related Docs: Vault as the Secrets Backend (K8s)
PR Checklist