From cd1b42bd1b1adace24f5e5b75614fc157654ca15 Mon Sep 17 00:00:00 2001 From: Paul Gottschling Date: Thu, 14 Apr 2022 14:46:07 -0400 Subject: [PATCH] Fix wording and linter issues following PR review --- docs/pages/setup/admin.mdx | 6 +++--- docs/pages/setup/admin/adding-nodes.mdx | 6 +++--- docs/pages/setup/deployments/aws-terraform.mdx | 4 ++-- docs/pages/setup/operations.mdx | 2 +- docs/pages/setup/operations/ca-rotation.mdx | 2 +- 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/pages/setup/admin.mdx b/docs/pages/setup/admin.mdx index ee21f428796f2..d6ce320f7cfdc 100644 --- a/docs/pages/setup/admin.mdx +++ b/docs/pages/setup/admin.mdx @@ -8,8 +8,8 @@ The guides in this section show you the fundamentals of setting up and running a Teleport cluster. You will learn how to run the `teleport` daemon, manage users and resources, and troubleshoot any issues that arise. -If you already understand how to set up a Teleport cluster, you should consult -the [Operations](./operations.mdx) section so you can start conducting periodic +If you already understand how to set up a Teleport cluster, consult the +[Operations](./operations.mdx) section so you can start conducting periodic cluster maintenance tasks. ## Run Teleport @@ -30,7 +30,7 @@ cluster maintenance tasks. Set up single sign-on with GitHub. - How to add Nodes to your Teleport cluster. + Add Nodes to your Teleport cluster. Connect multiple Teleport clusters using Trusted Clusters. diff --git a/docs/pages/setup/admin/adding-nodes.mdx b/docs/pages/setup/admin/adding-nodes.mdx index c028f3a04b56f..248fe518e343a 100644 --- a/docs/pages/setup/admin/adding-nodes.mdx +++ b/docs/pages/setup/admin/adding-nodes.mdx @@ -114,11 +114,11 @@ auth_service: ### Start your Node with the invite token and CA pin -The CA pin at the needs to be passed to new Nodes when they're -starting for the first time, i.e. when they join a cluster. +A CA pin needs to be passed to new Nodes when they're starting for the first +time, i.e. when they join a cluster. If a CA pin is not provided, the Teleport Node will join a cluster but it will -print a `WARN` message (warning). +print a warning message. diff --git a/docs/pages/setup/deployments/aws-terraform.mdx b/docs/pages/setup/deployments/aws-terraform.mdx index 0ea0b61eb9396..5512c50cd2237 100644 --- a/docs/pages/setup/deployments/aws-terraform.mdx +++ b/docs/pages/setup/deployments/aws-terraform.mdx @@ -714,7 +714,7 @@ To add new nodes/EC2 servers that you can "SSH into" you'll need to: - [Install the Teleport binary on the Server](../../installation.mdx) - [Run Teleport - we recommend using systemd](../admin/daemon.mdx#systemd-unit-file) - [Set the correct settings in /etc/teleport.yaml](../reference/config.mdx) -- [Add nodes to the Teleport cluster](../admin/adding-nodes.mdx#adding-nodes-to-the-cluster) +- [Add Nodes to the Teleport cluster](../admin/adding-nodes.mdx) ### Getting the CA pin hash @@ -736,7 +736,7 @@ $ aws ssm get-parameter --region ${TF_VAR_region} --name "/teleport/${TF_VAR_clu # 992a9725-0a64-428d-8e5e-308e6877743d ``` -You can also generate a node join token using `tctl tokens add --type=node` [as detailed here in our admin guide](../admin/adding-nodes.mdx#adding-nodes-to-the-cluster). +You can also generate a Node join token using `tctl tokens add --type=node` [as detailed here in our admin guide](../admin/adding-nodes.mdx). ### Joining nodes via the Teleport auth server diff --git a/docs/pages/setup/operations.mdx b/docs/pages/setup/operations.mdx index 67c0f0cf1ad31..98ba32ce96a7c 100644 --- a/docs/pages/setup/operations.mdx +++ b/docs/pages/setup/operations.mdx @@ -21,7 +21,7 @@ the [Cluster Administration Guides](./admin.mdx) section. Backing up and restoring the cluster. - Rotating certificates and certificate authorities. + Rotating Teleport certificate authorities. Migrating your Teleport cluster to single-port TLS routing mode. diff --git a/docs/pages/setup/operations/ca-rotation.mdx b/docs/pages/setup/operations/ca-rotation.mdx index 749237cbb4908..0d4a6193623ea 100644 --- a/docs/pages/setup/operations/ca-rotation.mdx +++ b/docs/pages/setup/operations/ca-rotation.mdx @@ -13,7 +13,7 @@ description: How to rotate Teleport's certificate authority This section will show you how to implement certificate rotation in practice. -If you are using [CA Pinning](../admin/adding-nodes.mdx#untrusted-auth-servers) +If you are using [CA Pinning](../admin/adding-nodes.mdx#obtain-a-ca-pin) when adding new nodes, the CA pin will change after the rotation. Make sure you use the *new* CA pin when adding nodes after rotation.