scottk/vault
1
0
Fork 0
mirror of https://github.com/optim-enterprises-bv/vault.git synced 2025-11-01 02:57:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Update the PKI secrets engine docs title & description (#29136)

Browse Source 
* Update the PKI secrets engine docs title & description

* Update website/content/docs/secrets/pki/index.mdx

Co-authored-by: Jonathan Frappier <92055993+jonathanfrappier@users.noreply.github.com>

* Incorporate the review feedback

---------

Co-authored-by: Jonathan Frappier <92055993+jonathanfrappier@users.noreply.github.com>
This commit is contained in:
Yoko Hyakuna
2024-12-19 05:36:16 -08:00
committed by GitHub
parent f975259267
commit 32ba53f3c4
11 changed files with 52 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
website/content/docs/secrets/pki/cieps.mdx
View File

@@ -1,10 +1,11 @@
--- ---
layout: docs layout: docs
page_title: Certificate Issuance External Policy (CIEPS) | PKI - Secrets Engines page_title: Certificate Issuance External Policy Service (CIEPS)
description: An overview of the Certificate Issuance External Policy (CIEPS) protocol description: >-
High-level architecture overview and service APIs used by the PKI secrets engine when communicating with the Certificate Issuance External Policy Service (CIEPS).
--- ---
# PKI secrets engine - Certificate Issuance External Policy Service (CIEPS) <EnterpriseAlert inline="true" /> # Certificate Issuance External Policy Service (CIEPS) <EnterpriseAlert inline="true" />
This document covers high-level architecture and service APIs used by the This document covers high-level architecture and service APIs used by the
Vault PKI Secrets Engine when communicating with the Certificate Issuance Vault PKI Secrets Engine when communicating with the Certificate Issuance

4
website/content/docs/secrets/pki/cmpv2.mdx
View File

