[DOCS] SEO updates for config docs (#29242)

* seo updates for config docs

* fix content errors

* Make KMS title consistent with other stanza titles
This commit is contained in:
Sarah Chavis
2024-12-19 16:21:33 -08:00
committed by GitHub
parent f7ab5ca73d
commit 8f6e95f1a3
55 changed files with 283 additions and 328 deletions

View File

@@ -1,12 +1,12 @@
--- ---
layout: docs layout: docs
page_title: Adaptive overload protection - Configuration page_title: adaptive_overload_protection - Configuration
description: |- description: >-
Use adaptive overload protection with Vault Enterprise to automatically Configure the adaptive_overload_protection stanza to customize automatic
prevent workloads from overloading different resources of your Vault servers. prevention for resource overloads in Vault Enterprise servers.
--- ---
# `adaptive_overload_protection` # `adaptive_overload_protection` stanza
@include 'alerts/enterprise-only.mdx' @include 'alerts/enterprise-only.mdx'

View File

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

View File

@@ -1,10 +1,11 @@
--- ---
layout: docs layout: docs
page_title: Server Configuration page_title: Vault configuration parameters
description: Vault server configuration reference. 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. 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. The format of this file is [HCL](https://github.com/hashicorp/hcl) or JSON.

View File

@@ -1,9 +1,9 @@
--- ---
layout: docs layout: docs
page_title: Kms Library - Configuration page_title: kms_library - Configuration
description: >- description: >-
The kms_library stanza allows node specific configuration for access to Configure the kms_library stanza to customize node-specific access to KMS
KMS access libraries access libraries
--- ---
# `kms_library` stanza # `kms_library` stanza

View File

@@ -1,9 +1,9 @@
--- ---
layout: docs layout: docs
page_title: Listeners - Configuration page_title: listener - Configuration
description: |- description: >-
The listener stanza configures the addresses and ports on which Vault will Configure the listener stanza to customize the addresses and ports where Vault
respond to requests. listens for, and responds to, requests.
--- ---
# `listener` stanza # `listener` stanza

View File

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

View File

@@ -1,11 +1,11 @@
--- ---
layout: docs layout: docs
page_title: Unix - Listeners - Configuration page_title: Unix listener configuration
description: |- description: >-
The Unix listener configures Vault to listen on the specified Unix domain socket. 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. The Unix listener configures Vault to listen on the specified Unix domain socket.

View File

@@ -1,11 +1,11 @@
--- ---
layout: docs layout: docs
page_title: Log Completed Requests - Configuration page_title: Configure completed request logging
description: |- description: >-
Vault can be configured to log completed requests. 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. Vault can be configured to log completed requests using the `log_requests_level` configuration parameter.

View File

@@ -2,7 +2,7 @@
layout: docs layout: docs
page_title: Prevent lease explosions page_title: Prevent lease explosions
description: >- description: >-
Learn how to prevent lease explosions in Vault. Best practices for avoiding, and dealing with, lease explosions in Vault.
--- ---
# Prevent lease explosions # Prevent lease explosions

View File

@@ -1,6 +1,6 @@
--- ---
layout: docs layout: docs
page_title: Manage Vault resources programmatically page_title: Manage Vault programmatically with Terraform
description: >- description: >-
Step-by-step instructions for managing Vault resources programmatically with Step-by-step instructions for managing Vault resources programmatically with
Terraform Terraform

View File

@@ -2,7 +2,7 @@
layout: docs layout: docs
page_title: Replication - Configuration page_title: Replication - Configuration
description: |- description: |-
The replication stanza specifies various parameters for tuning replication related values. Configure the replication stanza to tune replication behavior in Vault.
--- ---
# `replication` stanza # `replication` stanza

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -1,9 +1,8 @@
--- ---
layout: docs layout: docs
page_title: Seals - Configuration page_title: seal - Configuration
description: >- description: >-
The seal stanza configures the seal type to use for additional data Configure the seal stanza to customize the sealing behavior for Vault.
protection.
--- ---
# `seal` stanza # `seal` stanza

View File

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

View File

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

View File

@@ -1,11 +1,11 @@
--- ---
layout: docs layout: docs
page_title: Seal best practices page_title: Sealing best practices
description: >- 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. 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.

View File

@@ -1,11 +1,12 @@
--- ---
layout: docs layout: docs
page_title: Seal High Availability - Seals - Configuration page_title: Configure HA for Vault seals
description: |- description: >-
How to configure multiple Seals for high availability. 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' @include 'alerts/enterprise-only.mdx'

View File

@@ -2,10 +2,11 @@
layout: docs layout: docs
page_title: Transit auto-unseal best practices page_title: Transit auto-unseal best practices
description: >- 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. 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.

View File

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

View File

@@ -1,8 +1,8 @@
--- ---
layout: docs layout: docs
page_title: Sentinel - Configuration page_title: Sentinel - Configuration
description: |- description: >-
The sentinel stanza specifies configurations for Vault's Sentinel integration. Configure the sentinel stanza to customize your Sentinel integration.
--- ---
# `sentinel` stanza # `sentinel` stanza

View File

@@ -1,14 +1,11 @@
--- ---
layout: docs layout: docs
page_title: Consul - Service Registration - Configuration page_title: Consul service registration
description: >- description: >-
Consul Service Registration registers Vault as a service in Consul with a Configure Vault to use Consul to manage service registration.
default
health check.
--- ---
# Consul service registration # Configure Consul service registration
Consul Service Registration registers Vault as a service in [Consul][consul] with 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 a default health check. When Consul is configured as the storage backend, the stanza

View File

@@ -1,9 +1,9 @@
--- ---
layout: docs layout: docs
page_title: Service Registration - Configuration page_title: service_registration - Configuration
description: |- description: >-
The optional `service_registration` stanza configures Vault's mechanism for Configure the `service_registration` stanza to customize the service
service registration. registration mechanism for Vault.
--- ---
# `service_registration` stanza # `service_registration` stanza

View File

@@ -1,12 +1,11 @@
--- ---
layout: docs layout: docs
page_title: Kubernetes - Service Registration - Configuration page_title: Kubernetes service registration
description: >- description: >-
Kubernetes Service Registration labels Vault pods with their current status Configure Vault to use Kubernetes to manage service registration.
for use with selectors.
--- ---
# Kubernetes service registration # Configure Kubernetes service registration
Kubernetes Service Registration tags Vault pods with their current status for Kubernetes Service Registration tags Vault pods with their current status for
use with selectors. Service registration is only available when Vault is running in use with selectors. Service registration is only available when Vault is running in

View File

@@ -1,12 +1,11 @@
--- ---
layout: docs layout: docs
page_title: Aerospike - Storage Backends - Configuration page_title: Aerospike configuration
description: |- description: >-
The Aerospike storage backend is used to persist Vault's data in an Aerospike Configure Vault backend storage to use Aerospike clusters.
cluster.
--- ---
# Aerospike storage backend # Aerospike configuration for Vault backend storage
The Aerospike storage backend is used to persist Vault's data in an The Aerospike storage backend is used to persist Vault's data in an
[Aerospike][aerospike] cluster. [Aerospike][aerospike] cluster.

View File

@@ -1,12 +1,11 @@
--- ---
layout: docs layout: docs
page_title: Alicloud OSS - Storage Backends - Configuration page_title: Alicloud OSS configuration
description: |- description: >-
The Alicloud OSS storage backend is used to persist Vault's data in Configure Vault backend storage to use Alicloud OSS buckets.
an Alicloud OSS bucket.
--- ---
# Alicloud OSS storage backend # Alicloud OSS configuration for Vault backend storage
The Alicloud OSS storage backend is used to persist Vault's data in The Alicloud OSS storage backend is used to persist Vault's data in
an [Alicloud OSS][alicloudoss] bucket. an [Alicloud OSS][alicloudoss] bucket.

View File

@@ -1,13 +1,11 @@
--- ---
layout: docs layout: docs
page_title: Azure - Storage Backends - Configuration page_title: Azure configuration
description: |- description: >-
The Azure storage backend is used to persist Vault's data in an Azure Storage Configure Vault backend storage to use Azure storage containers.
Container. The storage container must already exist and the provided account
credentials must have read and write permissions to the storage container.
--- ---
# Azure storage backend # Azure configuration for Vault backend storage
The Azure storage backend is used to persist Vault's data in an The Azure storage backend is used to persist Vault's data in an
[Azure Storage Container][azure-storage]. The storage container must already [Azure Storage Container][azure-storage]. The storage container must already

View File

@@ -1,12 +1,11 @@
--- ---
layout: docs layout: docs
page_title: Cassandra - Storage Backends - Configuration page_title: Cassandra configuration
description: |- description: >-
The Cassandra storage backend is used to persist Vault's data in an Apache Configure Vault backend storage to use an Apache Cassandra cluster.
Cassandra cluster.
--- ---
# Cassandra storage backend # Cassandra configuration for Vault backend storage
The Cassandra storage backend is used to persist Vault's data in an [Apache The Cassandra storage backend is used to persist Vault's data in an [Apache
Cassandra][cassandra] cluster. Cassandra][cassandra] cluster.

View File

@@ -1,12 +1,11 @@
--- ---
layout: docs layout: docs
page_title: CockroachDB - Storage Backends - Configuration page_title: CockroachDB configuration
description: >- description: >-
The CockroachDB storage backend is used to persist Vault's data in a Configure Vault backend storage to use CockroachDB servers or clusters.
CockroachDB server or cluster.
--- ---
# CockroachDB storage backend # CockroachDB configuration for Vault backend storage
The CockroachDB storage backend is used to persist Vault's data in a The CockroachDB storage backend is used to persist Vault's data in a
[CockroachDB][cockroachdb] server or cluster. [CockroachDB][cockroachdb] server or cluster.

View File

@@ -1,14 +1,11 @@
--- ---
layout: docs layout: docs
page_title: Consul - Storage Backends - Configuration page_title: Consul configuration
description: |- description: >-
The Consul storage backend is used to persist Vault's data in Consul's Configure Vault backend storage to use a Consul key-value store.
key-value store. In addition to providing durable storage, inclusion of this
backend will also register Vault as a service in Consul with a default health
check.
--- ---
# Consul storage backend # Consul configuration for Vault backend storage
The Consul storage backend is used to persist Vault's data in [Consul's][consul] The Consul storage backend is used to persist Vault's data in [Consul's][consul]
key-value store. In addition to providing durable storage, inclusion of this key-value store. In addition to providing durable storage, inclusion of this

