Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[v16] docs: update hsm/kms and machine-id #46921

Merged
merged 4 commits into from
Sep 25, 2024
Merged

[v16] docs: update hsm/kms and machine-id #46921

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1169eb7
docs: update hsm/kms and machine-id
Sep 25, 2024
f0b785a
docs: update verbiage on hsm warning
Sep 25, 2024
9e4175c
docs: spelling fix
Sep 25, 2024
205e9ed
docs: lint fix
Sep 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/pages/admin-guides/deploy-a-cluster/aws-kms.mdx
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
2 changes: 1 addition & 1 deletion docs/pages/enroll-resources/machine-id/deployment/github-actions.mdx
View file
Open in desktop
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
View file
Open in desktop
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

Check failure on line 2 in docs/pages/includes/enterprise/hsm-warning.mdx

View workflow job for this annotation

GitHub Actions / Lint docs prose style 

[vale] reported by reviewdog 🐶
[messaging.edition-names] "Teleport Cloud" is no longer a recognized Teleport edition. Use "Teleport Enterprise" instead, and clarify the hosting type in parentheses rather than including it in the name of the product, e.g., "Teleport Enterprise (self-hosted)" or "Teleport Enterprise (cloud-hosted)".

Raw Output:
{"message": "[messaging.edition-names] \"Teleport Cloud\" is no longer a recognized Teleport edition. Use \"Teleport Enterprise\" instead, and clarify the hosting type in parentheses rather than including it in the name of the product, e.g., \"Teleport Enterprise (self-hosted)\" or \"Teleport Enterprise (cloud-hosted)\".", "location": {"path": "docs/pages/includes/enterprise/hsm-warning.mdx", "range": {"start": {"line": 2, "column": 1}}}, "severity": "ERROR"}

Check failure on line 2 in docs/pages/includes/enterprise/hsm-warning.mdx

View workflow job for this annotation

GitHub Actions / Lint docs prose style 

[vale] reported by reviewdog 🐶
[messaging.consistent-terms] For consistent product messaging in the docs, use 'Teleport Community Edition' instead of 'Teleport Open Source'.

Raw Output:
{"message": "[messaging.consistent-terms] For consistent product messaging in the docs, use 'Teleport Community Edition' instead of 'Teleport Open Source'.", "location": {"path": "docs/pages/includes/enterprise/hsm-warning.mdx", "range": {"start": {"line": 2, "column": 20}}}, "severity": "ERROR"}
Key Management Services.

</Admonition>
Loading