@@ -1,10 +1,10 @@
--- ---
layout: docs layout: docs
page_title: Certificate Management Protocol v2 (CMPv2) within Vault | PKI - Secrets Engines page_title: Certificate Management Protocol v2 (CMPv2)
description: An overview of the Certificate Management Protocol (v2) implementation within Vault. description: An overview of the Certificate Management Protocol (v2) implementation within Vault.
--- ---
# PKI secrets engine - Certificate Management Protocol v2 (CMPv2) <EnterpriseAlert inline="true" /> # Certificate Management Protocol v2 (CMPv2) <EnterpriseAlert inline="true" />
This document summarizes Vault's PKI Secrets Engine This document summarizes Vault's PKI Secrets Engine
implementation of the [CMPv2 protocol](https://datatracker.ietf.org/doc/html/rfc4210) <EnterpriseAlert inline="true" />, implementation of the [CMPv2 protocol](https://datatracker.ietf.org/doc/html/rfc4210) <EnterpriseAlert inline="true" />,

7
website/content/docs/secrets/pki/considerations.mdx
View File

@@ -1,10 +1,11 @@
--- ---
layout: docs layout: docs
page_title: 'PKI - Secrets Engines: Considerations' page_title: 'PKI secrets engine considerations'
description: The PKI secrets engine for Vault generates TLS certificates. description: >-
Understand the important considerations and guidance before using the PKI secrets engine to generate certificates before using the PKI secrets engine.
--- ---
# PKI secrets engine - considerations # PKI secrets engine considerations
To successfully deploy this secrets engine, there are a number of important To successfully deploy this secrets engine, there are a number of important
considerations to be aware of, as well as some preparatory steps that should be considerations to be aware of, as well as some preparatory steps that should be

7
website/content/docs/secrets/pki/est.mdx
View File

@@ -1,10 +1,11 @@
--- ---
layout: docs layout: docs
page_title: Enrollment over Secure Transport (EST) within Vault | PKI - Secrets Engines page_title: Enrollment over Secure Transport (EST)
description: An overview of the Enrollment over Secure Transport protocol implementation within Vault. description: >-
Understand the configuration and limitations of Vault's PKI secrets engine implementation of the Enrollment over Secure Transport (EST) protocol.
--- ---
# PKI secrets engine - Enrollment over Secure Transport (EST) <EnterpriseAlert inline="true" /> # Enrollment over Secure Transport (EST) <EnterpriseAlert inline="true" />
This document covers configuration and limitations of Vault's PKI Secrets Engine This document covers configuration and limitations of Vault's PKI Secrets Engine
implementation of the [EST protocol](https://datatracker.ietf.org/doc/html/rfc7030) <EnterpriseAlert inline="true" />. implementation of the [EST protocol](https://datatracker.ietf.org/doc/html/rfc7030) <EnterpriseAlert inline="true" />.

14
website/content/docs/secrets/pki/index.mdx
View File

@@ -1,14 +1,22 @@
--- ---
layout: docs layout: docs
page_title: PKI - Secrets Engines page_title: PKI secrets engine
description: The PKI secrets engine for Vault generates TLS certificates. description: Dynamically generate X.509 certificates with the PKI secrets engine plugin.
--- ---
# PKI secrets engine # PKI secrets engine
@include 'x509-sha1-deprecation.mdx' @include 'x509-sha1-deprecation.mdx'
-> **Vault as Consul CA provider:** If you are using Vault 1.11.0+ as a Connect CA, run a Consul version which includes the fix for [GH-15525](https://github.com/hashicorp/consul/pull/15525). Refer to this [Knowledge Base article](https://support.hashicorp.com/hc/en-us/articles/11308460105491) for more details. <Note title="Vault as Consul CA provider">
If you are using Vault 1.11.0+ as a Connect CA, run a Consul version which
includes the fix for [GH-15525](https://github.com/hashicorp/consul/pull/15525).
Refer to this [Knowledge Base
article](https://support.hashicorp.com/hc/en-us/articles/11308460105491) for
more details.
</Note>
The PKI secrets engine generates dynamic X.509 certificates. With this secrets The PKI secrets engine generates dynamic X.509 certificates. With this secrets
engine, services can get certificates without going through the usual manual engine, services can get certificates without going through the usual manual

7
website/content/docs/secrets/pki/quick-start-intermediate-ca.mdx
View File

@@ -1,10 +1,11 @@
--- ---
layout: docs layout: docs
page_title: 'PKI - Secrets Engines: Quick Start: Intermediate CA Setup' page_title: 'Quick start: intermediate CA setup'
description: The PKI secrets engine for Vault generates TLS certificates. description: >-
Set up a PKI secrets engine to create an intermediate authority using the root authority to sign the intermediate's certificate.
--- ---
# PKI secrets engine - quick start - intermediate CA setup # Quick start: intermediate CA setup
In the [first Quick Start guide](/vault/docs/secrets/pki/quick-start-root-ca), In the [first Quick Start guide](/vault/docs/secrets/pki/quick-start-root-ca),
certificates were issued directly from the root certificate authority. certificates were issued directly from the root certificate authority.

7
website/content/docs/secrets/pki/quick-start-root-ca.mdx
View File

@@ -1,10 +1,11 @@
--- ---
layout: docs layout: docs
page_title: 'PKI - Secrets Engines: Quick Start: Root CA Setup' page_title: 'Quick start: root CA setup'
description: The PKI secrets engine for Vault generates TLS certificates. description: >-
Set up a PKI secrets engine with a root CA certificate.
--- ---
# PKI secrets engine - quick start - root CA setup # Quick start: root CA setup
This document provides a brief overview of setting up a Vault PKI Secrets This document provides a brief overview of setting up a Vault PKI Secrets
Engine with a Root CA certificate. Engine with a Root CA certificate.

5
website/content/docs/secrets/pki/rotation-primitives.mdx
View File

@@ -1,7 +1,8 @@
--- ---
layout: docs layout: docs
page_title: 'PKI - Secrets Engine: Rotation Primitives' page_title: 'PKI secrets engine - rotation primitives'
description: The PKI secrets engine for Vault generates TLS certificates. description: >-
Understand the primitive certificate types for root and intermediate CA rotation.
--- ---
# PKI secrets engine - rotation primitives # PKI secrets engine - rotation primitives

7
website/content/docs/secrets/pki/setup.mdx
View File

@@ -1,10 +1,11 @@
--- ---
layout: docs layout: docs
page_title: 'PKI - Secrets Engines: Setup and Usage' page_title: Set up and use the PKI secrets engine
description: The PKI secrets engine for Vault generates TLS certificates. description: >-
Enable and configure the PKI secrets engine to generates TLS certificates.
--- ---
# PKI secrets engine - setup and usage # Set up and use the PKI secrets engine
This document provides a brief overview of the setup and usage of the PKI This document provides a brief overview of the setup and usage of the PKI
Secrets Engine. Secrets Engine.

6
website/content/docs/secrets/pki/troubleshooting-acme.mdx
View File

@@ -1,10 +1,10 @@
--- ---
layout: docs layout: docs
page_title: 'PKI - Secrets Engine: Troubleshooting ACME' page_title: Troubleshoot PKI secrets engine and ACME
description: Troubleshoot problems with ACME clients and Vault PKI Secrets Engine's ACME server. description: Troubleshoot problems with ACME clients and Vault PKI secrets engine's ACME server.
--- ---
# Troubleshoot PKI Secrets Engine and ACME # Troubleshoot PKI secrets engine and ACME
Solve common problems related to ACME client integration with Vault PKI Solve common problems related to ACME client integration with Vault PKI
Secrets Engine's ACME server. Secrets Engine's ACME server.

14
website/content/partials/x509-sha1-deprecation.mdx
View File

@@ -1,5 +1,9 @@
~> **Note**: This engine can use external X.509 certificates as part of TLS or signature validation. <Note>
Verifying signatures against X.509 certificates that use SHA-1 is deprecated and is no longer
usable without a workaround starting in Vault 1.12. See the This engine can use external X.509 certificates as part of TLS or signature validation.
[deprecation FAQ](/vault/docs/deprecation/faq#q-what-is-the-impact-of-removing-support-for-x-509-certificates-with-signatures-that-use-sha-1) Verifying signatures against X.509 certificates that use SHA-1 is deprecated and is no longer
for more information. usable without a workaround starting in Vault 1.12. See the
[deprecation FAQ](/vault/docs/deprecation/faq#q-what-is-the-impact-of-removing-support-for-x-509-certificates-with-signatures-that-use-sha-1)
for more information.
</Note>