Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Backport of docs/consul: rename the Vault secret engine for Consul integration into release/1.13.x #20136

Conversation

krastin
Copy link
Contributor

@krastin krastin commented Jan 9, 2024

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 a secrets-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:

  • The Vault secret engine created for use with Consul has been renamed to consul-kv
    • to stress the fact that it is a KV type engine and not a Consul type engine
    • to move away from the default secrets engine as this would be unadvisable to run in Production systems, and possibly even dangerous if the default secrets engine is indeed being used
  • The path 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

  • updated test coverage
  • external facing docs updated
  • appropriate backport labels added
  • not a security concern

krastin and others added 2 commits January 5, 2024 14:10
…ashicorp#20049)

* rename the KV secret engine

* update WAN federation guide

* update snapshot-agent doc

* update replication doc

* update partition doc

* update gossip doc

* update ent-license doc

* update bootstrap-token doc

* update index doc

* fix license kv path

* vault kv path explanation for /data/

* Update website/content/docs/k8s/deployment-configurations/vault/data-integration/index.mdx

Co-authored-by: Jeff Boruszak <[email protected]>

---------

Co-authored-by: Jeff Boruszak <[email protected]>
@krastin krastin added type/docs Documentation needs to be created/updated/clarified pr/no-changelog PR does not need a corresponding .changelog entry pr/no-metrics-test pr/no-backport labels Jan 9, 2024
@krastin krastin requested a review from boruszak January 9, 2024 20:56
@krastin krastin self-assigned this Jan 9, 2024
@hc-github-team-consul-core
Copy link
Collaborator

🤔 This PR has changes in the website/ directory but does not have a type/docs-cherrypick label. If the changes are for the next version, this can be ignored. If they are updates to current docs, attach the label to auto cherrypick to the stable-website branch after merging.

@krastin krastin closed this Jan 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr/no-backport pr/no-changelog PR does not need a corresponding .changelog entry pr/no-metrics-test type/docs Documentation needs to be created/updated/clarified
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants