Skip to content

Commit

Permalink
Backport of Vault documentation: updated docs to include a note about…
Browse files Browse the repository at this point in the history
… seal requirement into release/1.10.x (#15189)

* backport of commit d7928f8

* backport of commit b398d4f

* backport of commit d02d88e

* backport of commit 68ca140

* backport of commit 1708cc6

Co-authored-by: taoism4504 <[email protected]>
Co-authored-by: Loann Le <[email protected]>
  • Loading branch information
3 people authored Apr 26, 2022
1 parent e034d5f commit 9432586
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 0 deletions.
2 changes: 2 additions & 0 deletions website/content/docs/concepts/seal.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,8 @@ access to the root key shards.

## Auto Unseal

-> **Note:** The Seal Wrap functionality is enabled by default. For this reason, the seal provider (HSM or cloud KMS) must be available throughout Vault's runtime and not just during the unseal process. Refer to the [Seal Wrap](/docs/enterprise/sealwrap) documenation for more information.

Auto Unseal was developed to aid in reducing the operational complexity of
keeping the unseal key secure. This feature delegates the responsibility of
securing the unseal key from users to a trusted device or service. At startup
Expand Down
3 changes: 3 additions & 0 deletions website/content/docs/configuration/seal/alicloudkms.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ description: >-

# `alicloudkms` Seal

-> **Note:** The Seal Wrap functionality is enabled by default. For this reason, the KMS service must be available throughout Vault's runtime and not just during the unseal process. Refer to the [Seal Wrap](/docs/enterprise/sealwrap) documenation for more information.


The AliCloud KMS seal configures Vault to use AliCloud KMS as the seal wrapping mechanism.
The AliCloud KMS seal is activated by one of the following:

Expand Down
2 changes: 2 additions & 0 deletions website/content/docs/configuration/seal/awskms.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ description: |-

# `awskms` Seal

-> **Note:** The Seal Wrap functionality is enabled by default. For this reason, the KMS service must be available throughout Vault's runtime and not just during the unseal process. Refer to the [Seal Wrap](/docs/enterprise/sealwrap) documenation for more information.

The AWS KMS seal configures Vault to use AWS KMS as the seal wrapping mechanism.
The AWS KMS seal is activated by one of the following:

Expand Down
2 changes: 2 additions & 0 deletions website/content/docs/configuration/seal/azurekeyvault.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ description: >-

# `azurekeyvault` Seal

-> **Note:** The Seal Wrap functionality is enabled by default. For this reason, the KMS service must be available throughout Vault's runtime and not just during the unseal process. Refer to the [Seal Wrap](/docs/enterprise/sealwrap) documenation for more information.

The Azure Key Vault seal configures Vault to use Azure Key Vault as the seal
wrapping mechanism. The Azure Key Vault seal is activated by one of the following:

Expand Down
2 changes: 2 additions & 0 deletions website/content/docs/configuration/seal/gcpckms.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ description: >-

# `gcpckms` Seal

-> **Note:** The Seal Wrap functionality is enabled by default. For this reason, the KMS service must be available throughout Vault's runtime and not just during the unseal process. Refer to the [Seal Wrap](/docs/enterprise/sealwrap) documenation for more information.

The GCP Cloud KMS seal configures Vault to use GCP Cloud KMS as the seal
wrapping mechanism. The GCP Cloud KMS seal is activated by one of the following:

Expand Down
2 changes: 2 additions & 0 deletions website/content/docs/configuration/seal/ocikms.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ description: |-

# `ocikms` Seal

-> **Note:** The Seal Wrap functionality is enabled by default. For this reason, the KMS service must be available throughout Vault's runtime and not just during the unseal process. Refer to the [Seal Wrap](/docs/enterprise/sealwrap) documenation for more information.

The OCI KMS seal configures Vault to use OCI KMS as the seal wrapping mechanism.
The OCI KMS seal is activated by one of the following:

Expand Down
2 changes: 2 additions & 0 deletions website/content/docs/configuration/seal/pkcs11.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ description: |-

# `pkcs11` Seal

-> **Note:** The Seal Wrap functionality is enabled by default. For this reason, HSM must be available throughout Vault's runtime and not just during the unseal process. Refer to the [Seal Wrap](/docs/enterprise/sealwrap) documenation for more information.

The PKCS11 seal configures Vault to use an HSM with PKCS11 as the seal wrapping
mechanism. Vault Enterprise's HSM PKCS11 support is activated by one of the
following:
Expand Down

0 comments on commit 9432586

Please sign in to comment.