-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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
Docs: Add updated screenshots to kv subkey docs #29067
base: main
Are you sure you want to change the base?
Conversation
Build Results: |
CI Results: |
@@ -1,4 +1,4 @@ | |||
- Open the data page for your `kv` plugin: | |||
- Navigate to your `kv` plugin: |
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.
Feel free to revert, but I removed "data" here because "metadata" and "data" are key words in kv v2 and get confused a lot. In this engine it seems helpful to remove data
unless we're talking specifically about "secret data" or endpoints that include /data/
.
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.
Can you elaborate on the source of the confusion? They may be keywords, but "data" is also an English word that accurately describes the stuff stored in the kv plugin. I'm not against changing things to clarify, but avoiding the word altogether doesn't feel like a reasonable long-term solution.
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.
Sure! I don't mean we should remove the use of data
all together, but I think in regards to kv v2 specifically we should be intentional how we use it. Since kv v2 plugins store "secret data" and "metadata," using "data" to encompass both can be confusing.
Most of the time this distinction will probably just be important internally. However, in this context it sounds like users are navigating to secret data
, which is not true (anymore). Now the overview page exists as a intermediary layer and clicking a secret path from the list no longer directs users to the "data page."
The overview was added as an additional layer of security so users with read
capabilities to :engine/data/:secret_path
wouldn't inadvertently read sensitive secret values when clicking into a secret path. So while the overview technically contains data about the secret, the "data" distinction is important here so we're clear it's not secret data.
Happy to discuss over zoom if that's easier 😄
@@ -9,6 +9,4 @@ | |||
|
|||
1. Select the mount path for your `kv` plugin. | |||
|
|||
1. Click through the path segments to select the relevant secret path. | |||
|
|||
1. Select the **Secret** tab |
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.
Now that the kv engine includes an "overview" page, some actions require navigating to the "Secrets" tab while others can be done from the overview. I updated the various sub-steps to include or not include this step accordingly, but let me know if this should be reverted!
Description
Preview here.
READ :engine/data/:secret_path
endpoint and not the/subkeys
one)Reveal subkeys
toggled on which is the second place in the GUI where subkeys are viewableTODO only if you're a HashiCorp employee
backport/
label that matches the desired release branch. Note that in the CE repo, the latest release branch will look likebackport/x.x.x
, but older release branches will bebackport/ent/x.x.x+ent
.of a public function, even if that change is in a CE file, double check that
applying the patch for this PR to the ENT repo and running tests doesn't
break any tests. Sometimes ENT only tests rely on public functions in CE
files.
in the PR description, commit message, or branch name.
description. Also, make sure the changelog is in this PR, not in your ENT PR.