backport of commit 8f6e95f (#29243)

Co-authored-by: Sarah Chavis <[email protected]>
hashicorp · Dec 20, 2024 · 556a5e1 · 556a5e1
1 parent 9905005
commit 556a5e1
Show file tree

Hide file tree

Showing 55 changed files with 283 additions and 328 deletions.
diff --git a/website/content/docs/configuration/adaptive-overload-protection.mdx b/website/content/docs/configuration/adaptive-overload-protection.mdx
@@ -1,12 +1,12 @@
 ---
 layout: docs
-page_title: Adaptive overload protection - Configuration
-description: |-
-  Use adaptive overload protection with Vault Enterprise to automatically
-  prevent workloads from overloading different resources of your Vault servers.
+page_title: adaptive_overload_protection - Configuration
+description: >-
+  Configure the adaptive_overload_protection stanza to customize automatic
+  prevention for resource overloads in Vault Enterprise servers.
 ---
 
-# `adaptive_overload_protection`
+# `adaptive_overload_protection` stanza
 
 @include 'alerts/enterprise-only.mdx'
 

diff --git a/website/content/docs/configuration/entropy-augmentation.mdx b/website/content/docs/configuration/entropy-augmentation.mdx
@@ -1,12 +1,12 @@
 ---
 layout: docs
-page_title: Entropy Augmentation - Configuration
+page_title: Configure entropy augmentation
 description: >-
-  Entropy augmentation enables Vault to sample entropy from external
-  cryptographic modules.
+  Configure entropy augmentation to sample entropy from external cryptographic
+  modules when sealing Vault.
 ---
 
-# `Entropy augmentation` seal
+# Configure entropy augmentation
 
 Entropy augmentation enables Vault to sample entropy from external cryptographic modules.
 Sourcing external entropy is done by configuring a supported [Seal](/vault/docs/configuration/seal) type which

diff --git a/website/content/docs/configuration/index.mdx b/website/content/docs/configuration/index.mdx
@@ -1,10 +1,11 @@
 ---
 layout: docs
-page_title: Server Configuration
-description: Vault server configuration reference.
+page_title: Vault configuration parameters
+description: >-
+  Example Vault configuration file and high-level parameter reference.
 ---
 
-# Vault configuration
+# Vault configuration parameters
 
 Outside of development mode, Vault servers are configured using a file.
 The format of this file is [HCL](https://github.com/hashicorp/hcl) or JSON.

diff --git a/website/content/docs/configuration/kms-library.mdx b/website/content/docs/configuration/kms-library.mdx
@@ -1,9 +1,9 @@
 ---
 layout: docs
-page_title: Kms Library - Configuration
+page_title: kms_library - Configuration
 description: >-
-  The kms_library stanza allows node specific configuration for access to
-  KMS access libraries
+  Configure the kms_library stanza to customize node-specific access to KMS
+  access libraries
 ---
 
 # `kms_library` stanza

diff --git a/website/content/docs/configuration/listener/index.mdx b/website/content/docs/configuration/listener/index.mdx
@@ -1,9 +1,9 @@
 ---
 layout: docs
-page_title: Listeners - Configuration
-description: |-
-  The listener stanza configures the addresses and ports on which Vault will
-  respond to requests.
+page_title: listener - Configuration
+description: >-
+  Configure the listener stanza to customize the addresses and ports where Vault
+  listens for, and responds to, requests.
 ---
 
 # `listener` stanza

diff --git a/website/content/docs/configuration/listener/tcp/index.mdx b/website/content/docs/configuration/listener/tcp/index.mdx
@@ -1,12 +1,11 @@
 ---
 layout: docs
-page_title: TCP - Listeners - Configuration
+page_title: TCP listener configuration
 description: >-
-  The TCP listener configures Vault to listen on the specified TCP address and
-  port.
+  Configure Vault to listen on a TCP address and port.
 ---
 
-# `tcp` listener
+# TCP listener configuration
 
 @include 'alerts/ipv6-compliance.mdx'
 

diff --git a/website/content/docs/configuration/listener/unix.mdx b/website/content/docs/configuration/listener/unix.mdx
@@ -1,11 +1,11 @@
 ---
 layout: docs
-page_title: Unix - Listeners - Configuration
-description: |-
-  The Unix listener configures Vault to listen on the specified Unix domain socket.
+page_title: Unix listener configuration
+description: >-
+  Configure Vault to listen on a Unix domain socket.
 ---
 
-# `unix` listener
+# Unix listener configuration
 
 The Unix listener configures Vault to listen on the specified Unix domain socket.
 

diff --git a/website/content/docs/configuration/log-requests-level.mdx b/website/content/docs/configuration/log-requests-level.mdx
@@ -1,11 +1,11 @@
 ---
 layout: docs
-page_title: Log Completed Requests - Configuration
-description: |-
-  Vault can be configured to log completed requests.
+page_title: Configure completed request logging
+description: >-
+  Configure the logging level for completed requests in Vault.
 ---
 
-# Log completed requests
+# Configure completed request logging
 
 Vault can be configured to log completed requests using the `log_requests_level` configuration parameter.
 

diff --git a/website/content/docs/configuration/prevent-lease-explosions.mdx b/website/content/docs/configuration/prevent-lease-explosions.mdx
@@ -2,7 +2,7 @@
 layout: docs
 page_title: Prevent lease explosions
 description: >-
-  Learn how to prevent lease explosions in Vault.
+  Best practices for avoiding, and dealing with, lease explosions in Vault.
 ---
 
 # Prevent lease explosions

diff --git a/website/content/docs/configuration/programmatic-management.mdx b/website/content/docs/configuration/programmatic-management.mdx
@@ -1,6 +1,6 @@
 ---
 layout: docs
-page_title: Manage Vault resources programmatically
+page_title: Manage Vault programmatically with Terraform
 description: >-
   Step-by-step instructions for managing Vault resources programmatically with
   Terraform

diff --git a/website/content/docs/configuration/replication.mdx b/website/content/docs/configuration/replication.mdx
@@ -2,7 +2,7 @@
 layout: docs
 page_title: Replication - Configuration
 description: |-
-  The replication stanza specifies various parameters for tuning replication related values.
+  Configure the replication stanza to tune replication behavior in Vault.
 ---
 
 # `replication` stanza

diff --git a/website/content/docs/configuration/reporting.mdx b/website/content/docs/configuration/reporting.mdx
@@ -1,11 +1,12 @@
 ---
 layout: docs
 page_title: Reporting - Configuration
-description: |-
-  The reporting stanza specifies various parameters for tuning reporting and licensing related values.
+description: >-
+  Configure the reporting stanza to customize the reporting behavior for tuning
+  and licensing in Vault.
 ---
 
-# `replication` stanza
+# `reporting` stanza
 
 @include 'alerts/enterprise-only.mdx'
 

diff --git a/website/content/docs/configuration/seal/alicloudkms.mdx b/website/content/docs/configuration/seal/alicloudkms.mdx
@@ -1,14 +1,11 @@
 ---
 layout: docs
-page_title: AliCloud KMS - Seals - Configuration
+page_title: AliCloud KMS seal configuration
 description: >-
-  The AliCloud KMS seal configures Vault to use AliCloud KMS as the seal
-  wrapping
-
-  mechanism.
+  Configure Vault sealing to use AliCloud KMS.
 ---
 
-# `alicloudkms` seal
+# AliCloud KMS seal configuration
 
 <Note title="Seal wrapping requires Vault Enterprise">
 

diff --git a/website/content/docs/configuration/seal/awskms.mdx b/website/content/docs/configuration/seal/awskms.mdx
@@ -1,12 +1,11 @@
 ---
 layout: docs
-page_title: AWS KMS - Seals - Configuration
-description: |-
-  The AWS KMS seal configures Vault to use AWS KMS as the seal wrapping
-  mechanism.
+page_title: AWS KMS seal configuration
+description: >-
+  Configure Vault sealing to use AWS KMS.
 ---
 
-# `awskms` seal
+# AWS KMS seal configuration
 
 <Note title="Seal wrapping requires Vault Enterprise">
 

diff --git a/website/content/docs/configuration/seal/azurekeyvault.mdx b/website/content/docs/configuration/seal/azurekeyvault.mdx
@@ -1,14 +1,11 @@
 ---
 layout: docs
-page_title: Azure Key Vault - Seals - Configuration
+page_title: Azure Key Vault seal configuration
 description: >-
-  The Azure Key Vault seal configures Vault to use Azure Key Vault as the seal
-  wrapping
-
-  mechanism.
+  Configure Vault sealing to use Azure Key Vault.
 ---
 
-# `azurekeyvault` seal
+# Azure Key Vault seal configuration
 
 <Note title="Seal wrapping requires Vault Enterprise">
 

diff --git a/website/content/docs/configuration/seal/gcpckms.mdx b/website/content/docs/configuration/seal/gcpckms.mdx
@@ -1,14 +1,11 @@
 ---
 layout: docs
-page_title: GCP Cloud KMS - Seals - Configuration
+page_title: GCP Cloud KMS seal configuration
 description: >-
-  The GCP Cloud KMS seal configures Vault to use GCP Cloud KMS as the seal
-  wrapping
-
-  mechanism.
+  Configure Vault sealing to use GCP Cloud KMS.
 ---
 
-# `gcpckms` seal
+# GCP Cloud KMS seal configuration
 
 <Note title="Seal wrapping requires Vault Enterprise">
 

diff --git a/website/content/docs/configuration/seal/index.mdx b/website/content/docs/configuration/seal/index.mdx
@@ -1,9 +1,8 @@
 ---
 layout: docs
-page_title: Seals - Configuration
+page_title: seal - Configuration
 description: >-
-  The seal stanza configures the seal type to use for additional data
-  protection.
+  Configure the seal stanza to customize the sealing behavior for Vault.
 ---
 
 # `seal` stanza

diff --git a/website/content/docs/configuration/seal/ocikms.mdx b/website/content/docs/configuration/seal/ocikms.mdx
@@ -1,12 +1,11 @@
 ---
 layout: docs
-page_title: OCI KMS - Seals - Configuration
-description: |-
-  The OCI KMS seal configures Vault to use OCI KMS as the seal wrapping
-  mechanism.
+page_title: OCI KM seal configuration
+description: >-
+  Configure Vault sealing to use OCI KMS.
 ---
 
-# `ocikms` seal
+# OCI KMS seal configuration
 
 <Note title="Seal wrapping requires Vault Enterprise">
 

diff --git a/website/content/docs/configuration/seal/pkcs11.mdx b/website/content/docs/configuration/seal/pkcs11.mdx
@@ -1,12 +1,11 @@
 ---
 layout: docs
-page_title: PKCS11 - Seals - Configuration
-description: |-
-  The PKCS11 seal configures Vault to use an HSM with PKCS11 as the seal
-  wrapping mechanism.
+page_title: HSM PKCS11 seal configuration
+description: >-
+  Configure Vault sealing to use PKCS11.
 ---
 
-# `pkcs11` seal
+# HSM PKCS11 seal configuration
 
 
 <Note title="Auto-unseal and seal wrapping requires Vault Enterprise">

diff --git a/website/content/docs/configuration/seal/seal-best-practices.mdx b/website/content/docs/configuration/seal/seal-best-practices.mdx
@@ -1,11 +1,11 @@
 ---
 layout: docs
-page_title: Seal best practices
+page_title: Sealing best practices
 description: >-
-  The recommended pattern and best practices for unsealing a production Vault cluster.
+  Best practices for configuring seal and unseal behavior in Vault.
 ---
 
-# Seal best practices
+# Sealing best practices
 
 This documentation explains the concepts, options, and considerations for unsealing a production Vault cluster. It builds on the [Reference Architecture](/vault/tutorials/raft/raft-reference-architecture) and [Deployment Guide](/vault/tutorials/day-one-raft/raft-deployment-guide) for Vault to deliver a pattern for a common Vault use case.
 

diff --git a/website/content/docs/configuration/seal/seal-ha.mdx b/website/content/docs/configuration/seal/seal-ha.mdx
@@ -1,11 +1,12 @@
 ---
 layout: docs
-page_title: Seal High Availability - Seals - Configuration
-description: |-
-  How to configure multiple Seals for high availability.
+page_title: Configure HA for Vault seals
+description: >-
+  Customize the seal stanza to support multiple seals in high availability
+  deployments.
 ---
 
-# Seal High Availability
+# Configure high availability for Vault seals
 
 @include 'alerts/enterprise-only.mdx'
 

diff --git a/website/content/docs/configuration/seal/transit-best-practices.mdx b/website/content/docs/configuration/seal/transit-best-practices.mdx
@@ -2,10 +2,11 @@
 layout: docs
 page_title: Transit auto-unseal best practices
 description: >-
-  Recommendations and best practices for using Vault's transit secrets engine to auto-unseal your production Vault clusters.
+  Best practices for using the Transit plugin for auto-unsealing production
+  Vault clusters.
 ---
 
-# Transit auto-unseal best practices
+# Auto-unseal best practices for the Transit plugin
 
 This document provides a framework for creating a usable solution for auto-unseal using Vault when HSM or cloud-based KMS auto-unseal mechanism is not available for your environment, such as in an internal data center deployment.
 

diff --git a/website/content/docs/configuration/seal/transit.mdx b/website/content/docs/configuration/seal/transit.mdx
@@ -1,12 +1,11 @@
 ---
 layout: docs
-page_title: Vault Transit - Seals - Configuration
-description: |-
-  The Transit seal configures Vault to use Vault's Transit Secret Engine as the
-  autoseal mechanism.
+page_title: Transit seal configuration
+description: >-
+  Configure Vault sealing to use the Transit secrets plugin.
 ---
 
-# `transit` seal
+# Transit seal configuration
 
 
 <Note title="Seal wrap functionality requires Vault Enterprise">

diff --git a/website/content/docs/configuration/sentinel.mdx b/website/content/docs/configuration/sentinel.mdx
@@ -1,8 +1,8 @@
 ---
 layout: docs
 page_title: Sentinel - Configuration
-description: |-
-  The sentinel stanza specifies configurations for Vault's Sentinel integration.
+description: >-
+  Configure the sentinel stanza to customize your Sentinel integration.
 ---
 
 # `sentinel` stanza

diff --git a/website/content/docs/configuration/service-registration/consul.mdx b/website/content/docs/configuration/service-registration/consul.mdx
@@ -1,14 +1,11 @@
 ---
 layout: docs
-page_title: Consul - Service Registration - Configuration
+page_title: Consul service registration
 description: >-
-  Consul Service Registration registers Vault as a service in Consul with a
-  default
-
-  health check.
+  Configure Vault to use Consul to manage service registration.
 ---
 
-# Consul service registration
+# Configure Consul service registration
 
 Consul Service Registration registers Vault as a service in [Consul][consul] with
 a default health check. When Consul is configured as the storage backend, the stanza

diff --git a/website/content/docs/configuration/service-registration/index.mdx b/website/content/docs/configuration/service-registration/index.mdx
@@ -1,9 +1,9 @@
 ---
 layout: docs
-page_title: Service Registration - Configuration
-description: |-
-  The optional `service_registration` stanza configures Vault's mechanism for
-  service registration.
+page_title: service_registration - Configuration
+description: >-
+  Configure the `service_registration` stanza to customize the service
+  registration mechanism for Vault.
 ---
 
 # `service_registration` stanza