-
Notifications
You must be signed in to change notification settings - Fork 4.1k
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
Use new -mount syntax for all KV subcommands in 1.11 docs #16002
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
taoism4504
reviewed
Jun 15, 2022
taoism4504
reviewed
Jun 15, 2022
taoism4504
reviewed
Jun 15, 2022
taoism4504
reviewed
Jun 15, 2022
taoism4504
reviewed
Jun 15, 2022
taoism4504
reviewed
Jun 15, 2022
taoism4504
reviewed
Jun 15, 2022
taoism4504
reviewed
Jun 15, 2022
taoism4504
reviewed
Jun 15, 2022
taoism4504
reviewed
Jun 15, 2022
taoism4504
reviewed
Jun 15, 2022
taoism4504
reviewed
Jun 15, 2022
taoism4504
reviewed
Jun 15, 2022
taoism4504
approved these changes
Jun 15, 2022
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
minor nits, but otherwise LGTM
digivava
added a commit
that referenced
this pull request
Jun 15, 2022
* Use new -mount syntax for all KV subcommands in 1.11 docs * Use more appropriate heading size for mount flag syntax * Add the explanatory syntax blurb from the -help text * Adjust some wording
digivava
added a commit
that referenced
this pull request
Jun 15, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I have updated all docs pages dealing with the KV CLI to use the new
-mount
flag syntax, which was created to mitigate confusion caused by the previous syntax for interacting with KV secrets in the CLI.These docs pages will now match the text produced by calling a vault kv subcommand with the
-help
flag.Background
This syntax is optional, allowing users to do
vault kv get -mount=secret foo
instead of the oldvault kv get secret/foo
. While the old way may look prettier, it turned out this syntax caused a lot of confusion for new users, who quickly run into issues caused by the fact thatsecret/foo
looks like a path but is not actually the real path to the secret for KV v2 (secret/data/foo
). The real path is used by policies and the API, so users fresh off the Getting Started guide often don't understand why their policies or CLI commands don't work when they try to use the same "path" for both.Caveats
I continued to use the old syntax on the index page for CLI commands in general, since that page is aimed at showcasing concepts that are true across all Vault CLI commands. This mount flag syntax only works for the kv subcommands, so I didn't want to muddy the message of that page. So, on that page I call out the existence of this flag in a KV-specific paragraph down below, but otherwise leave those examples alone.