View File

@@ -1,12 +1,11 @@
--- ---
layout: docs layout: docs
page_title: CouchDB - Storage Backends - Configuration page_title: CouchDB configuration
description: |- description: >-
The CouchDB storage backend is used to persist Vault's data in a CouchDB Configure Vault backend storage to use CouchDB.
database.
--- ---
# CouchDB storage backend # CouchDB configuration for Vault backend storage
The CouchDB storage backend is used to persist Vault's data in The CouchDB storage backend is used to persist Vault's data in
[CouchDB][couchdb] table. [CouchDB][couchdb] table.

View File

@@ -1,12 +1,11 @@
--- ---
layout: docs layout: docs
page_title: DynamoDB - Storage Backends - Configuration page_title: DynamoDB configuration
description: |- description: >-
The DynamoDB storage backend is used to persist Vault's data in DynamoDB Configure Vault backend storage to use DynamoDB tables.
table.
--- ---
# DynamoDB storage backend # DynamoDB configuration for Vault backend storage
The DynamoDB storage backend is used to persist Vault's data in The DynamoDB storage backend is used to persist Vault's data in
[DynamoDB][dynamodb] table. [DynamoDB][dynamodb] table.

View File

@@ -1,13 +1,11 @@
--- ---
layout: docs layout: docs
page_title: Etcd - Storage Backends - Configuration page_title: Etcd configuration
description: |- description: >-
The Etcd storage backend is used to persist Vault's data in Etcd. It supports Configure Vault backend storage to use Etcd clusters.
both the v2 and v3 Etcd APIs, and the version is automatically detected based
on the version of the Etcd cluster.
--- ---
# Etcd storage backend # Etcd configuration for Vault backend storage
The Etcd storage backend is used to persist Vault's data in [Etcd][etcd]. It The Etcd storage backend is used to persist Vault's data in [Etcd][etcd]. It
supports both the v2 and v3 Etcd APIs, and the version is automatically detected supports both the v2 and v3 Etcd APIs, and the version is automatically detected

