Skip to content

Commit 32ba53f

Browse files
yhyakunajonathanfrappier
yhyakuna
and
jonathanfrappier
authored
[DOCS] Update the PKI secrets engine docs title & description (#29136)
* Update the PKI secrets engine docs title & description * Update website/content/docs/secrets/pki/index.mdx Co-authored-by: Jonathan Frappier <[email protected]> * Incorporate the review feedback --------- Co-authored-by: Jonathan Frappier <[email protected]>
1 parent f975259 commit 32ba53f

11 files changed

+52
-33
lines changed

‎website/content/docs/secrets/pki/cieps.mdx

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
22
layout: docs
3-
page_title: Certificate Issuance External Policy (CIEPS) | PKI - Secrets Engines
4-
description: An overview of the Certificate Issuance External Policy (CIEPS) protocol
3+
page_title: Certificate Issuance External Policy Service (CIEPS)
4+
description: >-
5+
High-level architecture overview and service APIs used by the PKI secrets engine when communicating with the Certificate Issuance External Policy Service (CIEPS).
56
---
67

7-
# PKI secrets engine - Certificate Issuance External Policy Service (CIEPS) <EnterpriseAlert inline="true" />
8+
# Certificate Issuance External Policy Service (CIEPS) <EnterpriseAlert inline="true" />
89

910
This document covers high-level architecture and service APIs used by the
1011
Vault PKI Secrets Engine when communicating with the Certificate Issuance

‎website/content/docs/secrets/pki/cmpv2.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
layout: docs
3-
page_title: Certificate Management Protocol v2 (CMPv2) within Vault | PKI - Secrets Engines
3+
page_title: Certificate Management Protocol v2 (CMPv2)
44
description: An overview of the Certificate Management Protocol (v2) implementation within Vault.
55
---
66

7-
# PKI secrets engine - Certificate Management Protocol v2 (CMPv2) <EnterpriseAlert inline="true" />
7+
# Certificate Management Protocol v2 (CMPv2) <EnterpriseAlert inline="true" />
88

99
This document summarizes Vault's PKI Secrets Engine
1010
implementation of the [CMPv2 protocol](https://datatracker.ietf.org/doc/html/rfc4210) <EnterpriseAlert inline="true" />,

‎website/content/docs/secrets/pki/considerations.mdx

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
22
layout: docs
3-
page_title: 'PKI - Secrets Engines: Considerations'
4-
description: The PKI secrets engine for Vault generates TLS certificates.
3+
page_title: 'PKI secrets engine considerations'
4+
description: >-
5+
Understand the important considerations and guidance before using the PKI secrets engine to generate certificates before using the PKI secrets engine.
56
---
67

7-
# PKI secrets engine - considerations
8+
# PKI secrets engine considerations
89

910
To successfully deploy this secrets engine, there are a number of important
1011
considerations to be aware of, as well as some preparatory steps that should be

‎website/content/docs/secrets/pki/est.mdx

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
22
layout: docs
3-
page_title: Enrollment over Secure Transport (EST) within Vault | PKI - Secrets Engines
4-
description: An overview of the Enrollment over Secure Transport protocol implementation within Vault.
3+
page_title: Enrollment over Secure Transport (EST)
4+
description: >-
5+
Understand the configuration and limitations of Vault's PKI secrets engine implementation of the Enrollment over Secure Transport (EST) protocol.
56
---
67

7-
# PKI secrets engine - Enrollment over Secure Transport (EST) <EnterpriseAlert inline="true" />
8+
# Enrollment over Secure Transport (EST) <EnterpriseAlert inline="true" />
89

910
This document covers configuration and limitations of Vault's PKI Secrets Engine
1011
implementation of the [EST protocol](https://datatracker.ietf.org/doc/html/rfc7030) <EnterpriseAlert inline="true" />.

‎website/content/docs/secrets/pki/index.mdx

+11-3
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,22 @@
11
---
22
layout: docs
3-
page_title: PKI - Secrets Engines
4-
description: The PKI secrets engine for Vault generates TLS certificates.
3+
page_title: PKI secrets engine
4+
description: Dynamically generate X.509 certificates with the PKI secrets engine plugin.
55
---
66

77
# PKI secrets engine
88

99
@include 'x509-sha1-deprecation.mdx'
1010

11-
-> **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.
11+
<Note title="Vault as Consul CA provider">
12+
13+
If you are using Vault 1.11.0+ as a Connect CA, run a Consul version which
14+
includes the fix for [GH-15525](https://github.com/hashicorp/consul/pull/15525).
15+
Refer to this [Knowledge Base
16+
article](https://support.hashicorp.com/hc/en-us/articles/11308460105491) for
17+
more details.
18+
19+
</Note>
1220

1321
The PKI secrets engine generates dynamic X.509 certificates. With this secrets
1422
engine, services can get certificates without going through the usual manual

‎website/content/docs/secrets/pki/quick-start-intermediate-ca.mdx

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
22
layout: docs
3-
page_title: 'PKI - Secrets Engines: Quick Start: Intermediate CA Setup'
4-
description: The PKI secrets engine for Vault generates TLS certificates.
3+
page_title: 'Quick start: intermediate CA setup'
4+
description: >-
5+
Set up a PKI secrets engine to create an intermediate authority using the root authority to sign the intermediate's certificate.
56
---
67

7-
# PKI secrets engine - quick start - intermediate CA setup
8+
# Quick start: intermediate CA setup
89

910
In the [first Quick Start guide](/vault/docs/secrets/pki/quick-start-root-ca),
1011
certificates were issued directly from the root certificate authority.

‎website/content/docs/secrets/pki/quick-start-root-ca.mdx

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
22
layout: docs
3-
page_title: 'PKI - Secrets Engines: Quick Start: Root CA Setup'
4-
description: The PKI secrets engine for Vault generates TLS certificates.
3+
page_title: 'Quick start: root CA setup'
4+
description: >-
5+
Set up a PKI secrets engine with a root CA certificate.
56
---
67

7-
# PKI secrets engine - quick start - root CA setup
8+
# Quick start: root CA setup
89

910
This document provides a brief overview of setting up a Vault PKI Secrets
1011
Engine with a Root CA certificate.

‎website/content/docs/secrets/pki/rotation-primitives.mdx

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
22
layout: docs
3-
page_title: 'PKI - Secrets Engine: Rotation Primitives'
4-
description: The PKI secrets engine for Vault generates TLS certificates.
3+
page_title: 'PKI secrets engine - rotation primitives'
4+
description: >-
5+
Understand the primitive certificate types for root and intermediate CA rotation.
56
---
67

78
# PKI secrets engine - rotation primitives

‎website/content/docs/secrets/pki/setup.mdx

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
22
layout: docs
3-
page_title: 'PKI - Secrets Engines: Setup and Usage'
4-
description: The PKI secrets engine for Vault generates TLS certificates.
3+
page_title: Set up and use the PKI secrets engine
4+
description: >-
5+
Enable and configure the PKI secrets engine to generates TLS certificates.
56
---
67

7-
# PKI secrets engine - setup and usage
8+
# Set up and use the PKI secrets engine
89

910
This document provides a brief overview of the setup and usage of the PKI
1011
Secrets Engine.

‎website/content/docs/secrets/pki/troubleshooting-acme.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
layout: docs
3-
page_title: 'PKI - Secrets Engine: Troubleshooting ACME'
4-
description: Troubleshoot problems with ACME clients and Vault PKI Secrets Engine's ACME server.
3+
page_title: Troubleshoot PKI secrets engine and ACME
4+
description: Troubleshoot problems with ACME clients and Vault PKI secrets engine's ACME server.
55
---
66

7-
# Troubleshoot PKI Secrets Engine and ACME
7+
# Troubleshoot PKI secrets engine and ACME
88

99
Solve common problems related to ACME client integration with Vault PKI
1010
Secrets Engine's ACME server.

‎website/content/partials/x509-sha1-deprecation.mdx

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

0 commit comments

Comments
 (0)