From ed4664005b64a3ad9fe8c98088c3c8ca1daf5a73 Mon Sep 17 00:00:00 2001 From: Yoko Hyakuna Date: Tue, 17 Dec 2024 08:01:12 -0800 Subject: [PATCH] [DOCS] Fix style inconsistency (#29199) * Fix style inconsistency * Fix typos * Update website/content/docs/platform/k8s/vso/secret-transformation.mdx Co-authored-by: Jonathan Frappier <92055993+jonathanfrappier@users.noreply.github.com> * Update website/content/docs/platform/k8s/helm/terraform.mdx Co-authored-by: Theron Voran * Update website/content/docs/platform/k8s/injector/annotations.mdx Co-authored-by: Theron Voran --------- Co-authored-by: Jonathan Frappier <92055993+jonathanfrappier@users.noreply.github.com> Co-authored-by: Theron Voran --- website/content/docs/platform/aws/index.mdx | 5 ++--- website/content/docs/platform/aws/lambda-extension.mdx | 6 +++--- website/content/docs/platform/aws/run.mdx | 3 +-- website/content/docs/platform/github-actions.mdx | 4 ++-- website/content/docs/platform/index.mdx | 2 +- .../content/docs/platform/k8s/csi/configurations.mdx | 7 ++++--- website/content/docs/platform/k8s/csi/examples.mdx | 4 ++-- website/content/docs/platform/k8s/csi/index.mdx | 4 ++-- website/content/docs/platform/k8s/csi/installation.mdx | 8 ++++---- .../content/docs/platform/k8s/helm/configuration.mdx | 2 +- website/content/docs/platform/k8s/helm/enterprise.mdx | 4 ++-- .../docs/platform/k8s/helm/examples/development.mdx | 4 ++-- .../k8s/helm/examples/enterprise-dr-with-raft.mdx | 8 ++++---- .../k8s/helm/examples/enterprise-perf-with-raft.mdx | 8 ++++---- .../k8s/helm/examples/enterprise-with-raft.mdx | 8 ++++---- .../docs/platform/k8s/helm/examples/external.mdx | 2 +- .../content/docs/platform/k8s/helm/examples/ha-tls.mdx | 8 ++++---- .../docs/platform/k8s/helm/examples/ha-with-consul.mdx | 8 ++++---- .../docs/platform/k8s/helm/examples/ha-with-raft.mdx | 6 +++--- .../content/docs/platform/k8s/helm/examples/index.mdx | 4 ++-- .../k8s/helm/examples/injector-tls-cert-manager.mdx | 8 ++++---- .../docs/platform/k8s/helm/examples/injector-tls.mdx | 8 ++++---- .../platform/k8s/helm/examples/kubernetes-auth.mdx | 8 ++++---- .../platform/k8s/helm/examples/standalone-audit.mdx | 6 +++--- .../k8s/helm/examples/standalone-load-balanced-ui.mdx | 6 +++--- .../docs/platform/k8s/helm/examples/standalone-tls.mdx | 6 +++--- website/content/docs/platform/k8s/helm/index.mdx | 5 ++--- website/content/docs/platform/k8s/helm/openshift.mdx | 4 ++-- website/content/docs/platform/k8s/helm/run.mdx | 6 +++--- website/content/docs/platform/k8s/helm/terraform.mdx | 6 +++--- website/content/docs/platform/k8s/injector-csi.mdx | 10 +++++----- .../content/docs/platform/k8s/injector/annotations.mdx | 6 +++--- .../content/docs/platform/k8s/injector/examples.mdx | 8 ++++---- website/content/docs/platform/k8s/injector/index.mdx | 7 +++---- .../docs/platform/k8s/injector/installation.mdx | 6 +++--- website/content/docs/platform/k8s/vso/examples.mdx | 4 ++-- website/content/docs/platform/k8s/vso/helm.mdx | 4 ++-- website/content/docs/platform/k8s/vso/installation.mdx | 6 +++--- website/content/docs/platform/k8s/vso/openshift.mdx | 4 ++-- .../docs/platform/k8s/vso/secret-transformation.mdx | 4 ++-- website/content/docs/platform/k8s/vso/sources/hvs.mdx | 6 ++---- .../docs/platform/k8s/vso/sources/vault/auth/aws.mdx | 2 +- .../docs/platform/k8s/vso/sources/vault/auth/gcp.mdx | 2 +- .../docs/platform/k8s/vso/sources/vault/auth/index.mdx | 2 +- website/content/docs/platform/k8s/vso/telemetry.mdx | 6 +++--- .../add-a-containerized-plugin.mdx | 2 +- website/content/docs/plugins/index.mdx | 5 +++-- website/content/docs/plugins/plugin-architecture.mdx | 4 ++-- website/content/docs/plugins/plugin-development.mdx | 4 ++-- website/content/docs/plugins/plugin-management.mdx | 5 ++--- 50 files changed, 130 insertions(+), 135 deletions(-) diff --git a/website/content/docs/platform/aws/index.mdx b/website/content/docs/platform/aws/index.mdx index 78b4b8096c98..22cecb11c28b 100644 --- a/website/content/docs/platform/aws/index.mdx +++ b/website/content/docs/platform/aws/index.mdx @@ -2,11 +2,10 @@ layout: docs page_title: AWS Marketplace description: >- - This section documents the official AWS Marketplace AMIs for Vault Open Source - and Vault Enterprise. + Deploy Vault on AWS using HashiCorp’s official AWS Marketplace AMIs for Vault Open Source and Vault Enterprise. --- -# AWS marketplace +# AWS Marketplace Vault can be deployed onto Amazon Web Services (AWS) using HashiCorp’s official AWS Marketplace offerings. HashiCorp packages the latest version of both Vault Open Source and Vault Enterprise as Amazon Machine Images (AMIs). diff --git a/website/content/docs/platform/aws/lambda-extension.mdx b/website/content/docs/platform/aws/lambda-extension.mdx index 1df42ecf0cee..99aad92560d6 100644 --- a/website/content/docs/platform/aws/lambda-extension.mdx +++ b/website/content/docs/platform/aws/lambda-extension.mdx @@ -1,11 +1,11 @@ --- layout: docs -page_title: Vault Lambda Extension +page_title: Vault Lambda extension description: >- - The Vault Lambda Extension allows a Lambda function to read secrets from a Vault deployment. + Learn how the Vault Lambda extension allows a Lambda function to read secrets from a Vault deployment. --- -# Vault lambda extension +# Vault Lambda extension AWS Lambda lets you run code without provisioning and managing servers. The [Vault Lambda Extension](https://github.com/hashicorp/vault-lambda-extension) utilizes the AWS Lambda Extensions API to help your Lambda function read secrets from your Vault deployment. diff --git a/website/content/docs/platform/aws/run.mdx b/website/content/docs/platform/aws/run.mdx index 7d9c6a86e10d..1810c1b2c9e7 100644 --- a/website/content/docs/platform/aws/run.mdx +++ b/website/content/docs/platform/aws/run.mdx @@ -2,8 +2,7 @@ layout: docs page_title: Running Vault description: >- - Vault can be launched from within the AWS Marketplace from the official Vault - Marketplace Listings. + Learn how to launch Vault from within the AWS Marketplace from the official Vault Marketplace listings. --- # Running Vault diff --git a/website/content/docs/platform/github-actions.mdx b/website/content/docs/platform/github-actions.mdx index cd00583c4871..e466fbd05d3e 100644 --- a/website/content/docs/platform/github-actions.mdx +++ b/website/content/docs/platform/github-actions.mdx @@ -1,8 +1,8 @@ --- layout: docs -page_title: GitHub Actions +page_title: GitHub actions description: >- - GitHub Actions + Use GitHub action workflow to leverage secrets stored in Vault using vault-action. --- # GitHub actions diff --git a/website/content/docs/platform/index.mdx b/website/content/docs/platform/index.mdx index 23bb5d8e8b2d..63d2e4ba9f0b 100644 --- a/website/content/docs/platform/index.mdx +++ b/website/content/docs/platform/index.mdx @@ -1,7 +1,7 @@ --- layout: docs page_title: Platforms -description: This section covers running Vault on various platforms (such as Kubernetes). +description: Learn how to run Vault on various platforms such as Kubernetes. --- # Platforms diff --git a/website/content/docs/platform/k8s/csi/configurations.mdx b/website/content/docs/platform/k8s/csi/configurations.mdx index 684a174dcc6e..9a9aaee9cc64 100644 --- a/website/content/docs/platform/k8s/csi/configurations.mdx +++ b/website/content/docs/platform/k8s/csi/configurations.mdx @@ -1,10 +1,11 @@ --- layout: docs -page_title: Vault CSI Provider Configurations -description: This section documents the configurables for the Vault CSI Provider. +page_title: Vault CSI provider configurations +description: >- + Learn about the command line arguments and the secret provider class parameters supported by the Vault CSI provider. --- -# Command line arguments +# Vault CSI provider configurations The following command line arguments are supported by the Vault CSI provider. Most settings support being set by, in ascending order of precedence: diff --git a/website/content/docs/platform/k8s/csi/examples.mdx b/website/content/docs/platform/k8s/csi/examples.mdx index a895f360cadd..ecb09b8b0e32 100644 --- a/website/content/docs/platform/k8s/csi/examples.mdx +++ b/website/content/docs/platform/k8s/csi/examples.mdx @@ -1,7 +1,7 @@ --- layout: docs -page_title: Vault CSI Provider Examples -description: This section documents examples of using the Vault CSI Provider. +page_title: Vault CSI provider examples +description: Examples of using the Vault CSI provider. --- # Vault CSI provider examples diff --git a/website/content/docs/platform/k8s/csi/index.mdx b/website/content/docs/platform/k8s/csi/index.mdx index bebc6bbb1342..357b477ff210 100644 --- a/website/content/docs/platform/k8s/csi/index.mdx +++ b/website/content/docs/platform/k8s/csi/index.mdx @@ -1,8 +1,8 @@ --- layout: docs -page_title: Vault CSI Provider +page_title: Vault CSI provider description: >- - The Vault CSI Provider allows pods to consume Vault secrets using CSI volumes. + Learn how the Vault CSI provider allows pods to consume Vault secrets using CSI volumes. --- # Vault CSI provider diff --git a/website/content/docs/platform/k8s/csi/installation.mdx b/website/content/docs/platform/k8s/csi/installation.mdx index e3a41988c85e..b4acd0b6798e 100644 --- a/website/content/docs/platform/k8s/csi/installation.mdx +++ b/website/content/docs/platform/k8s/csi/installation.mdx @@ -1,10 +1,10 @@ --- layout: docs -page_title: Vault CSI Provider Installation -description: The Vault CSI Provider can be installed using Vault Helm. +page_title: Install the Vault CSI provider +description: Install the Vault CSI provider using Vault Helm. --- -# Installing the Vault CSI provider +# Install the Vault CSI provider ## Prerequisites @@ -14,7 +14,7 @@ description: The Vault CSI Provider can be installed using Vault Helm. `--service-account-signing-key-file` and `--service-account-issuer` for `kube-apiserver`. Set by default from 1.20+ and earlier in most managed services. -## Installation using helm +## Installation using Helm The [Vault Helm chart](/vault/docs/platform/k8s/helm) is the recommended way to install and configure the Vault CSI Provider in Kubernetes. diff --git a/website/content/docs/platform/k8s/helm/configuration.mdx b/website/content/docs/platform/k8s/helm/configuration.mdx index 8f195e25ade0..05b467c1dad6 100644 --- a/website/content/docs/platform/k8s/helm/configuration.mdx +++ b/website/content/docs/platform/k8s/helm/configuration.mdx @@ -1,7 +1,7 @@ --- layout: docs page_title: Configuration -description: This section documents configuration options for the Vault Helm chart +description: Configuration options for the Vault Helm chart. --- # Configuration diff --git a/website/content/docs/platform/k8s/helm/enterprise.mdx b/website/content/docs/platform/k8s/helm/enterprise.mdx index 1e91bb4fea53..336d2f62b918 100644 --- a/website/content/docs/platform/k8s/helm/enterprise.mdx +++ b/website/content/docs/platform/k8s/helm/enterprise.mdx @@ -1,11 +1,11 @@ --- layout: docs -page_title: Vault Enterprise License Management - Kubernetes +page_title: Vault Enterprise license management description: >- Vault Helm supports deploying Vault Enterprise, including license autoloading. --- -# Vault enterprise license management +# Vault Enterprise license management You can use this Helm chart to deploy Vault Enterprise by following a few extra steps around licensing. diff --git a/website/content/docs/platform/k8s/helm/examples/development.mdx b/website/content/docs/platform/k8s/helm/examples/development.mdx index ba1038c67166..b837193e6962 100644 --- a/website/content/docs/platform/k8s/helm/examples/development.mdx +++ b/website/content/docs/platform/k8s/helm/examples/development.mdx @@ -2,8 +2,8 @@ layout: 'docs' page_title: 'Development' sidebar_current: 'docs-platform-k8s-examples-development' -description: |- - Describes how to set up a development Vault +description: >- + Learn how to set up a development Vault server. --- # Development diff --git a/website/content/docs/platform/k8s/helm/examples/enterprise-dr-with-raft.mdx b/website/content/docs/platform/k8s/helm/examples/enterprise-dr-with-raft.mdx index 9adcc3ebc497..6f88a28e25e8 100644 --- a/website/content/docs/platform/k8s/helm/examples/enterprise-dr-with-raft.mdx +++ b/website/content/docs/platform/k8s/helm/examples/enterprise-dr-with-raft.mdx @@ -1,12 +1,12 @@ --- layout: 'docs' -page_title: 'Highly Available Vault Enterprise Disaster Recovery Clusters with Raft' +page_title: 'Highly available Vault Enterprise disaster recovery clusters with integrated storage (Raft)' sidebar_current: 'docs-platform-k8s-examples-enterprise-dr-with-raft' -description: |- - Describes how to set up Diaster Recovery clusters with Integrated Storage (Raft) +description: >- + Learn how to set up diaster recovery (DR) clusters with integrated storage (Raft) as the storage backend. --- -# Highly available Vault enterprise disaster recovery clusters with integrated storage (Raft) +# Highly available Vault Enterprise disaster recovery clusters with integrated storage (Raft) @include 'helm/version.mdx' diff --git a/website/content/docs/platform/k8s/helm/examples/enterprise-perf-with-raft.mdx b/website/content/docs/platform/k8s/helm/examples/enterprise-perf-with-raft.mdx index 6868470aec49..d068b57ec20a 100644 --- a/website/content/docs/platform/k8s/helm/examples/enterprise-perf-with-raft.mdx +++ b/website/content/docs/platform/k8s/helm/examples/enterprise-perf-with-raft.mdx @@ -1,12 +1,12 @@ --- layout: 'docs' -page_title: 'Highly Available Vault Enterprise Performance Clusters with Raft' +page_title: 'Highly available Vault Enterprise performance clusters with integrated storage (Raft)' sidebar_current: 'docs-platform-k8s-examples-enterprise-perf-with-raft' -description: |- - Describes how to set up Performance clusters with Integrated Storage (Raft) +description: >- + Learn how to set up performance replication clusters with integrated storage (Raft) as the storage backend. --- -# Highly available Vault enterprise performance clusters with integrated storage (Raft) +# Highly available Vault Enterprise performance clusters with integrated storage (Raft) @include 'helm/version.mdx' diff --git a/website/content/docs/platform/k8s/helm/examples/enterprise-with-raft.mdx b/website/content/docs/platform/k8s/helm/examples/enterprise-with-raft.mdx index ead983435a9b..e5092ab9768a 100644 --- a/website/content/docs/platform/k8s/helm/examples/enterprise-with-raft.mdx +++ b/website/content/docs/platform/k8s/helm/examples/enterprise-with-raft.mdx @@ -1,12 +1,12 @@ --- layout: 'docs' -page_title: 'Highly Available Vault Enterprise Cluster with Raft' +page_title: 'Highly available Vault Enterprise cluster with integrated storage (Raft)' sidebar_current: 'docs-platform-k8s-examples-enterprise-with-raft' -description: |- - Describes how to set up a highly available Vault Enterprise cluster with Integrated Storage (Raft) +description: >- + Learn how to set up a highly available Vault Enterprise cluster with integrated storage (Raft) as the storage backend. --- -# Highly available Vault enterprise cluster with integrated storage (Raft) +# Highly available Vault Enterprise cluster with integrated storage (Raft) @include 'helm/version.mdx' diff --git a/website/content/docs/platform/k8s/helm/examples/external.mdx b/website/content/docs/platform/k8s/helm/examples/external.mdx index ae4c88543060..8dd0c4b30263 100644 --- a/website/content/docs/platform/k8s/helm/examples/external.mdx +++ b/website/content/docs/platform/k8s/helm/examples/external.mdx @@ -3,7 +3,7 @@ layout: 'docs' page_title: 'External Vault' sidebar_current: 'docs-platform-k8s-examples-external' description: |- - Describes how to set up an external Vault + Learn how to set up an external Vault server or cluster. --- # External Vault diff --git a/website/content/docs/platform/k8s/helm/examples/ha-tls.mdx b/website/content/docs/platform/k8s/helm/examples/ha-tls.mdx index 46fa12b47bc0..2143c4374198 100644 --- a/website/content/docs/platform/k8s/helm/examples/ha-tls.mdx +++ b/website/content/docs/platform/k8s/helm/examples/ha-tls.mdx @@ -1,12 +1,12 @@ --- layout: 'docs' -page_title: 'HA Cluster with Raft and TLS' +page_title: 'HA cluster with Raft and TLS' sidebar_current: 'docs-platform-k8s-examples-ha-tls' -description: |- - Describes how to set up a Raft HA Vault cluster with TLS certificate +description: >- + Learn how to set up a Raft HA Vault cluster with TLS certificate. --- -# HA Cluster with Raft and TLS +# HA cluster with Raft and TLS The overview for [Integrated Storage and TLS](/vault/docs/concepts/integrated-storage#integrated-storage-and-tls) covers diff --git a/website/content/docs/platform/k8s/helm/examples/ha-with-consul.mdx b/website/content/docs/platform/k8s/helm/examples/ha-with-consul.mdx index 411c30352a6e..d178dab2d216 100644 --- a/website/content/docs/platform/k8s/helm/examples/ha-with-consul.mdx +++ b/website/content/docs/platform/k8s/helm/examples/ha-with-consul.mdx @@ -1,12 +1,12 @@ --- layout: 'docs' -page_title: 'Highly Available Vault Cluster with Consul' +page_title: 'Highly available Vault cluster with Consul' sidebar_current: 'docs-platform-k8s-examples-ha-with-consul' -description: |- - Describes how to set up a highly available Vault cluster with Consul backend +description: >- + Learn how to set up a highly available Vault cluster with Consul as the storage backend. --- -# Highly available Vault cluster with consul +# Highly available Vault cluster with Consul @include 'helm/version.mdx' diff --git a/website/content/docs/platform/k8s/helm/examples/ha-with-raft.mdx b/website/content/docs/platform/k8s/helm/examples/ha-with-raft.mdx index 27391d2fcf70..9006c323f199 100644 --- a/website/content/docs/platform/k8s/helm/examples/ha-with-raft.mdx +++ b/website/content/docs/platform/k8s/helm/examples/ha-with-raft.mdx @@ -1,9 +1,9 @@ --- layout: 'docs' -page_title: 'Highly Available Vault Cluster with Raft' +page_title: 'Highly available Vault cluster with integrated storage (Raft)' sidebar_current: 'docs-platform-k8s-examples-ha-with-raft' -description: |- - Describes how to set up a highly available Vault cluster with Integrated Storage (Raft) +description: >- + Learn how to set up a highly available Vault cluster with integrated storage (Raft) as the storage backend. --- # Highly available Vault cluster with integrated storage (Raft) diff --git a/website/content/docs/platform/k8s/helm/examples/index.mdx b/website/content/docs/platform/k8s/helm/examples/index.mdx index 4f20d3c93270..fb9d2aa1b3db 100644 --- a/website/content/docs/platform/k8s/helm/examples/index.mdx +++ b/website/content/docs/platform/k8s/helm/examples/index.mdx @@ -1,9 +1,9 @@ --- layout: 'docs' -page_title: 'Examples' +page_title: 'Helm chart examples' sidebar_current: 'docs-platform-k8s-examples' description: |- - This section documents configuration options for the Vault Helm chart + Examples of configuration options for the Vault Helm chart. --- # Helm chart examples diff --git a/website/content/docs/platform/k8s/helm/examples/injector-tls-cert-manager.mdx b/website/content/docs/platform/k8s/helm/examples/injector-tls-cert-manager.mdx index 312d68619e99..b87b0a529627 100644 --- a/website/content/docs/platform/k8s/helm/examples/injector-tls-cert-manager.mdx +++ b/website/content/docs/platform/k8s/helm/examples/injector-tls-cert-manager.mdx @@ -1,12 +1,12 @@ --- layout: 'docs' -page_title: 'Vault Agent Injector TLS with Cert-Manager' +page_title: 'Vault Agent Injector TLS with cert-manager' sidebar_current: 'docs-platform-k8s-examples-injector-tls-cert-manager' -description: |- - Describes how to set up the Vault Agent Injector with certificates and keys generated by cert-manager. +description: >- + Learn how to set up the Vault Agent Injector with certificates and keys generated by cert-manager. --- -# Vault agent injector TLS with Cert-Manager +# Vault Agent Injector TLS with cert-manager The following instructions demonstrate how to configure the Vault Agent Injector to use certificates generated by [cert-manager](https://cert-manager.io/). This allows you to run multiple replicas of the Vault Agent Injector in a Kubernetes cluster. diff --git a/website/content/docs/platform/k8s/helm/examples/injector-tls.mdx b/website/content/docs/platform/k8s/helm/examples/injector-tls.mdx index 6e5aac5e941e..1061cd301ff0 100644 --- a/website/content/docs/platform/k8s/helm/examples/injector-tls.mdx +++ b/website/content/docs/platform/k8s/helm/examples/injector-tls.mdx @@ -1,12 +1,12 @@ --- layout: 'docs' -page_title: 'Vault Agent Injector TLS Configuration' +page_title: 'Vault Agent Injector TLS configuration' sidebar_current: 'docs-platform-k8s-examples-injector-tls' -description: |- - Describes how to set up the Vault Agent Injector with manually generated certificates and keys. +description: >- + Learn how to set up the Vault Agent Injector with manually generated certificates and keys. --- -# Vault agent injector TLS configuration +# Vault Agent Injector TLS configuration @include 'helm/version.mdx' diff --git a/website/content/docs/platform/k8s/helm/examples/kubernetes-auth.mdx b/website/content/docs/platform/k8s/helm/examples/kubernetes-auth.mdx index 08fe7eef4117..f9a29ec66450 100644 --- a/website/content/docs/platform/k8s/helm/examples/kubernetes-auth.mdx +++ b/website/content/docs/platform/k8s/helm/examples/kubernetes-auth.mdx @@ -1,12 +1,12 @@ --- layout: 'docs' -page_title: 'Using Kubernetes Auth Method' +page_title: 'Bootstrapping Kubernetes auth method' sidebar_current: 'docs-platform-k8s-examples-kubernetes-auth' -description: |- - Describes how to set up Kubernetes Auth method +description: >- + Learn how to set up Kubernetes auth method. --- -# Bootstrapping kubernetes auth method +# Bootstrapping Kubernetes auth method @include 'helm/version.mdx' diff --git a/website/content/docs/platform/k8s/helm/examples/standalone-audit.mdx b/website/content/docs/platform/k8s/helm/examples/standalone-audit.mdx index 66c486649a2d..329d3a8192cc 100644 --- a/website/content/docs/platform/k8s/helm/examples/standalone-audit.mdx +++ b/website/content/docs/platform/k8s/helm/examples/standalone-audit.mdx @@ -1,9 +1,9 @@ --- layout: 'docs' -page_title: 'Standalone Server with Audit Storage' +page_title: 'Standalone server with audit storage' sidebar_current: 'docs-platform-k8s-examples-standalone-audit' -description: |- - Describes how to set up a standalone Vault with audit storage +description: >- + Learn how to set up a standalone Vault server with audit storage. --- # Standalone server with audit storage diff --git a/website/content/docs/platform/k8s/helm/examples/standalone-load-balanced-ui.mdx b/website/content/docs/platform/k8s/helm/examples/standalone-load-balanced-ui.mdx index 444b63ad7ba6..ad8dfea1e70d 100644 --- a/website/content/docs/platform/k8s/helm/examples/standalone-load-balanced-ui.mdx +++ b/website/content/docs/platform/k8s/helm/examples/standalone-load-balanced-ui.mdx @@ -1,9 +1,9 @@ --- layout: 'docs' -page_title: 'Standalone Server with Load Balanced UI' +page_title: 'Standalone server with load balanced UI' sidebar_current: 'docs-platform-k8s-examples-standalone-load-balanced-ui' -description: |- - Describes how to set up a standalone Vault with a load balanced UI +description: >- + Learn how to set up a standalone Vault server with a load balanced UI. --- # Standalone server with load balanced UI diff --git a/website/content/docs/platform/k8s/helm/examples/standalone-tls.mdx b/website/content/docs/platform/k8s/helm/examples/standalone-tls.mdx index 682d755db066..e3e09ae94e7a 100644 --- a/website/content/docs/platform/k8s/helm/examples/standalone-tls.mdx +++ b/website/content/docs/platform/k8s/helm/examples/standalone-tls.mdx @@ -1,9 +1,9 @@ --- layout: 'docs' -page_title: 'Standalone Server with TLS' +page_title: 'Standalone server with TLS' sidebar_current: 'docs-platform-k8s-examples-standalone-tls' -description: |- - Describes how to set up a standalone Vault with TLS certificate +description: >- + Learn how to set up a standalone Vault server with TLS certificate. --- # Standalone server with TLS diff --git a/website/content/docs/platform/k8s/helm/index.mdx b/website/content/docs/platform/k8s/helm/index.mdx index f84dee667b96..1f87060c9792 100644 --- a/website/content/docs/platform/k8s/helm/index.mdx +++ b/website/content/docs/platform/k8s/helm/index.mdx @@ -1,9 +1,8 @@ --- layout: docs -page_title: Helm - Kubernetes +page_title: Helm chart description: >- - The Vault Helm chart is the recommended way to install and configure Vault on - Kubernetes. + Install and configure Vault on Kubernetes using the Vault Helm chart which is the recommended way. --- # Helm chart diff --git a/website/content/docs/platform/k8s/helm/openshift.mdx b/website/content/docs/platform/k8s/helm/openshift.mdx index 75e7c5084700..3bc31060e0a9 100644 --- a/website/content/docs/platform/k8s/helm/openshift.mdx +++ b/website/content/docs/platform/k8s/helm/openshift.mdx @@ -1,8 +1,8 @@ --- layout: docs -page_title: Running Vault - OpenShift +page_title: Run Vault on OpenShift description: >- - Vault can run directly on OpenShift in various configurations. For + Run Vault directly on OpenShift in various configurations. For pure-OpenShift workloads, this enables Vault to also exist purely within Kubernetes. --- diff --git a/website/content/docs/platform/k8s/helm/run.mdx b/website/content/docs/platform/k8s/helm/run.mdx index 7bf1a2ec1335..1baad90ccbb8 100644 --- a/website/content/docs/platform/k8s/helm/run.mdx +++ b/website/content/docs/platform/k8s/helm/run.mdx @@ -1,13 +1,13 @@ --- layout: docs -page_title: Running Vault - Kubernetes +page_title: Run Vault on Kubernetes description: >- - Vault can run directly on Kubernetes in various configurations. For + Run Vault directly on Kubernetes in various configurations. For pure-Kubernetes workloads, this enables Vault to also exist purely within Kubernetes. --- -# Run Vault on kubernetes +# Run Vault on Kubernetes Vault works with Kubernetes in various modes: `dev`, `standalone`, `ha`, and `external`. diff --git a/website/content/docs/platform/k8s/helm/terraform.mdx b/website/content/docs/platform/k8s/helm/terraform.mdx index 4a77b1071153..268721a0efd9 100644 --- a/website/content/docs/platform/k8s/helm/terraform.mdx +++ b/website/content/docs/platform/k8s/helm/terraform.mdx @@ -2,11 +2,11 @@ layout: 'docs' page_title: 'Configure Vault Helm using Terraform' sidebar_current: 'docs-platform-k8s-terraform' -description: |- - Describes how to configure the Vault Helm chart using Terraform +description: >- + Describes how to configure the Vault Helm chart using Terraform. --- -# Configuring Vault helm with terraform +# Configure Vault Helm using Terraform Terraform may also be used to configure and deploy the Vault Helm chart, by using the [Helm provider](https://registry.terraform.io/providers/hashicorp/helm/latest/docs). diff --git a/website/content/docs/platform/k8s/injector-csi.mdx b/website/content/docs/platform/k8s/injector-csi.mdx index 9b54b8be2bb8..14366bf42618 100644 --- a/website/content/docs/platform/k8s/injector-csi.mdx +++ b/website/content/docs/platform/k8s/injector-csi.mdx @@ -1,18 +1,18 @@ --- layout: docs -page_title: Agent Injector vs. Vault CSI Provider -description: This section compares Sidecar Injector and Vault CSI Provider for Kubernetes and Vault integration. +page_title: Vault Agent Injector vs. Vault CSI Provider +description: Compares Vault Agent Injector and Vault CSI Provider for Kubernetes and Vault integration. --- -# Agent injector vs. Vault CSI provider +# Vault Agent Injector vs. Vault CSI Provider This document explores two different methods for integrating HashiCorp Vault with Kubernetes. The information provided is intended for DevOps practitioners who understand secret management concepts and are familiar with HashiCorp Vault and Kubernetes. This document also offers practical guidance to help you understand and choose the best method for your use case. Information contained within this document details the contrast between the Agent Injector, also referred as _Vault Sidecar_ or _Sidecar_ in this document, and the Vault Container Storage Interface (CSI) provider used to integrate Vault and Kubernetes. -## Vault sidecar agent injector +## Vault Agent Injector -The [Vault Sidecar Agent Injector](/vault/docs/platform/k8s/injector) leverages the [sidecar pattern](https://docs.microsoft.com/en-us/azure/architecture/patterns/sidecar) to alter pod specifications to include a Vault Agent container that renders Vault secrets to a shared memory volume. By rendering secrets to a shared volume, containers within the pod can consume Vault secrets without being Vault-aware. The injector is a Kubernetes mutating webhook controller. The controller intercepts pod events and applies mutations to the pod if annotations exist within the request. This functionality is provided by the [vault-k8s](https://github.com/hashicorp/vault-k8s) project and can be automatically installed and configured using the Vault Helm chart. +The [Vault Agent Injector](/vault/docs/platform/k8s/injector) leverages the [sidecar pattern](https://docs.microsoft.com/en-us/azure/architecture/patterns/sidecar) to alter pod specifications to include a Vault Agent container that renders Vault secrets to a shared memory volume. By rendering secrets to a shared volume, containers within the pod can consume Vault secrets without being Vault-aware. The injector is a Kubernetes mutating webhook controller. The controller intercepts pod events and applies mutations to the pod if annotations exist within the request. This functionality is provided by the [vault-k8s](https://github.com/hashicorp/vault-k8s) project and can be automatically installed and configured using the Vault Helm chart. ![Vault Sidecar Injection Workflow](/img/vault-sidecar-inject-workflow.png) diff --git a/website/content/docs/platform/k8s/injector/annotations.mdx b/website/content/docs/platform/k8s/injector/annotations.mdx index 219b01b4177c..1f52b4044bb4 100644 --- a/website/content/docs/platform/k8s/injector/annotations.mdx +++ b/website/content/docs/platform/k8s/injector/annotations.mdx @@ -1,10 +1,10 @@ --- layout: docs -page_title: Agent Sidecar Injector Annotations -description: This section documents the configurable annotations for the Vault Agent Injector. +page_title: Vault Agent Injector annotations +description: Learn about the configurable annotations for the Vault Agent Injector. --- -# Annotations +# Vault Agent Injector annotations The following are the available annotations for the injector. These annotations are organized into two sections: agent and vault. All of the annotations below diff --git a/website/content/docs/platform/k8s/injector/examples.mdx b/website/content/docs/platform/k8s/injector/examples.mdx index 0dc5d7f3a8a7..6dd90f968359 100644 --- a/website/content/docs/platform/k8s/injector/examples.mdx +++ b/website/content/docs/platform/k8s/injector/examples.mdx @@ -1,10 +1,10 @@ --- layout: docs -page_title: Vault Agent Sidecar Injector Examples -description: This section documents examples of using the Vault Agent Injector. +page_title: Vault Agent Injector examples +description: Configuration examples of using the Vault Agent Injector. --- -# Vault agent injector examples +# Vault Agent Injector examples The following are different configuration examples to support a variety of deployment models. @@ -13,7 +13,7 @@ deployment models. Ensure that the injector annotations are specified on the pod specification when using higher level constructs such as deployments, jobs or statefulsets. -## Before using the Vault agent injector +## Before using the Vault Agent injector Before applying Vault Agent injection annotations to pods, the following requirements should be satisfied. diff --git a/website/content/docs/platform/k8s/injector/index.mdx b/website/content/docs/platform/k8s/injector/index.mdx index eafb61addf50..b7426fa6538a 100644 --- a/website/content/docs/platform/k8s/injector/index.mdx +++ b/website/content/docs/platform/k8s/injector/index.mdx @@ -1,12 +1,11 @@ --- layout: docs -page_title: Agent Sidecar Injector Overview +page_title: Vault Agent Injector description: >- - The Vault Agent Sidecar Injector is a Kubernetes admission webhook that adds - Vault Agent containers to pods for consuming Vault secrets. + Learn how Vault Agent Injector works. It is a Kubernetes admission webhook that adds Vault Agent containers to pods for consuming Vault secrets. --- -# Agent sidecar injector +# Vault Agent Injector The Vault Agent Injector alters pod specifications to include Vault Agent containers that render Vault secrets to a shared memory volume using diff --git a/website/content/docs/platform/k8s/injector/installation.mdx b/website/content/docs/platform/k8s/injector/installation.mdx index ae052dbbaad3..666821aa5752 100644 --- a/website/content/docs/platform/k8s/injector/installation.mdx +++ b/website/content/docs/platform/k8s/injector/installation.mdx @@ -1,10 +1,10 @@ --- layout: docs -page_title: Agent Sidecar Injector Installation -description: The Vault Agent Sidecar Injector can be installed using Vault Helm. +page_title: Install Vault Agent Injector +description: Install the Vault Agent Injector using the Vault Helm. --- -# Installing the agent injector +# Install Vault Agent Injector The [Vault Helm chart](/vault/docs/platform/k8s/helm) is the recommended way to install and configure the Agent Injector in Kubernetes. diff --git a/website/content/docs/platform/k8s/vso/examples.mdx b/website/content/docs/platform/k8s/vso/examples.mdx index 62a02e3e3a3c..d949828a00c8 100644 --- a/website/content/docs/platform/k8s/vso/examples.mdx +++ b/website/content/docs/platform/k8s/vso/examples.mdx @@ -1,8 +1,8 @@ --- layout: docs -page_title: Vault Secrets Operator Examples +page_title: Vault Secrets Operator examples description: >- - The Vault Secrets Operator allows Pods to consume Vault secrets natively from Kubernetes Secrets. + Vault Secrets Operator usage examples to consume Vault secrets natively from Kubernetes Secrets. --- # Vault Secrets Operator examples diff --git a/website/content/docs/platform/k8s/vso/helm.mdx b/website/content/docs/platform/k8s/vso/helm.mdx index 383099ad42e8..d477e295939f 100644 --- a/website/content/docs/platform/k8s/vso/helm.mdx +++ b/website/content/docs/platform/k8s/vso/helm.mdx @@ -1,6 +1,6 @@ --- layout: docs -page_title: Vault Secrets Operator Helm Chart Configuration +page_title: Vault Secrets Operator Helm chart configuration description: >- Configuration for the Vault Secrets Operator Helm chart. --- @@ -11,7 +11,7 @@ commit SHA=0bf284afea63a64e706717e2324a304be4d7f24b To update run 'make gen-helm-docs' from the vault-secrets-operator repo. --> -# Vault Secrets Operator helm chart +# Vault Secrets Operator Helm chart configuration The chart is customizable using [Helm configuration values](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). diff --git a/website/content/docs/platform/k8s/vso/installation.mdx b/website/content/docs/platform/k8s/vso/installation.mdx index f79b24700382..f38aa3878cd9 100644 --- a/website/content/docs/platform/k8s/vso/installation.mdx +++ b/website/content/docs/platform/k8s/vso/installation.mdx @@ -1,12 +1,12 @@ --- layout: docs -page_title: Vault Secrets Operator Installation +page_title: Install and upgrade the Vault Secrets Operator description: >- - The Vault Secrets Operator can be installed using Helm. + Install Vault Secrets Operator using Helm. --- @include 'vso/common-links.mdx' -# Installing and upgrading the Vault Secrets Operator +# Install and upgrade the Vault Secrets Operator ## Prerequisites diff --git a/website/content/docs/platform/k8s/vso/openshift.mdx b/website/content/docs/platform/k8s/vso/openshift.mdx index bdf3c6f176de..59ef865ba0b5 100644 --- a/website/content/docs/platform/k8s/vso/openshift.mdx +++ b/website/content/docs/platform/k8s/vso/openshift.mdx @@ -1,8 +1,8 @@ --- layout: docs -page_title: Vault Secrets Operator on OpenShift +page_title: Run the Vault Secrets Operator on OpenShift description: >- - The Vault Secrets Operator may be installed on OpenShift clusters via the embedded OperatorHub or the Helm chart. + Install the Vault Secrets Operator on OpenShift clusters via the embedded OperatorHub or the Helm chart. --- # Run the Vault Secrets Operator on OpenShift diff --git a/website/content/docs/platform/k8s/vso/secret-transformation.mdx b/website/content/docs/platform/k8s/vso/secret-transformation.mdx index 9d7de9291f19..79efaa9d83d2 100644 --- a/website/content/docs/platform/k8s/vso/secret-transformation.mdx +++ b/website/content/docs/platform/k8s/vso/secret-transformation.mdx @@ -1,8 +1,8 @@ --- layout: docs -page_title: Vault Secrets Operator Secret Transformation +page_title: Secret data transformation description: >- - Learn how to transform Secret data with the Vault Secrets Operator. + Learn how to transform secret data with the Vault Secrets Operator. --- # Secret data transformation diff --git a/website/content/docs/platform/k8s/vso/sources/hvs.mdx b/website/content/docs/platform/k8s/vso/sources/hvs.mdx index 86cea1d137bb..20f858be64cd 100644 --- a/website/content/docs/platform/k8s/vso/sources/hvs.mdx +++ b/website/content/docs/platform/k8s/vso/sources/hvs.mdx @@ -2,12 +2,10 @@ layout: docs page_title: Vault Secrets Operator with HCP Vault Secrets description: >- - The Vault Secrets Operator allows Pods to consume HCP Vault Secrets natively from Kubernetes Secrets. + The Vault Secrets Operator allows pods to consume HCP Vault Secrets natively from Kubernetes Secrets. --- -# HCP Vault Secrets source - -## Overview +# Vault Secrets Operator with HCP Vault Secrets The Vault secrets operator (VSO) syncs your [HCP Vault Secrets app](/hcp/docs/vault-secrets) (HVSA) to a Kubernetes Secret. Vault syncs each `HCPVaultSecretsApp` custom resource periodically to ensure that diff --git a/website/content/docs/platform/k8s/vso/sources/vault/auth/aws.mdx b/website/content/docs/platform/k8s/vso/sources/vault/auth/aws.mdx index bcc0d81b7841..5395cf128b5e 100644 --- a/website/content/docs/platform/k8s/vso/sources/vault/auth/aws.mdx +++ b/website/content/docs/platform/k8s/vso/sources/vault/auth/aws.mdx @@ -2,7 +2,7 @@ layout: docs page_title: AWS auth support for Vault Secrets Operator description: >- - Learn how AWS authentication works for Vault Secrets Operator + Learn how AWS authentication works for Vault Secrets Operator. --- # AWS auth support for Vault Secrets Operator diff --git a/website/content/docs/platform/k8s/vso/sources/vault/auth/gcp.mdx b/website/content/docs/platform/k8s/vso/sources/vault/auth/gcp.mdx index 68531edb3cf9..1f8cc4eeb2f0 100644 --- a/website/content/docs/platform/k8s/vso/sources/vault/auth/gcp.mdx +++ b/website/content/docs/platform/k8s/vso/sources/vault/auth/gcp.mdx @@ -2,7 +2,7 @@ layout: docs page_title: GCP auth support for Vault Secrets Operator description: >- - Learn how GCP authentication works for Vault Secrets Operator + Learn how GCP authentication works for Vault Secrets Operator. --- # GCP auth support for Vault Secrets Operator diff --git a/website/content/docs/platform/k8s/vso/sources/vault/auth/index.mdx b/website/content/docs/platform/k8s/vso/sources/vault/auth/index.mdx index 2dd96d9e13c9..b5d926fc1247 100644 --- a/website/content/docs/platform/k8s/vso/sources/vault/auth/index.mdx +++ b/website/content/docs/platform/k8s/vso/sources/vault/auth/index.mdx @@ -1,6 +1,6 @@ --- layout: docs -page_title: 'Vault Secrets Operator: Vault authentication details' +page_title: 'Vault authentication in detail' description: >- Authenticate to Vault with the Vault Secrets Operator. --- diff --git a/website/content/docs/platform/k8s/vso/telemetry.mdx b/website/content/docs/platform/k8s/vso/telemetry.mdx index e58211e67b75..b05aabc040a5 100644 --- a/website/content/docs/platform/k8s/vso/telemetry.mdx +++ b/website/content/docs/platform/k8s/vso/telemetry.mdx @@ -1,11 +1,11 @@ --- layout: docs -page_title: Vault Secrets Operator Telemetry +page_title: Vault Secrets Operator telemetry description: >- - The Vault Secrets Operator allows Pods to consume Vault secrets natively from Kubernetes Secrets. + Learn how the Vault Secrets Operator is instrumented with Prometheus metrics. --- -# Telemetry +# Vault Secrets Operator telemetry The Vault Secrets Operator is instrumented with Prometheus metrics in the following ways: * The operator will emit the default controller-runtime metrics as outlined in the [monitoring](https://book-v1.book.kubebuilder.io/beyond_basics/controller_metrics.html) diff --git a/website/content/docs/plugins/containerized-plugins/add-a-containerized-plugin.mdx b/website/content/docs/plugins/containerized-plugins/add-a-containerized-plugin.mdx index 0b2f377fcd1a..22924ff12c23 100644 --- a/website/content/docs/plugins/containerized-plugins/add-a-containerized-plugin.mdx +++ b/website/content/docs/plugins/containerized-plugins/add-a-containerized-plugin.mdx @@ -1,6 +1,6 @@ --- layout: docs -page_title: Add a containerized secrets plugin +page_title: Add a containerized secrets plugin to Vault description: >- Add a containerized secrets plugin to your Vault instance. --- diff --git a/website/content/docs/plugins/index.mdx b/website/content/docs/plugins/index.mdx index cd8a3e2e5e48..66c2d57f2618 100644 --- a/website/content/docs/plugins/index.mdx +++ b/website/content/docs/plugins/index.mdx @@ -1,7 +1,8 @@ --- layout: docs -page_title: Plugin System -description: Learn about Vault's plugin system. +page_title: Plugin system +description: >- + Learn about three types of Vault's plugins; auth methods, secret engines, and database plugins. --- diff --git a/website/content/docs/plugins/plugin-architecture.mdx b/website/content/docs/plugins/plugin-architecture.mdx index 6c02d1808b82..0c6b75c1041a 100644 --- a/website/content/docs/plugins/plugin-architecture.mdx +++ b/website/content/docs/plugins/plugin-architecture.mdx @@ -1,7 +1,7 @@ --- layout: docs -page_title: External Plugin Architecture -description: Learn about Vault's plugin architecture. +page_title: External plugin architecture +description: Learn about Vault's external plugin architecture and lifecycle. --- # External plugin architecture diff --git a/website/content/docs/plugins/plugin-development.mdx b/website/content/docs/plugins/plugin-development.mdx index 3947f8863964..7426f95e3bc2 100644 --- a/website/content/docs/plugins/plugin-development.mdx +++ b/website/content/docs/plugins/plugin-development.mdx @@ -1,7 +1,7 @@ --- layout: docs -page_title: Plugin Development -description: Learn about Vault plugin development. +page_title: Plugin development +description: Learn about building a Vault plugin. --- # Plugin development diff --git a/website/content/docs/plugins/plugin-management.mdx b/website/content/docs/plugins/plugin-management.mdx index 0738cff63de3..f7df7ea2fe66 100644 --- a/website/content/docs/plugins/plugin-management.mdx +++ b/website/content/docs/plugins/plugin-management.mdx @@ -1,9 +1,8 @@ --- layout: docs -page_title: Plugin Management +page_title: Plugin management description: >- - External Plugins are mountable backends that are implemented using Vault's - plugin system. + Learn how to manage external plugins that are implemented using Vault's plugin system. --- # Plugin management