View File

@@ -1,13 +1,12 @@
--- ---
layout: docs layout: docs
page_title: Filesystem - Storage Backends - Configuration page_title: File system configuration
description: |- description: >-
The Filesystem storage backend stores Vault's data on the filesystem using a Configure Vault backend storage to use a standard directory structure on the
standard directory structure. It can be used for durable single server local filesystem.
situations, or to develop locally where durability is not critical.
--- ---
# Filesystem storage backend # File system configuration for Vault backend storage
The Filesystem storage backend stores Vault's data on the filesystem using a The Filesystem storage backend stores Vault's data on the filesystem using a
standard directory structure. It can be used for durable single server standard directory structure. It can be used for durable single server

View File

@@ -1,12 +1,11 @@
--- ---
layout: docs layout: docs
page_title: FoundationDB - Storage Backends - Configuration page_title: FoundationDB configuration
description: |- description: >-
The FoundationDB storage backend is used to persist Vault's data in the Configure Vault backend storage to use the FoundationDB KV store.
FoundationDB KV store.
--- ---
# FoundationDB storage backend # FoundationDB configuration for Vault backend storage
The FoundationDB storage backend is used to persist Vault's data in The FoundationDB storage backend is used to persist Vault's data in
[FoundationDB][foundationdb]. [FoundationDB][foundationdb].

View File

@@ -1,13 +1,11 @@
--- ---
layout: docs layout: docs
page_title: Google Cloud Spanner - Storage Backends - Configuration page_title: Google Cloud Spanner configuration
description: |- description: >-
The Google Cloud Spanner storage backend is used to persist Vault's data in Configure Vault backend storage to use Google Cloud Spanner.
Spanner, a fully managed, mission-critical, relational database service that
offers transactional consistency at global scale.
--- ---
# Google Cloud spanner storage backend # Google Cloud Spanner configuration for Vault backend storage
The Google Cloud Spanner storage backend is used to persist Vault's data in The Google Cloud Spanner storage backend is used to persist Vault's data in
[Spanner][spanner-docs], a fully managed, mission-critical, relational database [Spanner][spanner-docs], a fully managed, mission-critical, relational database

View File

@@ -1,12 +1,11 @@
--- ---
layout: docs layout: docs
page_title: Google Cloud Storage - Storage Backends - Configuration page_title: Google Cloud Storage configuration
description: |- description: >-
The Google Cloud Storage storage backend is used to persist Vault's data in Configure Vault backend storage to use Google Cloud Storage.
Google Cloud Storage.
--- ---
# Google Cloud storage storage backend # Google Cloud Storage configuration for Vault backend storage
The Google Cloud Storage storage backend is used to persist Vault's data in The Google Cloud Storage storage backend is used to persist Vault's data in
[Google Cloud Storage][gcs-docs]. [Google Cloud Storage][gcs-docs].

