From af3f82ea51374f97da1bb48d65c1b2b3e4ac8648 Mon Sep 17 00:00:00 2001 From: yhyakuna <yoko@hashicorp.com> Date: Wed, 11 Dec 2024 22:22:50 -0800 Subject: [PATCH 1/7] Update the page description to improve SEO --- website/content/docs/secrets/identity/identity-token.mdx | 7 +++---- website/content/docs/secrets/identity/index.mdx | 9 ++++----- website/content/docs/secrets/identity/oidc-provider.mdx | 2 +- website/content/docs/secrets/key-management/awskms.mdx | 4 ++-- .../docs/secrets/key-management/azurekeyvault/index.mdx | 4 ++-- .../docs/secrets/key-management/azurekeyvault/setup.mdx | 2 +- .../content/docs/secrets/key-management/gcpkms/index.mdx | 4 ++-- .../content/docs/secrets/key-management/gcpkms/setup.mdx | 2 +- website/content/docs/secrets/key-management/index.mdx | 5 ++--- 9 files changed, 18 insertions(+), 21 deletions(-) diff --git a/website/content/docs/secrets/identity/identity-token.mdx b/website/content/docs/secrets/identity/identity-token.mdx index 8e14200e71d1..2d275deea38d 100644 --- a/website/content/docs/secrets/identity/identity-token.mdx +++ b/website/content/docs/secrets/identity/identity-token.mdx @@ -1,13 +1,12 @@ --- layout: docs -page_title: Identity Tokens -description: Details and best practices for identity tokens. +page_title: Identity tokens +description: >- + Understand the roles and keys associated with identity tokens, and configure per-role templates that allow entity information to be added to the token. --- # Identity tokens -## Introduction - Identity information is used throughout Vault, but it can also be exported for use by other applications. An authorized user/application can request a token that encapsulates identity information for their associated entity. These diff --git a/website/content/docs/secrets/identity/index.mdx b/website/content/docs/secrets/identity/index.mdx index adad33220de9..3cbcf0665076 100644 --- a/website/content/docs/secrets/identity/index.mdx +++ b/website/content/docs/secrets/identity/index.mdx @@ -1,14 +1,13 @@ --- layout: docs -page_title: Identity - Secrets Engines -description: The Identity secrets engine for Vault manages client identities. +page_title: Identity secrets engine +description: >- + Manage Vault client identities with the identity secrets engine. An entity represents a unique client which can have multiple aliases tied back to it. --- # Identity secrets engine -Name: `identity` - -The Identity secrets engine is the identity management solution for Vault. It +The identity secrets engine is the identity management solution for Vault. It internally maintains the clients who are recognized by Vault. Each client is internally termed as an `Entity`. An entity can have multiple `Aliases`. For example, a single user who has accounts in both GitHub and LDAP, can be mapped diff --git a/website/content/docs/secrets/identity/oidc-provider.mdx b/website/content/docs/secrets/identity/oidc-provider.mdx index 01445d70b27e..880d5e9794cf 100644 --- a/website/content/docs/secrets/identity/oidc-provider.mdx +++ b/website/content/docs/secrets/identity/oidc-provider.mdx @@ -1,6 +1,6 @@ --- layout: docs -page_title: OIDC Identity Provider +page_title: OIDC identity provider description: >- Setup and configuration for Vault as an OpenID Connect (OIDC) identity provider. --- diff --git a/website/content/docs/secrets/key-management/awskms.mdx b/website/content/docs/secrets/key-management/awskms.mdx index b75c69c515c4..8714153ac77c 100644 --- a/website/content/docs/secrets/key-management/awskms.mdx +++ b/website/content/docs/secrets/key-management/awskms.mdx @@ -1,7 +1,7 @@ --- layout: docs -page_title: AWS KMS - Key Management - Secrets Engines -description: AWS KMS is a supported KMS provider of the Key Management secrets engine. +page_title: AWS KMS +description: Manage the lifecycle of keys in AWS KMS with the Key Management secrets engine plugin. --- # AWS KMS diff --git a/website/content/docs/secrets/key-management/azurekeyvault/index.mdx b/website/content/docs/secrets/key-management/azurekeyvault/index.mdx index 8e86c1645d9d..29eeddb8f061 100644 --- a/website/content/docs/secrets/key-management/azurekeyvault/index.mdx +++ b/website/content/docs/secrets/key-management/azurekeyvault/index.mdx @@ -1,7 +1,7 @@ --- layout: docs -page_title: Azure Key Vault - Key Management - Secrets Engines -description: Key management secrets engine supports lifecycle management of keys in Azure Key Vault instances. +page_title: Azure Key Vault +description: Manage the lifecycle of keys in Azure Key Vault instances with the Key Management secrets engine plugin. --- # Azure Key Vault diff --git a/website/content/docs/secrets/key-management/azurekeyvault/setup.mdx b/website/content/docs/secrets/key-management/azurekeyvault/setup.mdx index 99e439ec4cfa..68469156dab7 100644 --- a/website/content/docs/secrets/key-management/azurekeyvault/setup.mdx +++ b/website/content/docs/secrets/key-management/azurekeyvault/setup.mdx @@ -1,6 +1,6 @@ --- layout: docs -page_title: Azure Key Vault setup guide +page_title: 'Setup guide - Azure Key Vault' description: Configure the key management secrets engine, and distribute the Vault-managed keys to the target Azure Key Vault instance. --- diff --git a/website/content/docs/secrets/key-management/gcpkms/index.mdx b/website/content/docs/secrets/key-management/gcpkms/index.mdx index a5931faf98b8..889173777f3d 100644 --- a/website/content/docs/secrets/key-management/gcpkms/index.mdx +++ b/website/content/docs/secrets/key-management/gcpkms/index.mdx @@ -1,7 +1,7 @@ --- layout: docs -page_title: GCP Cloud KMS - Key Management - Secrets Engines -description: Key management secrets engine supports lifecycle management of keys in GCP Cloud KMS key rings. +page_title: GCP Cloud KMS +description: Manage the lifecycle of keys in GCP Cloud KMS key rings with the Key Management secrets engine plugin. --- # GCP Cloud KMS diff --git a/website/content/docs/secrets/key-management/gcpkms/setup.mdx b/website/content/docs/secrets/key-management/gcpkms/setup.mdx index 1e1d855952fe..3892a7c53bde 100644 --- a/website/content/docs/secrets/key-management/gcpkms/setup.mdx +++ b/website/content/docs/secrets/key-management/gcpkms/setup.mdx @@ -1,6 +1,6 @@ --- layout: docs -page_title: GCP Cloud KMS - Key Management - Secrets Engines +page_title: 'Setup guide - GCP Cloud KMS' description: Configure the key management secrets engine, and distribute the Vault-managed keys to the target GCP Cloud KMS. --- diff --git a/website/content/docs/secrets/key-management/index.mdx b/website/content/docs/secrets/key-management/index.mdx index fd0fd645c385..183518676730 100644 --- a/website/content/docs/secrets/key-management/index.mdx +++ b/website/content/docs/secrets/key-management/index.mdx @@ -1,9 +1,8 @@ --- layout: docs -page_title: Key Management - Secrets Engines +page_title: Key management secrets engine description: >- - The key management secrets engine provides a consistent workflow for distribution and lifecycle - management of cryptographic keys in various key management service (KMS) providers. + Create a consistent workflow for distribution and lifecycle management of cryptographic keys in various key management service (KMS) providers. --- # Key management secrets engine From 69127a2530b5e976836aa07264c1f37d787e7047 Mon Sep 17 00:00:00 2001 From: yhyakuna <yoko@hashicorp.com> Date: Wed, 11 Dec 2024 22:25:14 -0800 Subject: [PATCH 2/7] Minor updates --- website/content/docs/secrets/ad/index.mdx | 4 ++-- website/content/docs/secrets/ad/migration-guide.mdx | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/website/content/docs/secrets/ad/index.mdx b/website/content/docs/secrets/ad/index.mdx index f17e7964729b..f3ba2e95456f 100644 --- a/website/content/docs/secrets/ad/index.mdx +++ b/website/content/docs/secrets/ad/index.mdx @@ -1,8 +1,8 @@ --- layout: docs -page_title: Active Directory - Secrets Engines +page_title: Active directory secrets engine description: >- - The Active Directory secrets engine allowing Vault to generate dynamic credentials. + Dynamically generate Active Directory (AD) credentials with the Active Directory secrets engine plugin. --- # Active directory secrets engine diff --git a/website/content/docs/secrets/ad/migration-guide.mdx b/website/content/docs/secrets/ad/migration-guide.mdx index 2c5a9a50e51e..7ae7bfbb4cda 100644 --- a/website/content/docs/secrets/ad/migration-guide.mdx +++ b/website/content/docs/secrets/ad/migration-guide.mdx @@ -1,6 +1,6 @@ --- layout: docs -page_title: Migration Guide - Active Directory - Secrets Engines +page_title: Migration guide - active directory secrets engine description: >- The guide for migrating from the Active Directory secrets engine to the LDAP secrets engine. --- From aa5a6b19dc6bcbcfc5cfc834bcf474140b842aa0 Mon Sep 17 00:00:00 2001 From: Yoko Hyakuna <yoko@hashicorp.com> Date: Wed, 11 Dec 2024 22:31:26 -0800 Subject: [PATCH 3/7] Update setup.mdx --- website/content/docs/secrets/key-management/gcpkms/setup.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/docs/secrets/key-management/gcpkms/setup.mdx b/website/content/docs/secrets/key-management/gcpkms/setup.mdx index 3892a7c53bde..dc015bbd9b31 100644 --- a/website/content/docs/secrets/key-management/gcpkms/setup.mdx +++ b/website/content/docs/secrets/key-management/gcpkms/setup.mdx @@ -1,6 +1,6 @@ --- layout: docs -page_title: 'Setup guide - GCP Cloud KMS' +page_title: Setup guide - GCP Cloud KMS description: Configure the key management secrets engine, and distribute the Vault-managed keys to the target GCP Cloud KMS. --- From 4b3fbd59cffcdd5e5fa9590d65c47fcf0551b33e Mon Sep 17 00:00:00 2001 From: Yoko Hyakuna <yoko@hashicorp.com> Date: Wed, 11 Dec 2024 22:31:45 -0800 Subject: [PATCH 4/7] Update setup.mdx --- .../content/docs/secrets/key-management/azurekeyvault/setup.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/docs/secrets/key-management/azurekeyvault/setup.mdx b/website/content/docs/secrets/key-management/azurekeyvault/setup.mdx index 68469156dab7..0284025425f9 100644 --- a/website/content/docs/secrets/key-management/azurekeyvault/setup.mdx +++ b/website/content/docs/secrets/key-management/azurekeyvault/setup.mdx @@ -1,6 +1,6 @@ --- layout: docs -page_title: 'Setup guide - Azure Key Vault' +page_title: Setup guide - Azure Key Vault description: Configure the key management secrets engine, and distribute the Vault-managed keys to the target Azure Key Vault instance. --- From ad2bc97dae84cd3e9ea0a5fae2561a7e39762dfa Mon Sep 17 00:00:00 2001 From: Yoko Hyakuna <yoko@hashicorp.com> Date: Thu, 12 Dec 2024 08:35:16 -0800 Subject: [PATCH 5/7] Update website/content/docs/secrets/ad/migration-guide.mdx Co-authored-by: Jonathan Frappier <92055993+jonathanfrappier@users.noreply.github.com> --- website/content/docs/secrets/ad/migration-guide.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/docs/secrets/ad/migration-guide.mdx b/website/content/docs/secrets/ad/migration-guide.mdx index 7ae7bfbb4cda..09876a23b323 100644 --- a/website/content/docs/secrets/ad/migration-guide.mdx +++ b/website/content/docs/secrets/ad/migration-guide.mdx @@ -1,6 +1,6 @@ --- layout: docs -page_title: Migration guide - active directory secrets engine +page_title: Migration guide - Active Directory secrets engine description: >- The guide for migrating from the Active Directory secrets engine to the LDAP secrets engine. --- From 4875cf5df3bb9147e737e815be9104a0a59b6e98 Mon Sep 17 00:00:00 2001 From: Yoko Hyakuna <yoko@hashicorp.com> Date: Thu, 12 Dec 2024 08:35:40 -0800 Subject: [PATCH 6/7] Update website/content/docs/secrets/ad/index.mdx Co-authored-by: Jonathan Frappier <92055993+jonathanfrappier@users.noreply.github.com> --- website/content/docs/secrets/ad/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/docs/secrets/ad/index.mdx b/website/content/docs/secrets/ad/index.mdx index f3ba2e95456f..e88a6d35f584 100644 --- a/website/content/docs/secrets/ad/index.mdx +++ b/website/content/docs/secrets/ad/index.mdx @@ -1,6 +1,6 @@ --- layout: docs -page_title: Active directory secrets engine +page_title: Active Directory secrets engine description: >- Dynamically generate Active Directory (AD) credentials with the Active Directory secrets engine plugin. --- From c20c881d9c5314b6a35ae7fbea3c75d81086b063 Mon Sep 17 00:00:00 2001 From: Yoko Hyakuna <yoko@hashicorp.com> Date: Thu, 12 Dec 2024 08:35:47 -0800 Subject: [PATCH 7/7] Update website/content/docs/secrets/ad/index.mdx Co-authored-by: Jonathan Frappier <92055993+jonathanfrappier@users.noreply.github.com> --- website/content/docs/secrets/ad/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/docs/secrets/ad/index.mdx b/website/content/docs/secrets/ad/index.mdx index e88a6d35f584..737e7eb8cc5b 100644 --- a/website/content/docs/secrets/ad/index.mdx +++ b/website/content/docs/secrets/ad/index.mdx @@ -5,7 +5,7 @@ description: >- Dynamically generate Active Directory (AD) credentials with the Active Directory secrets engine plugin. --- -# Active directory secrets engine +# Active Directory secrets engine @include 'ad-secrets-deprecation.mdx'