Skip to content

Commit

Permalink
docs: update hsm/kms and machine-id (#46906)
Browse files Browse the repository at this point in the history
* docs: update hsm/kms and machine-id

* docs: update verbiage on hsm warning

* docs: spelling fix

* docs: lint fix

---------

Co-authored-by: Steven Martin <stevenmartin@Stevens-MacBook-Pro.local>
  • Loading branch information
stevenGravy and Steven Martin authored Sep 25, 2024
1 parent 724c9e7 commit 9348fa5
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 14 deletions.
6 changes: 3 additions & 3 deletions docs/pages/admin-guides/deploy-a-cluster/aws-kms.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@ learn more.
The features documented on this page are available in Teleport `15.0.0` and
higher.

(!docs/pages/includes/commercial-prereqs-tabs.mdx!)

- Teleport v(=teleport.version=) Enterprise (self-hosted).
- (!docs/pages/includes/tctl.mdx!)

- An AWS account.

(!docs/pages/includes/enterprise/hsm-warning.mdx!)

## Step 1/3. Configure AWS IAM permissions

Your Teleport Auth Service will need permissions to create, sign with, list,
Expand Down
9 changes: 3 additions & 6 deletions docs/pages/admin-guides/deploy-a-cluster/gcp-kms.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,12 @@ learn more.

## Prerequisites

The features documented on this page are available in Teleport `11.1.0` and
higher.

(!docs/pages/includes/commercial-prereqs-tabs.mdx!)

- Teleport v(=teleport.version=) Enterprise (self-hosted).
- (!docs/pages/includes/tctl.mdx!)

- A Google Cloud account.

(!docs/pages/includes/enterprise/hsm-warning.mdx!)

## Step 1/5. Create a key ring in GCP

Each Teleport Auth Server will need to be configured to use a GCP key ring
Expand Down
5 changes: 1 addition & 4 deletions docs/pages/admin-guides/deploy-a-cluster/hsm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,7 @@ hardware security module (HSM) to store and handle private keys.
- An HSM reachable from your Teleport auth server.
- The PKCS#11 module for your HSM.

<Admonition type="warning" scope={["cloud", "oss"]} opened={true} scopeOnly={true} title="Compatibility Warning">
Teleport Cloud and Teleport Open Source do not currently support HSM.

</Admonition>
(!docs/pages/includes/enterprise/hsm-warning.mdx!)

While most PKCS#11 HSMs should be supported, the Teleport team tests with AWS
CloudHSM, YubiHSM2, and SoftHSM2.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ to more accurately describe your use-case.
<Admonition type="note" title="Using GitHub Enterprise?">
**Enterprise Server**

From Teleport 11.1.4, users with Teleport Enterprise are able to permit
If you are using self-hosted Teleport Enterprise you are able to permit
workflows within GitHub Enterprise Server instances to authenticate using the
GitHub join method.

Expand Down
5 changes: 5 additions & 0 deletions docs/pages/includes/enterprise/hsm-warning.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<Admonition type="warning" opened={true} scopeOnly={true} title="Compatibility Warning">
Teleport Cloud and Teleport Open Source do not currently support HSMs or
Key Management Services.

</Admonition>

0 comments on commit 9348fa5

Please sign in to comment.