View File

@@ -1,14 +1,11 @@
--- ---
layout: docs layout: docs
page_title: In-Memory - Storage Backends - Configuration page_title: In-memory storage configuration
description: |- description: >-
The In-Memory storage backend is used to persist Vault's data entirely Configure Vault backend storage to use in-memory storage.
in-memory on the same machine in which Vault is running. This is useful for
development and experimentation, but use of this backend is highly discouraged
in production except in very specific use-cases.
--- ---
# In-Memory storage backend # In-memory storage configuration for Vault backend storage
The In-Memory storage backend is used to persist Vault's data entirely in-memory The In-Memory storage backend is used to persist Vault's data entirely in-memory
on the same machine in which Vault is running. This is useful for development on the same machine in which Vault is running. This is useful for development

View File

@@ -1,12 +1,9 @@
--- ---
layout: docs layout: docs
page_title: Storage Backends - Configuration page_title: storage - Configuration
description: |- description: >-
The storage stanza configures the storage backend, which represents the Configure the storage stanza to customize persistent, backend storage for
location for the durable storage of Vault's information. Each backend has Vault.
pros, cons, advantages, and trade-offs. For example, some backends support
high availability while others provide a more robust backup and restoration
process.
--- ---
# `storage` stanza # `storage` stanza

View File

@@ -1,14 +1,11 @@
--- ---
layout: docs layout: docs
page_title: Manta - Storage Backends - Configuration page_title: Manta configuration
description: >- description: >-
The Manta storage backend is used to persist Vault's data in Triton's Manta Configure Vault backend storage to use Manta Object Storage from Triton.
Object
Storage. The storage folder must already exist.
--- ---
# Manta storage backend # Manta Object Storage configuration for Vault backend storage
The Manta storage backend is used to persist Vault's data in [Triton's Manta Object The Manta storage backend is used to persist Vault's data in [Triton's Manta Object
Storage][manta-object-store]. The storage folder must already exist. Storage][manta-object-store]. The storage folder must already exist.

View File

@@ -1,12 +1,11 @@
--- ---
layout: docs layout: docs
page_title: MSSQL - Storage Backends - Configuration page_title: MSSQL configuration
description: >- description: >-
The MSSQL storage backend is used to persist Vault's data in a Microsoft SQL Configure Vault backend storage to use Microsoft SQL Server.
Server.
--- ---
# MSSQL storage backend # Microsoft SQL Server configuration for Vault backend storage
The MSSQL storage backend is used to persist Vault's data in a Microsoft SQL Server. The MSSQL storage backend is used to persist Vault's data in a Microsoft SQL Server.

View File

@@ -1,12 +1,11 @@
--- ---
layout: docs layout: docs
page_title: MySQL - Storage Backends - Configuration page_title: MySQL configuration
description: |- description: >-
The MySQL storage backend is used to persist Vault's data in a MySQL server or Configure Vault backend storage to use a MySQL server or cluster.
cluster.
--- ---
# MySQL storage backend # MySQL configuration for Vault backend storage
The MySQL storage backend is used to persist Vault's data in a [MySQL][mysql] The MySQL storage backend is used to persist Vault's data in a [MySQL][mysql]
server or cluster. server or cluster.

View File

@@ -1,12 +1,12 @@
--- ---
layout: docs layout: docs
page_title: OCI Object Storage - Storage Backends - Configuration page_title: OCI Object Storage configuration
description: >- description: >-
The OCI Object Storage backend is used to persist Vault's data in OCI Object The OCI Object Storage backend is used to persist Vault's data in OCI Object
Storage. Storage.
--- ---
# OCI object storage storage backend # OCI Object Storage configuration for Vault backend storage
The OCI Object Storage backend is used to persist Vault's data in OCI Object Storage. The OCI Object Storage backend is used to persist Vault's data in OCI Object Storage.

View File

@@ -1,12 +1,11 @@
--- ---
layout: docs layout: docs
page_title: PostgreSQL - Storage Backends - Configuration page_title: PostgreSQL configuration
description: |- description: >-
The PostgreSQL storage backend is used to persist Vault's data in a PostgreSQL Configure Vault backend storage to use a PostgreSQL server or cluster.
server or cluster.
--- ---
# PostgreSQL storage backend # PostgreSQL configuration for Vault backend storage
The PostgreSQL storage backend is used to persist Vault's data in a The PostgreSQL storage backend is used to persist Vault's data in a
[PostgreSQL][postgresql] server or cluster. [PostgreSQL][postgresql] server or cluster.

View File

