diff --git a/website/content/docs/auth/saml/adfs.mdx b/website/content/docs/auth/saml/adfs.mdx index bd3e606918f2..137ac2a1785a 100644 --- a/website/content/docs/auth/saml/adfs.mdx +++ b/website/content/docs/auth/saml/adfs.mdx @@ -55,7 +55,7 @@ Configure your Vault instance to work with Active Directory Federation Services -@include 'gui-page-instructions/enable-authn-plugin.mdx' +@include 'gui-instructions/enable-authn-plugin.mdx' - Enable the SAML plugin: diff --git a/website/content/docs/auth/saml/link-vault-group-to-ad.mdx b/website/content/docs/auth/saml/link-vault-group-to-ad.mdx index 47c4e516b9d9..0e9e5274b8f7 100644 --- a/website/content/docs/auth/saml/link-vault-group-to-ad.mdx +++ b/website/content/docs/auth/saml/link-vault-group-to-ad.mdx @@ -52,7 +52,7 @@ $ vault secrets enable -path=adfs-kv kv-v2 -@include 'gui-page-instructions/enable-secrets-plugin.mdx' +@include 'gui-instructions/enable-secrets-plugin.mdx' - Enable the KV plugin: @@ -102,7 +102,7 @@ EOF -@include 'gui-page-instructions/create-acl-policy.mdx' +@include 'gui-instructions/create-acl-policy.mdx' - Set the policy details and click **Create policy**: @@ -161,7 +161,7 @@ EOF -@include 'gui-page-instructions/create-group.mdx' +@include 'gui-instructions/create-group.mdx' - Follow the prompts to create an external group with the following information: diff --git a/website/content/docs/secrets/kv/kv-v2/cookbook/custom-metadata.mdx b/website/content/docs/secrets/kv/kv-v2/cookbook/custom-metadata.mdx index 849a6277e583..0aae6bca0ee0 100644 --- a/website/content/docs/secrets/kv/kv-v2/cookbook/custom-metadata.mdx +++ b/website/content/docs/secrets/kv/kv-v2/cookbook/custom-metadata.mdx @@ -85,9 +85,8 @@ destroyed false -@include 'gui-page-instructions/select-kv-mount.mdx' +@include 'gui-instructions/plugins/kv/open-overview.mdx' -- Click through the path segments to select the relevant secret path. - Select the **Metadata** tab. - Click **Edit metadata >**. - Set a new key name and value under **Custom metadata**. diff --git a/website/content/docs/secrets/kv/kv-v2/cookbook/delete-data.mdx b/website/content/docs/secrets/kv/kv-v2/cookbook/delete-data.mdx index d2819d304b0d..2a2907e7e745 100644 --- a/website/content/docs/secrets/kv/kv-v2/cookbook/delete-data.mdx +++ b/website/content/docs/secrets/kv/kv-v2/cookbook/delete-data.mdx @@ -95,9 +95,9 @@ destroyed false -@include 'gui-page-instructions/select-kv-mount.mdx' +@include 'gui-instructions/plugins/kv/open-overview.mdx' -- Click through the path segments to select the relevant secret path. +- Select the **Secret** tab. - Select the appropriate data version from the **Version** dropdown. - Click **Delete**. - Select **Delete this version** to delete the selected version or diff --git a/website/content/docs/secrets/kv/kv-v2/cookbook/destroy-data.mdx b/website/content/docs/secrets/kv/kv-v2/cookbook/destroy-data.mdx index 8bcd2b4052f1..c0dc4be39b98 100644 --- a/website/content/docs/secrets/kv/kv-v2/cookbook/destroy-data.mdx +++ b/website/content/docs/secrets/kv/kv-v2/cookbook/destroy-data.mdx @@ -92,9 +92,9 @@ destroyed true -@include 'gui-page-instructions/select-kv-mount.mdx' +@include 'gui-instructions/plugins/kv/open-overview.mdx' -- Click through the path segments to select the relevant secret path. +- Select the **Secret** tab. - Select the appropriate data version from the **Version** dropdown. - Click **Destroy**. - Click **Confirm**. diff --git a/website/content/docs/secrets/kv/kv-v2/cookbook/max-versions.mdx b/website/content/docs/secrets/kv/kv-v2/cookbook/max-versions.mdx index f7763f94db4a..81c50158a50c 100644 --- a/website/content/docs/secrets/kv/kv-v2/cookbook/max-versions.mdx +++ b/website/content/docs/secrets/kv/kv-v2/cookbook/max-versions.mdx @@ -84,9 +84,8 @@ destroyed false -@include 'gui-page-instructions/select-kv-mount.mdx' +@include 'gui-instructions/plugins/kv/open-overview.mdx' -- Click through the path segments to select the relevant secret path. - Select the **Metadata** tab. - Click **Edit metadata >**. - Update the **Maximum number of versions** field. diff --git a/website/content/docs/secrets/kv/kv-v2/cookbook/patch-data.mdx b/website/content/docs/secrets/kv/kv-v2/cookbook/patch-data.mdx index fdceefc632eb..bf3e1ce3d4cb 100644 --- a/website/content/docs/secrets/kv/kv-v2/cookbook/patch-data.mdx +++ b/website/content/docs/secrets/kv/kv-v2/cookbook/patch-data.mdx @@ -114,9 +114,10 @@ push the update to the plugin. @include 'alerts/enterprise-only.mdx' -@include 'gui-page-instructions/select-kv-data.mdx' +@include 'gui-instructions/plugins/kv/open-overview.mdx' -- Click **Patch latest version +** on the key/value page. +- Select the **Secret** tab. +- Click **Patch latest version +**. - Edit the values you want to update. - Click **Save**. diff --git a/website/content/docs/secrets/kv/kv-v2/cookbook/read-data.mdx b/website/content/docs/secrets/kv/kv-v2/cookbook/read-data.mdx index 19763bd7f077..161cecb12685 100644 --- a/website/content/docs/secrets/kv/kv-v2/cookbook/read-data.mdx +++ b/website/content/docs/secrets/kv/kv-v2/cookbook/read-data.mdx @@ -82,9 +82,9 @@ $ vault kv get -mount shared -field prod dev/square-api -@include 'gui-page-instructions/select-kv-mount.mdx' +@include 'gui-instructions/plugins/kv/open-overview.mdx' -- Click through the path segments to select the relevant secret path. +- Select the **Secret** tab. - Click the eye icon to view the desired key value. ![Partial screenshot of the Vault GUI showing two key/value pairs at the path dev/square-api. The "prod" key is visible](/img/gui/kv/read-data.png) diff --git a/website/content/docs/secrets/kv/kv-v2/cookbook/read-subkey.mdx b/website/content/docs/secrets/kv/kv-v2/cookbook/read-subkey.mdx index 9820bf7702be..3708c48a5cf1 100644 --- a/website/content/docs/secrets/kv/kv-v2/cookbook/read-subkey.mdx +++ b/website/content/docs/secrets/kv/kv-v2/cookbook/read-subkey.mdx @@ -21,8 +21,8 @@ Read the available subkeys on an existing data path in the `kv` v2 plugin. -Use `vault read` with the `/subkeys` metadata path retrieve a list of available -subkeys on the given path. +Use `vault read` with the `/subkeys` path to retrieve a list of secret data +subkeys at the given path. ```shell-session $ vault read /subkeys/ @@ -50,12 +50,14 @@ subkeys map[prod: sandbox: smoke:] -@include 'gui-page-instructions/select-kv-mount.mdx' +@include 'alerts/enterprise-only.mdx' -- Click through the path segments to select the relevant secret path. -- Note the subkeys listed on the data page. +@include 'gui-instructions/plugins/kv/open-overview.mdx' -![Partial screenshot of the Vault GUI showing two key/value pairs at the path dev/square-api. The "prod" key is visible](/img/gui/kv/read-data.png) +You can read a list of available subkeys for the target path in the **Subkeys** +card. + +![Partial screenshot of the Vault GUI showing subkeys "prod" and "sandbox" for secret data at path dev/square-api.](/img/gui/kv/overview-page.png) diff --git a/website/content/docs/secrets/kv/kv-v2/cookbook/undelete-data.mdx b/website/content/docs/secrets/kv/kv-v2/cookbook/undelete-data.mdx index 176eea4deb4a..c8954e7899b0 100644 --- a/website/content/docs/secrets/kv/kv-v2/cookbook/undelete-data.mdx +++ b/website/content/docs/secrets/kv/kv-v2/cookbook/undelete-data.mdx @@ -90,9 +90,9 @@ destroyed false -@include 'gui-page-instructions/select-kv-mount.mdx' +@include 'gui-instructions/plugins/kv/open-overview.mdx' -- Click through the path segments to select the relevant secret path. +- Select the **Secret** tab. - Select the appropriate data version from the **Version** dropdown. - Click **Undelete**. diff --git a/website/content/docs/secrets/kv/kv-v2/cookbook/write-data.mdx b/website/content/docs/secrets/kv/kv-v2/cookbook/write-data.mdx index 1250f25f171d..b84c2392abf5 100644 --- a/website/content/docs/secrets/kv/kv-v2/cookbook/write-data.mdx +++ b/website/content/docs/secrets/kv/kv-v2/cookbook/write-data.mdx @@ -72,10 +72,11 @@ The Vault GUI forcibly converts non-string keys to strings before writing data. To preserve non-string values, use the JSON toggle to write your key/value data as JSON. -@include 'gui-page-instructions/select-kv-mount.mdx' +@include 'gui-instructions/plugins/kv/open-overview.mdx' -- Click through the path segments to select the relevant secret path. -- Click **Create new version +**. +- Click **Create new +** from one of the following tabs: + - **Overview** tab: in the "Current version" card. + - **Secret** tab: in the toolbar. - Set a new key name and value. - Use the **Add** button to set additional key/value pairs. - Click **Save** to write the new version data. diff --git a/website/content/docs/secrets/kv/kv-v2/index.mdx b/website/content/docs/secrets/kv/kv-v2/index.mdx index 19c292478cb5..974ce55f4249 100644 --- a/website/content/docs/secrets/kv/kv-v2/index.mdx +++ b/website/content/docs/secrets/kv/kv-v2/index.mdx @@ -35,6 +35,7 @@ Basic examples: - [Set max data versions](/vault/docs/secrets/kv/kv-v2/cookbook/max-versions) - [Write data](/vault/docs/secrets/kv/kv-v2/cookbook/write-data) - [Patch and update data](/vault/docs/secrets/kv/kv-v2/cookbook/patch-data) +- [Read subkeys](/vault/docs/secrets/kv/kv-v2/cookbook/read-subkey) - [Soft delete data](/vault/docs/secrets/kv/kv-v2/cookbook/delete-data) - [Restore soft deleted data](/vault/docs/secrets/kv/kv-v2/cookbook/undelete-data) - [Destroy data](/vault/docs/secrets/kv/kv-v2/cookbook/destroy-data) diff --git a/website/content/docs/secrets/kv/kv-v2/random-string.mdx b/website/content/docs/secrets/kv/kv-v2/random-string.mdx index 858ae231c00c..6f9a79fbb5fc 100644 --- a/website/content/docs/secrets/kv/kv-v2/random-string.mdx +++ b/website/content/docs/secrets/kv/kv-v2/random-string.mdx @@ -268,9 +268,10 @@ g0bc0b6W3ii^SXa@*ie5 -@include 'gui-page-instructions/select-kv-mount.mdx' +@include 'gui-instructions/plugins/kv/open-overview.mdx' + +- Select the **Secret** tab. -- Click through the path segments to select the relevant secret path. - Click the eye icon to view the desired key value. ![Partial screenshot of the Vault GUI showing the randomized string stored at the path dev/seeds.](/img/gui/kv/random-string.png) diff --git a/website/content/docs/secrets/kv/kv-v2/setup.mdx b/website/content/docs/secrets/kv/kv-v2/setup.mdx index 1d386496450a..1d7e2c7d1fd8 100644 --- a/website/content/docs/secrets/kv/kv-v2/setup.mdx +++ b/website/content/docs/secrets/kv/kv-v2/setup.mdx @@ -52,7 +52,7 @@ $ vault secrets enable -path kv-v2 -@include 'gui-page-instructions/enable-secrets-plugin.mdx' +@include 'gui-instructions/enable-secrets-plugin.mdx' - Select the "KV" plugin. @@ -221,7 +221,7 @@ $ vault policy write "KV-access-policy" ./kv-policy.hcl -@include 'gui-page-instructions/create-acl-policy.mdx' +@include 'gui-instructions/create-acl-policy.mdx' - Provide a name for the policy and upload the policy definition file. diff --git a/website/content/partials/gui-page-instructions/create-acl-policy.mdx b/website/content/partials/gui-instructions/create-acl-policy.mdx similarity index 100% rename from website/content/partials/gui-page-instructions/create-acl-policy.mdx rename to website/content/partials/gui-instructions/create-acl-policy.mdx diff --git a/website/content/partials/gui-page-instructions/create-group.mdx b/website/content/partials/gui-instructions/create-group.mdx similarity index 100% rename from website/content/partials/gui-page-instructions/create-group.mdx rename to website/content/partials/gui-instructions/create-group.mdx diff --git a/website/content/partials/gui-page-instructions/enable-authn-plugin.mdx b/website/content/partials/gui-instructions/enable-authn-plugin.mdx similarity index 100% rename from website/content/partials/gui-page-instructions/enable-authn-plugin.mdx rename to website/content/partials/gui-instructions/enable-authn-plugin.mdx diff --git a/website/content/partials/gui-page-instructions/enable-secrets-plugin.mdx b/website/content/partials/gui-instructions/enable-secrets-plugin.mdx similarity index 100% rename from website/content/partials/gui-page-instructions/enable-secrets-plugin.mdx rename to website/content/partials/gui-instructions/enable-secrets-plugin.mdx diff --git a/website/content/partials/gui-page-instructions/select-kv-data.mdx b/website/content/partials/gui-instructions/plugins/kv/open-overview.mdx similarity index 81% rename from website/content/partials/gui-page-instructions/select-kv-data.mdx rename to website/content/partials/gui-instructions/plugins/kv/open-overview.mdx index 564b39ac9a0c..b45917a0b93a 100644 --- a/website/content/partials/gui-page-instructions/select-kv-data.mdx +++ b/website/content/partials/gui-instructions/plugins/kv/open-overview.mdx @@ -1,4 +1,4 @@ -- Open the data page for your `kv` plugin: +- Open the **Overview** screen for your secret path: 1. Open the GUI for your Vault instance. @@ -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 \ No newline at end of file + 1. Click through the path segments to select the relevant secret path. \ No newline at end of file diff --git a/website/content/partials/gui-page-instructions/select-kv-mount.mdx b/website/content/partials/gui-page-instructions/select-kv-mount.mdx deleted file mode 100644 index aa162c153fb4..000000000000 --- a/website/content/partials/gui-page-instructions/select-kv-mount.mdx +++ /dev/null @@ -1,10 +0,0 @@ -- Open the data page for your `kv` plugin: - - 1. Open the GUI for your Vault instance. - - 1. Login under the namespace for the plugin or select the namespace from the - selector at the bottom of the left-hand menu and re-authenticate. - - 1. Select **Secrets Engines** from the left-hand menu. - - 1. Select the mount path for your `kv` plugin. \ No newline at end of file diff --git a/website/public/img/gui/kv/overview-page.png b/website/public/img/gui/kv/overview-page.png new file mode 100644 index 000000000000..cc2b09eaf52e Binary files /dev/null and b/website/public/img/gui/kv/overview-page.png differ diff --git a/website/public/img/gui/kv/patch-reveal-subkeys.png b/website/public/img/gui/kv/patch-reveal-subkeys.png new file mode 100644 index 000000000000..e75b73e4c97f Binary files /dev/null and b/website/public/img/gui/kv/patch-reveal-subkeys.png differ