@@ -1,13 +1,11 @@
--- ---
layout: docs layout: docs
page_title: Integrated Storage - Storage Backends - Configuration page_title: Integrated storage configuration
description: >- description: >-
The Integrated Storage (Raft) backend is used to persist Vault's data. Unlike all the other Configure Vault backend storage to use the integrated storage backend so that
storage backends, this backend does not operate from a single source for the all the nodes in a Vault cluster have a replicated copy of persistent storage
data. Instead all the nodes in a Vault cluster will have a replicated copy of managed by the Raft consensus algorithm.
the entire data. The data is replicated across the nodes using the Raft
Consensus Algorithm.
--- ---
# Integrated storage (Raft) backend # Integrated storage (Raft) backend

View File

@@ -1,12 +1,11 @@
--- ---
layout: docs layout: docs
page_title: S3 - Storage Backends - Configuration page_title: S3 configuration
description: |- description: >-
The S3 storage backend is used to persist Vault's data in an Amazon S3 Configure Vault backend storage to use Amazon S3 buckets.
bucket.
--- ---
# S3 storage backend # S3 configuration for Vault backend storage
The S3 storage backend is used to persist Vault's data in an [Amazon S3][s3] The S3 storage backend is used to persist Vault's data in an [Amazon S3][s3]
bucket. bucket.

View File

@@ -1,12 +1,11 @@
--- ---
layout: docs layout: docs
page_title: Swift - Storage Backends - Configuration page_title: Swift configuration
description: |- description: >-
The Swift storage backend is used to persist Vault's data in an OpenStack Configure Vault backend storage to use OpenStack Swift containers.
Swift Container.
--- ---
# Swift storage backend # Swift configuration for Vault backend storage
The Swift storage backend is used to persist Vault's data in an The Swift storage backend is used to persist Vault's data in an
[OpenStack Swift Container][swift]. [OpenStack Swift Container][swift].

View File

@@ -1,10 +1,11 @@
--- ---
layout: docs layout: docs
page_title: Zookeeper - Storage Backends - Configuration page_title: Zookeeper configuration
description: The Zookeeper storage backend is used to persist Vault's data in Zookeeper. description: >-
Configure Vault backend storage to use Zookeeper.
--- ---
# Zookeeper storage backend # Zookeeper configuration for Vault backend storage
The Zookeeper storage backend is used to persist Vault's data in The Zookeeper storage backend is used to persist Vault's data in
[Zookeeper][zk]. [Zookeeper][zk].

View File

@@ -1,9 +1,9 @@
--- ---
layout: docs layout: docs
page_title: Telemetry - Configuration page_title: Telemetry - Configuration
description: |- description: >-
The telemetry stanza specifies various configurations for Vault to publish Configure the telemetry stanza to publish Vault usage metrics to upstream
metrics to upstream systems. systems.
--- ---
# `telemetry` stanza # `telemetry` stanza

View File

@@ -1,23 +1,19 @@
--- ---
layout: docs layout: docs
page_title: UI - Configuration page_title: GUI - Configuration
description: |- description: >-
Vault features a user interface (web interface) for interacting with Vault. Configure the web interface (GUI) for Vault.
Easily create, read, update, and delete secrets, authenticate, unseal, and
more with the Vault UI.
--- ---
# Vault UI # Vault GUI configuration
Vault features a user interface (web interface) for interacting with Vault. Vault features a user interface (web interface) for interacting with Vault.
Easily create, read, update, and delete secrets, authenticate, unseal, and Easily create, read, update, and delete secrets, authenticate, unseal, and
more with the Vault UI. more with the Vault GUI.
-> The UI requires **Vault 0.10 or higher** or Vault Enterprise. ## Activating the Vault GUI
## Activating the Vault UI The Vault GUI is not activated by default. To activate the UI, set the `ui`
The Vault UI is not activated by default. To activate the UI, set the `ui`
configuration option in the Vault server configuration. Vault clients do not configuration option in the Vault server configuration. Vault clients do not
need to set this option, since they will not be serving the UI. need to set this option, since they will not be serving the UI.
@@ -32,7 +28,7 @@ listener "tcp" {
For more information, please see the For more information, please see the
[Vault configuration options](/vault/docs/configuration). [Vault configuration options](/vault/docs/configuration).
## Accessing the Vault UI ## Accessing the Vault GUI
The UI runs on the same port as the Vault listener. As such, you must configure The UI runs on the same port as the Vault listener. As such, you must configure
at least one `listener` stanza in order to access the UI. at least one `listener` stanza in order to access the UI.
@@ -41,7 +37,7 @@ at least one `listener` stanza in order to access the UI.
listener "tcp" { listener "tcp" {
address = "10.0.1.35:8200" address = "10.0.1.35:8200"
# If bound to localhost, the Vault UI is only # If bound to localhost, the Vault GUI is only
# accessible from the local machine! # accessible from the local machine!
# address = "127.0.0.1:8200" # address = "127.0.0.1:8200"
} }
@@ -64,16 +60,16 @@ https://vault.service.consul:8200/ui/
### Note on TLS ### Note on TLS
When using TLS (recommended), the certificate must be valid for all DNS entries When using TLS (recommended), the certificate must be valid for all DNS entries
you will be accessing the Vault UI on, and any IP addresses on the SAN. If you you will be accessing the Vault GUI on, and any IP addresses on the SAN. If you
are running Vault with a self-signed certificate, any browsers that access the are running Vault with a self-signed certificate, any browsers that access the
Vault UI will need to have the root CA installed. Failure to do so may result in Vault GUI will need to have the root CA installed. Failure to do so may result in
the browser displaying a warning that the site is "untrusted". It is highly the browser displaying a warning that the site is "untrusted". It is highly
recommended that client browsers accessing the Vault UI install the proper CA recommended that client browsers accessing the Vault GUI install the proper CA
root for validation to reduce the chance of a MITM attack. root for validation to reduce the chance of a MITM attack.
## Vault UI Web REPL ## CLI emulation in the Vault GUI
The Vault UI includes an interactive Web REPL to interact with Vault's API much The Vault GUI includes an interactive Web REPL to interact with Vault's API much
like the Vault CLI. For more on that, see the like the Vault CLI. For more on that, see the
[Web REPL documentation](/vault/docs/commands/web). [Web REPL documentation](/vault/docs/commands/web).

View File

@@ -1,10 +1,11 @@
--- ---
layout: docs layout: docs
page_title: User Lockout - Configuration page_title: User lockout - Configuration
description: |- description: >-
The user_lockout stanza specifies various configurations for user lockout behaviour for Configure the user_lockout stanza to customize lockout behavior for failed
failed logins in vault. logins in vault.
--- ---
# User lockout # User lockout
@include 'user-lockout.mdx' @include 'user-lockout.mdx'

View File

@@ -320,14 +320,14 @@
"path": "concepts/duration-format" "path": "concepts/duration-format"
}, },
{ {
"title": "User Lockout", "title": "User lockout",
"path": "concepts/user-lockout" "path": "concepts/user-lockout"
}, },
{ {
"title": "Events", "title": "Events",
"path": "concepts/events", "path": "concepts/events",
"badge": { "badge": {
"text": "ENTERPRISE", "text": "ENT",
"type": "outlined", "type": "outlined",
"color": "neutral" "color": "neutral"
} }
@@ -336,7 +336,7 @@
"title": "Filtering", "title": "Filtering",
"path": "concepts/filtering", "path": "concepts/filtering",
"badge": { "badge": {
"text": "ENTERPRISE", "text": "ENT",
"type": "outlined", "type": "outlined",
"color": "neutral" "color": "neutral"
} }
@@ -344,7 +344,7 @@
{ {
"title": "Adaptive overload protection", "title": "Adaptive overload protection",
"badge": { "badge": {
"text": "ENTERPRISE", "text": "ENT",
"type": "outlined", "type": "outlined",
"color": "neutral" "color": "neutral"
}, },
@@ -365,9 +365,13 @@
"title": "Configuration", "title": "Configuration",
"routes": [ "routes": [
{ {
"title": "Overview", "title": "Parameter overview ",
"path": "configuration" "path": "configuration"
}, },
{
"title": "GUI configuration",
"path": "configuration/ui"
},
{ {
"title": "Programmatic best practices", "title": "Programmatic best practices",
"path": "configuration/programmatic-best-practices" "path": "configuration/programmatic-best-practices"
@@ -384,6 +388,40 @@
"title": "Create a lease count quota", "title": "Create a lease count quota",
"path": "configuration/create-lease-count-quota" "path": "configuration/create-lease-count-quota"
}, },
{
"title": "Configure completed request logging",
"path": "configuration/log-requests-level"
},
{
"title": "Configure entropy augmentation",
"badge": {
"text": "ENT",
"type": "outlined",
"color": "neutral"
},
"path": "configuration/entropy-augmentation"
},
{ "heading": "Configuration stanzas" },
{
"title": "<code>adaptive_overload_protection</code>",
"badge": {
"text": "ENT",
"type": "outlined",
"color": "neutral"
},
"path": "configuration/adaptive-overload-protection"
},
{
"title": "<code>kms_library</code>",
"badge": {
"text": "ENT",
"type": "outlined",
"color": "neutral"
},
"path": "configuration/kms-library"
},
{ {
"title": "<code>listener</code>", "title": "<code>listener</code>",
"routes": [ "routes": [
@@ -392,10 +430,10 @@
"path": "configuration/listener" "path": "configuration/listener"
}, },
{ {
"title": "TCP", "title": "TCP listener configuration",
"routes": [ "routes": [
{ {
"title": "Overview", "title": "Basic configuration",
"path": "configuration/listener/tcp" "path": "configuration/listener/tcp"
}, },
{ {
@@ -405,7 +443,7 @@
] ]
}, },
{ {
"title": "Unix", "title": "Unix listener configuration",
"path": "configuration/listener/unix" "path": "configuration/listener/unix"
} }
] ]
@@ -413,7 +451,7 @@
{ {
"title": "<code>replication</code>", "title": "<code>replication</code>",
"badge": { "badge": {
"text": "ENTERPRISE", "text": "ENT",
"type": "outlined", "type": "outlined",
"color": "neutral" "color": "neutral"
}, },
@@ -422,7 +460,7 @@
{ {
"title": "<code>reporting</code>", "title": "<code>reporting</code>",
"badge": { "badge": {
"text": "ENTERPRISE", "text": "ENT",
"type": "outlined", "type": "outlined",
"color": "neutral" "color": "neutral"
}, },
@@ -436,18 +474,19 @@
"path": "configuration/seal" "path": "configuration/seal"
}, },
{ {
"title": "Seal best practices", "title": "Sealing best practices",
"path": "configuration/seal/seal-best-practices" "path": "configuration/seal/seal-best-practices"
}, },
{ {
"title": "High Availability", "title": "Configure HA for seals",
"badge": { "badge": {
"text": "ENTERPRISE", "text": "ENT",
"type": "outlined", "type": "outlined",
"color": "neutral" "color": "neutral"
}, },
"path": "configuration/seal/seal-ha" "path": "configuration/seal/seal-ha"
}, },
{ "heading": "Seal wrapper options" },
{ {
"title": "AliCloud KMS", "title": "AliCloud KMS",
"path": "configuration/seal/alicloudkms" "path": "configuration/seal/alicloudkms"
@@ -471,18 +510,18 @@
{ {
"title": "HSM PKCS11", "title": "HSM PKCS11",
"badge": { "badge": {
"text": "ENTERPRISE", "text": "ENT",
"type": "outlined", "type": "outlined",
"color": "neutral" "color": "neutral"
}, },
"path": "configuration/seal/pkcs11" "path": "configuration/seal/pkcs11"
}, },
{ {
"title": "Vault Transit", "title": "Transit plugin",
"path": "configuration/seal/transit" "path": "configuration/seal/transit"
}, },
{ {
"title": "Transit best practices", "title": "Auto-unseal best practices for Transit",
"path": "configuration/seal/transit-best-practices" "path": "configuration/seal/transit-best-practices"
} }
] ]
@@ -490,7 +529,7 @@
{ {
"title": "<code>sentinel</code>", "title": "<code>sentinel</code>",
"badge": { "badge": {
"text": "ENTERPRISE", "text": "ENT",
"type": "outlined", "type": "outlined",
"color": "neutral" "color": "neutral"
}, },
@@ -503,6 +542,7 @@
"title": "Overview", "title": "Overview",
"path": "configuration/service-registration" "path": "configuration/service-registration"
}, },
{ "heading": "Service registration options" },
{ {
"title": "Consul", "title": "Consul",
"path": "configuration/service-registration/consul" "path": "configuration/service-registration/consul"
@@ -517,9 +557,10 @@
"title": "<code>storage</code>", "title": "<code>storage</code>",
"routes": [ "routes": [
{ {
"title": "Overview", "title": "Backend storage for Vault",
"path": "configuration/storage" "path": "configuration/storage"
}, },
{ "heading": "Storage options" },
{ {
"title": "Aerospike", "title": "Aerospike",
"path": "configuration/storage/aerospike" "path": "configuration/storage/aerospike"
@@ -573,9 +614,13 @@
"path": "configuration/storage/google-cloud-storage" "path": "configuration/storage/google-cloud-storage"
}, },
{ {
"title": "In-Memory", "title": "In-memory storage",
"path": "configuration/storage/in-memory" "path": "configuration/storage/in-memory"
}, },
{
"title": "Integrated storage (Raft)",
"path": "configuration/storage/raft"
},
{ {
"title": "Manta", "title": "Manta",
"path": "configuration/storage/manta" "path": "configuration/storage/manta"
@@ -596,10 +641,6 @@
"title": "PostgreSQL", "title": "PostgreSQL",
"path": "configuration/storage/postgresql" "path": "configuration/storage/postgresql"
}, },
{
"title": "Integrated Storage (Raft)",
"path": "configuration/storage/raft"
},
{ {
"title": "S3", "title": "S3",
"path": "configuration/storage/s3" "path": "configuration/storage/s3"
@@ -618,44 +659,9 @@
"title": "<code>telemetry</code>", "title": "<code>telemetry</code>",
"path": "configuration/telemetry" "path": "configuration/telemetry"
}, },
{
"title": "Adaptive overload protection",
"badge": {
"text": "ENTERPRISE",
"type": "outlined",
"color": "neutral"
},
"path": "configuration/adaptive-overload-protection"
},
{
"title": "<code>ui</code>",
"path": "configuration/ui"
},
{ {
"title": "<code>user_lockout</code>", "title": "<code>user_lockout</code>",
"path": "configuration/user-lockout" "path": "configuration/user-lockout"
},
{
"title": "<code>Log Completed Requests</code>",
"path": "configuration/log-requests-level"
},
{
"title": "<code>Entropy Augmentation</code>",
"badge": {
"text": "ENTERPRISE",
"type": "outlined",
"color": "neutral"
},
"path": "configuration/entropy-augmentation"
},
{
"title": "<code>kms_library</code>",
"badge": {
"text": "ENTERPRISE",
"type": "outlined",
"color": "neutral"
},
"path": "configuration/kms-library"
} }
] ]
}, },
@@ -1193,7 +1199,7 @@
"title": "Custom Messages", "title": "Custom Messages",
"path": "ui/custom-messages", "path": "ui/custom-messages",
"badge": { "badge": {
"text": "ENTERPRISE", "text": "ENT",
"type": "outlined", "type": "outlined",
"color": "neutral" "color": "neutral"
} }
@@ -1308,7 +1314,7 @@
"title": "Improve Vault traffic resiliency", "title": "Improve Vault traffic resiliency",
"path": "agent-and-proxy/proxy/caching/static-secret-caching", "path": "agent-and-proxy/proxy/caching/static-secret-caching",
"badge": { "badge": {
"text": "ENTERPRISE", "text": "ENT",
"type": "outlined", "type": "outlined",
"color": "neutral" "color": "neutral"
} }
@@ -1539,7 +1545,7 @@
{ {
"title": "Key Management", "title": "Key Management",
"badge": { "badge": {
"text": "ENTERPRISE", "text": "ENT",
"type": "outlined", "type": "outlined",
"color": "neutral" "color": "neutral"
}, },
@@ -1658,7 +1664,7 @@
{ {
"title": "KMIP", "title": "KMIP",
"badge": { "badge": {
"text": "ENTERPRISE", "text": "ENT",
"type": "outlined", "type": "outlined",
"color": "neutral" "color": "neutral"
}, },
@@ -1715,7 +1721,7 @@
{ {
"title": "Certificate Issuance External Policy Service (CIEPS)", "title": "Certificate Issuance External Policy Service (CIEPS)",
"badge": { "badge": {
"text": "ENTERPRISE", "text": "ENT",
"type": "outlined", "type": "outlined",
"color": "neutral" "color": "neutral"
}, },
@@ -1725,7 +1731,7 @@
"title": "Enrollment over Secure Transport (EST)", "title": "Enrollment over Secure Transport (EST)",
"path": "secrets/pki/est", "path": "secrets/pki/est",
"badge": { "badge": {
"text": "ENTERPRISE", "text": "ENT",
"type": "outlined", "type": "outlined",
"color": "neutral" "color": "neutral"
}, },
@@ -1734,7 +1740,7 @@
{ {
"title": "Certificate Management Protocol (CMPv2)", "title": "Certificate Management Protocol (CMPv2)",
"badge": { "badge": {
"text": "ENTERPRISE", "text": "ENT",
"type": "outlined", "type": "outlined",
"color": "neutral" "color": "neutral"
}, },
@@ -1778,7 +1784,7 @@
{ {
"title": "Transform", "title": "Transform",
"badge": { "badge": {
"text": "ENTERPRISE", "text": "ENT",
"type": "outlined", "type": "outlined",
"color": "neutral" "color": "neutral"
}, },
@@ -1794,7 +1800,7 @@
{ {
"title": "Tokenization Transform", "title": "Tokenization Transform",
"badge": { "badge": {
"text": "ENTERPRISE", "text": "ENT",
"type": "outlined", "type": "outlined",
"color": "neutral" "color": "neutral"
}, },
@@ -1824,7 +1830,7 @@
{ {
"title": "Secrets Sync", "title": "Secrets Sync",
"badge": { "badge": {
"text": "ENTERPRISE", "text": "ENT",
"type": "outlined", "type": "outlined",
"color": "neutral" "color": "neutral"
}, },
@@ -1858,7 +1864,7 @@
{ {
"title": "Secrets Import", "title": "Secrets Import",
"badge": { "badge": {
"text": "ENTERPRISE", "text": "ENT",
"type": "outlined", "type": "outlined",
"color": "neutral" "color": "neutral"
}, },
@@ -2028,7 +2034,7 @@
{ {
"title": "Use SAML authentication", "title": "Use SAML authentication",
"badge": { "badge": {
"text": "ENTERPRISE", "text": "ENT",
"type": "outlined", "type": "outlined",
"color": "neutral" "color": "neutral"
}, },
@@ -2125,7 +2131,7 @@
"title": "Plugin Development — Event Notifications", "title": "Plugin Development — Event Notifications",
"path": "plugins/plugin-development-event-notifications", "path": "plugins/plugin-development-event-notifications",
"badge": { "badge": {
"text": "ENTERPRISE", "text": "ENT",
"type": "outlined", "type": "outlined",
"color": "neutral" "color": "neutral"
} }
@@ -3055,7 +3061,7 @@
"title": "Run Vault with many namespaces", "title": "Run Vault with many namespaces",
"path": "enterprise/namespaces/namespace-limits", "path": "enterprise/namespaces/namespace-limits",
"badge": { "badge": {
"text": "ENTERPRISE", "text": "ENT",
"type": "outlined", "type": "outlined",
"color": "neutral" "color": "neutral"
} }
@@ -3064,7 +3070,7 @@
"title": "Configure cross namespace access", "title": "Configure cross namespace access",
"path": "enterprise/namespaces/configure-cross-namespace-access", "path": "enterprise/namespaces/configure-cross-namespace-access",
"badge": { "badge": {
"text": "ENTERPRISE", "text": "ENT",
"type": "outlined", "type": "outlined",
"color": "neutral" "color": "neutral"
} }