Skip to content

Commit 32f5be4

Browse files
committed
Fix Vale issues in 36 docs guides
This includes removing the `teleport-cluster` migration guide, which includes some Vale issues. This was an overdue TODO item.
1 parent 8ea5516 commit 32f5be4

38 files changed

+118
-343
lines changed

docs/pages/admin-guides/access-controls/access-lists/access-lists.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ layout: tocless-doc
55
---
66

77
Access Lists allow Teleport users to be granted long term access to resources
8-
managed within Teleport. With Access Lists, administrators and access list
8+
managed within Teleport. With Access Lists, administrators and Access List
99
owners can regularly audit and control membership to specific roles and
1010
traits, which then tie easily back into Teleport's existing RBAC system.
1111

docs/pages/admin-guides/access-controls/access-lists/guide.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Learn how to use Access Lists to manage and audit long lived access
44
---
55

66
This guide will help you:
7-
- Create an access list
7+
- Create an Access List
88
- Assign a member to it
99
- Verify permissions granted through the list membership
1010

@@ -47,7 +47,7 @@ Try logging into the cluster with the test user to verify that no resources show
4747

4848
## Step 3/4. Create an Access List
4949

50-
Next, we'll create a simple access list that will grant the `access` role to its members.
50+
Next, we'll create a simple Access List that will grant the `access` role to its members.
5151
Login as the administrative user mentioned in the prerequisites. Click on "Add New" in the left pane, and then "Create an Access List."
5252

5353
![Navigate to create new Access List](../../../../img/access-controls/access-lists/create-new-access-list.png)
@@ -64,10 +64,10 @@ not be able to manage the list, though they will still be reflected as an owner.
6464

6565
![Select an owner](../../../../img/access-controls/access-lists/select-owner.png)
6666

67-
Under "Members" select `requester` as a required role, then add your test user to the access list. Similar to
67+
Under "Members" select `requester` as a required role, then add your test user to the Access List. Similar to
6868
the owner requirements, this will ensure that any member of the list must have the `requester` role in order to
6969
be granted the access described in this list. If the user loses this role later, they will not be granted the
70-
roles or traits described in the access list.
70+
roles or traits described in the Access List.
7171

7272
![Add a member](../../../../img/access-controls/access-lists/add-member.png)
7373

docs/pages/admin-guides/access-controls/access-request-plugins/ssh-approval-msteams.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Once enrolled you can download the required `app.zip` file from the integrations
3535
- An Azure resource group in the same directory. This will host resources for
3636
the Microsoft Teams Access Request plugin. You should have enough
3737
permissions to create and edit Azure Bot Services in this resource group.
38-
- Someone with Global Admin rights on the Azure Active Directory that will grant
38+
- Someone with Global Admin rights on Microsoft Entra ID in order to grant
3939
permissions to the plugin.
4040
- Someone with the `Teams administrator` role that can approve installation
4141
requests for Microsoft Teams Apps.

docs/pages/admin-guides/access-controls/access-requests/oss-role-requests.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,4 +156,4 @@ $ tctl request approve \
156156
- Learn more about [Access Requests](access-requests.mdx)
157157
- See what additional features are available for
158158
[role requests](./role-requests.mdx) in Teleport Enterprise
159-
- Request access to [specific resources](./resource-requests.mdx) with Teleport Enterprise
159+
- Request access to [specific resources](./resource-requests.mdx) with Teleport Enterprise

docs/pages/admin-guides/access-controls/device-trust/enforcing-device-trust.mdx

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,10 @@ by the `device_trust_mode` authentication setting:
3535

3636
(!docs/pages/includes/device-trust/prereqs.mdx!)
3737

38-
- We expect your Teleport cluster to be on version 13.3.6 and above, which has
39-
the preset `require-trusted-device` role. The preset `require-trusted-device`
40-
role does not enforce the use of a trusted device for
41-
[Apps](#app-access-support) or [Desktops](#desktop-access-support). Refer to
42-
their corresponding sections for instructions.
38+
This guide makes use of the preset `require-trusted-device` role, which does not
39+
enforce the use of a trusted device for [Apps](#app-access-support) or
40+
[Desktops](#desktop-access-support). Refer to their corresponding sections for
41+
instructions.
4342

4443
## Role-based trusted device enforcement
4544

@@ -111,7 +110,7 @@ metadata:
111110
name: cluster-auth-preference
112111
spec:
113112
type: local
114-
second_factor: "on"
113+
second_factors: ["webauthn"]
115114
webauthn:
116115
rp_id: (=clusterDefaults.clusterName=)
117116
device_trust:

docs/pages/admin-guides/access-controls/guides/hardware-key-support.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ Make sure that the touch and PIN policy satisfy the hardware key requirement for
255255

256256
### `ERROR: private key policy not met`
257257

258-
This error is returned by the Auth and Proxy services if a user does not meet the required private key policy.
258+
This error is returned by the Auth Service and Proxy Service if a user does not meet the required private key policy.
259259
Both `tsh` and Teleport Connect automatically catch these errors and require the user to sign in again with a valid hardware-based private key.
260260

261261
### `ERROR: authenticating with management key: auth challenge: smart card error 6982: security status not satisfied`

docs/pages/admin-guides/access-controls/guides/headless.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ For example:
2626
## Prerequisites
2727

2828
- A Teleport cluster with WebAuthn configured.
29-
See the [Second Factor: WebAuthn](./webauthn.mdx) guide.
29+
See the [Harden your Cluster Against IdP Compromises](./webauthn.mdx) guide.
3030
- WebAuthn hardware device, such as YubiKey.
3131
- Machines for Headless WebAuthn activities have [Linux](../../../installation.mdx), [macOS](../../../installation.mdx) or [Windows](../../../installation.mdx) `tsh` binary installed.
3232
- Machines used to approve Headless WebAuthn requests have a Web browser with [WebAuthn support](

docs/pages/admin-guides/access-controls/guides/locking.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Session and Identity Locking
33
description: How to lock compromised users or agents
44
---
55

6-
System administrators can disable a compromised user or Teleport agent—or
6+
System administrators can disable a compromised user or Teleport Agent—or
77
prevent access during cluster maintenance—by placing a lock
88
on a session, user or host identity.
99

@@ -19,7 +19,7 @@ A lock can target the following objects or attributes:
1919
../device-trust/enforcing-device-trust.mdx#locking-a-device) by the device ID
2020
- an MFA device by the device's UUID
2121
- an OS/UNIX login
22-
- a Teleport agent by the agent's server UUID (effectively unregistering it from the
22+
- a Teleport Agent by the Agent's server UUID (effectively unregistering it from the
2323
cluster)
2424
- a Windows desktop by the desktop's name
2525
- an [Access Request](../access-requests/access-requests.mdx) by UUID

docs/pages/admin-guides/access-controls/guides/mfa-for-admin-actions.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Examples of administrative actions include, but are not limited to:
1313
- Inviting new users
1414
- Updating cluster configuration resources
1515
- Modifying access management resources
16-
- Approving access requests
16+
- Approving Access Requests
1717
- Generating new join tokens
1818
- Impersonation
1919
- Creating new bots for Machine ID
@@ -41,15 +41,15 @@ their on-disk Teleport certificates.
4141

4242
- (!docs/pages/includes/tctl.mdx!)
4343
- [WebAuthn configured](webauthn.mdx) on this cluster
44-
- Second factor hardware device, such as YubiKey or SoloKey
44+
- Multi-factor authentication hardware device, such as YubiKey or SoloKey
4545
- A Web browser with [WebAuthn support](
4646
https://developers.yubico.com/WebAuthn/WebAuthn_Browser_Support/) (if using
4747
SSH or desktop sessions from the Teleport Web UI).
4848

4949
## Require MFA for administrative actions
5050

5151
MFA for administrative actions is automatically enforced for clusters where
52-
WebAuthn is the only form of second factor allowed.
52+
WebAuthn is the only form of multi-factor authentication allowed.
5353

5454
<Notice type="note">
5555
In a future major version, Teleport may enforce MFA for administrative actions

docs/pages/admin-guides/access-controls/guides/passwordless.mdx

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,18 @@ usernameless authentication for Teleport.
1111

1212
(!docs/pages/includes/edition-prereqs-tabs.mdx!)
1313

14-
- Teleport must be configured for WebAuthn. See the [Second Factor:
15-
WebAuthn](./webauthn.mdx) guide.
16-
- A hardware device with support for WebAuthn and resident keys.
17-
As an alternative, you can use a Mac with biometrics / Touch ID or device that
14+
- Teleport must be configured for WebAuthn. See the [Harden your Cluster Against
15+
IdP Compromises ](./webauthn.mdx) guide.
16+
- A hardware device with support for WebAuthn and resident keys. As an
17+
alternative, you can use a Mac with biometrics / Touch ID or device that
1818
supports Windows Hello (Windows 10 19H1 or later).
19-
- A web browser with WebAuthn support. To see if your browser supports
20-
WebAuthn, check the [WebAuthn
21-
Compatibility](https://developers.yubico.com/WebAuthn/WebAuthn_Browser_Support/) page.
22-
- A signed and notarized version of `tsh` is required for Touch ID. This means versions
23-
installed from Homebrew or compiled from source will not work. [Download the macOS tsh installer](../../../installation.mdx#macos).
19+
- A web browser with WebAuthn support. To see if your browser supports WebAuthn,
20+
check the [WebAuthn
21+
Compatibility](https://developers.yubico.com/WebAuthn/WebAuthn_Browser_Support/)
22+
page.
23+
- A signed and notarized version of `tsh` is required for Touch ID. This means
24+
versions installed from Homebrew or compiled from source will not work.
25+
[Download the macOS tsh installer](../../../installation.mdx#macos).
2426
- (!docs/pages/includes/tctl.mdx!)
2527

2628
A Teleport cluster capable of WebAuthn is automatically capable of passwordless.
@@ -46,8 +48,8 @@ If you are using a hardware device, a passwordless registration will occupy a
4648
resident key slot. Resident keys, also called discoverable credentials, are
4749
stored in persistent memory in the authenticator (i.e., the device that is used
4850
to authenticate). In contrast, MFA keys are encrypted by the authenticator and
49-
stored in the Teleport Auth Server. Regardless of your device type, passwordless
50-
registrations may also be used for regular MFA.
51+
stored in the Teleport Auth Service backend. Regardless of your device type,
52+
passwordless registrations may also be used for regular MFA.
5153

5254
<Admonition type="tip" title="Important">
5355
If you plan on relying exclusively on passwordless, it's recommended to register

docs/pages/admin-guides/access-controls/guides/per-session-mfa.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ their on-disk Teleport certificates.
2929

3030
- (!docs/pages/includes/tctl.mdx!)
3131
- [WebAuthn configured](webauthn.mdx) on this cluster
32-
- Second factor hardware device, such as YubiKey or SoloKey
32+
- Hardware device for multi-factor authentication, such as YubiKey or SoloKey
3333
- A Web browser with [WebAuthn support](
3434
https://developers.yubico.com/WebAuthn/WebAuthn_Browser_Support/) (if using
3535
SSH or desktop sessions from the Teleport Web UI).

docs/pages/admin-guides/access-controls/idps/saml-gcp-workforce-identity-federation.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ resource ID for workforce pool and workforce pool provider, respectively.
7979
</Admonition>
8080

8181

82-
## Step 2/3 Add workforce pool To Teleport
82+
## Step 2/3. Add workforce pool To Teleport
8383

8484
Proceed to the next step in the UI by clicking the **Next** button.
8585

@@ -95,7 +95,7 @@ values or attribute mapping in GCP, you must also updated the respective SAML se
9595
</Admonition>
9696

9797

98-
## Step 3/3 Create GCP IAM policy
98+
## Step 3/3. Create GCP IAM policy
9999

100100
Once a pool and pool provider is configured in the GCP, and its respective configuration is added
101101
to Teleport as a SAML service provider resource, users can sign in into the GCP web console, as
@@ -252,7 +252,7 @@ Save the spec as **pool_provider_name.yaml** file. And create the saml service p
252252
$ tctl create pool_provider_name.yaml
253253
```
254254

255-
## Step 3/3: Create GCP IAM policy
255+
## Step 3/3. Create GCP IAM policy
256256

257257
This step is similar to Step 3 in the guided configuration flow.
258258
You will need to create a GCP IAM policy representing the workforce principal.

docs/pages/admin-guides/access-controls/sso/azuread.mdx

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,34 +3,36 @@ title: Teleport Authentication with Azure Active Directory (AD)
33
description: How to configure Teleport access with Azure Active Directory.
44
---
55

6-
This guide will cover how to configure Microsoft Azure Active Directory to issue
7-
credentials to specific groups of users with a SAML Authentication Connector.
8-
When used in combination with role-based access control (RBAC), it allows Teleport
6+
This guide will cover how to configure Microsoft Entra ID to issue credentials
7+
to specific groups of users with a SAML Authentication Connector. When used in
8+
combination with role-based access control (RBAC), it allows Teleport
99
administrators to define policies like:
1010

11-
- Only members of the "DBA" Azure AD group can connect to PostgreSQL databases.
11+
- Only members of the "DBA" Microsoft Entra ID group can connect to PostgreSQL
12+
databases.
1213
- Developers must never SSH into production servers.
1314

1415
The following steps configure an example SAML authentication connector matching
15-
Azure AD groups with security roles. You can choose to configure other options.
16+
Microsoft Entra ID groups with security roles. You can choose to configure other
17+
options.
1618

1719
## Prerequisites
1820

1921
Before you get started, you’ll need:
2022

21-
- An Azure AD admin account with access to creating non-gallery applications
22-
(P2 License).
23+
- A Microsoft Entra ID admin account with access to creating non-gallery
24+
applications (P2 License).
2325
- To register one or more users in the directory.
24-
- To create at least two security groups in Azure AD and assign one or more
25-
users to each group.
26+
- To create at least two security groups in Microsoft Entra ID and assign one or
27+
more users to each group.
2628
- A Teleport role with access to maintaining `saml` resources. This is available
2729
in the default `editor` role.
2830

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

3133
- (!docs/pages/includes/tctl.mdx!)
3234

33-
## Step 1/3. Configure Azure AD
35+
## Step 1/3. Configure Microsoft Entra ID
3436

3537
### Create an enterprise application
3638

docs/pages/admin-guides/access-controls/sso/gitlab.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ spec:
183183
- Developers also do not have any "allow rules" i.e. they will not be able to
184184
see/replay past sessions or re-configure the Teleport cluster.
185185

186-
Create both roles on the auth server:
186+
Create both roles on the Auth Service:
187187

188188
```code
189189
$ tctl create -f admin.yaml

docs/pages/admin-guides/access-controls/sso/sso.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Teleport users can log in to servers, Kubernetes clusters, databases, web
77
applications, and Windows desktops through their organization's Single Sign-On
88
(SSO) provider.
99

10-
- [Azure Active Directory (AD)](azuread.mdx): Configure Azure Active Directory SSO for SSH, Kubernetes, databases, desktops and web apps.
10+
- [Microsoft Entra ID](azuread.mdx): Configure Microsoft Entra ID SSO for SSH, Kubernetes, databases, desktops and web apps.
1111
- [Active Directory (ADFS)](adfs.mdx): Configure Windows Active Directory SSO for SSH, Kubernetes, databases, desktops and web apps.
1212
- [Google Workspace](google-workspace.mdx): Configure Google Workspace SSO for SSH, Kubernetes, databases, desktops and web apps.
1313
- [GitHub](github-sso.mdx): Configure GitHub SSO for SSH,
@@ -449,7 +449,7 @@ Teleport can also support multiple connectors. For example, a Teleport
449449
administrator can define and create multiple connector resources using
450450
`tctl create` as shown above.
451451

452-
To see all configured connectors, execute this command on the Auth Server:
452+
To see all configured connectors, execute this command on the Auth Service:
453453

454454
```code
455455
$ tctl get connectors

docs/pages/admin-guides/api/getting-started.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ func main() {
113113
}
114114
```
115115

116-
Now you can run the program and connect the client to the Teleport Auth Server to fetch the server version.
116+
Now you can run the program and connect the client to the Teleport Auth Service to fetch the server version.
117117

118118
```code
119119
$ go run main.go

docs/pages/admin-guides/deploy-a-cluster/deployments/aws-gslb-proxy-peering-ha-deployment.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: "Deploying a high-availability Teleport cluster using Proxy Peering
55

66
This deployment architecture features two important design decisions:
77

8-
- AWS Route 53 latency-based routing is used for global server load balancing
8+
- Amazon Route 53 latency-based routing is used for global server load balancing
99
([GSLB](https://www.cloudflare.com/learning/cdn/glossary/global-server-load-balancing-gslb/)).
1010
This allows for efficient distribution of traffic across resources that are globally distributed.
1111
- Teleport's [Proxy Peering](../../../reference/architecture/proxy-peering.mdx) is used to reduce the total number of tunnel connections in the Teleport cluster.
@@ -22,12 +22,12 @@ entry while also ensuring minimal latency when accessing connected resources.
2222
- Deployed exclusively in the AWS ecosystem
2323
- High-availability Auto Scaling group of Auth Service instances that must remain in a single region
2424
- High-availability Auto Scaling group of Proxy Service instances deployed across multiple regions
25-
- [AWS Route 53 latency-based routing](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy-latency.html)
25+
- [Amazon Route 53 latency-based routing](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy-latency.html)
2626
- [GSLB](https://www.cloudflare.com/learning/cdn/glossary/global-server-load-balancing-gslb/)
2727
- [Teleport TLS Routing](../../../reference/architecture/tls-routing.mdx) to reduce the number of ports needed to use Teleport
2828
- [Teleport Proxy Peering](../../../reference/architecture/proxy-peering.mdx) for reducing the number of resource connections
2929
- [AWS Network Load Balancing](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/introduction.html)
30-
- [AWS DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Introduction.html) for cluster state storage
30+
- [Amazon DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Introduction.html) for cluster state storage
3131
- [AWS S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html) for session recording storage
3232

3333
## Advantages of this deployment architecture
@@ -37,7 +37,7 @@ entry while also ensuring minimal latency when accessing connected resources.
3737
- Provides a highly resilient, redundant HA architecture for Teleport that can quickly
3838
scale with an organization's needs.
3939
- All required Teleport components can be provisioned within the AWS ecosystem.
40-
- Using load balancers for the Proxy and Auth Services allows for increased availability
40+
- Using load balancers for the Proxy Service and Auth Service allows for increased availability
4141
during Teleport cluster upgrades.
4242

4343
## Disadvantages of this deployment architecture
@@ -61,7 +61,7 @@ In other words, this must be a Layer 4 load balancer, not a Layer 7
6161
type="warning"
6262
title="Note"
6363
>
64-
Cross-zone load balancing is required for the Auth and Proxy service NLB configurations to route
64+
Cross-zone load balancing is required for the Auth Service and Proxy Service NLB configurations to route
6565
traffic across multiple zones. Doing this improves resiliency against localized AWS zone outages.
6666
</Admonition>
6767

@@ -182,7 +182,7 @@ additional settings.
182182
In this deployment architecture, [Proxy Peering](../../../reference/architecture/proxy-peering.mdx) is used to restrict the number of connections made from
183183
resources to proxies in the Teleport Cluster.
184184

185-
This guide covers the necessary Proxy Peering settings for deploying an HA Teleport Cluster routing resource
185+
This guide covers the necessary Proxy Peering settings for deploying an HA Teleport cluster routing resource
186186
traffic with GSLB.
187187

188188
### Auth Service Proxy Peering configuration
@@ -196,7 +196,7 @@ auth_service:
196196
type: proxy_peering
197197
agent_connection_count: 2
198198
```
199-
Reference the [Auth Server configuration](../../../reference/config.mdx) reference page
199+
Reference the [Auth Service configuration](../../../reference/config.mdx) reference page
200200
for additional settings.
201201

202202
### Proxy Service Proxy Peering configuration

docs/pages/admin-guides/deploy-a-cluster/deployments/aws-ha-autoscale-cluster-terraform.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ here. The license file isn't used in Teleport Community Edition installs.)
219219
$ export TF_VAR_route53_zone="example.com"
220220
```
221221

222-
Our Terraform setup requires you to have your domain provisioned in AWS Route 53 - it will automatically add
222+
Our Terraform setup requires you to have your domain provisioned in Amazon Route 53 - it will automatically add
223223
DNS records for [`route53_domain`](#route53\_domain) as set up below. You can list these with this command:
224224

225225
```code
@@ -367,7 +367,7 @@ $ export TF_VAR_enable_auth_asg_instance_refresh="false"
367367
```
368368

369369
This variable can be used to enable automatic instance refresh on the Teleport
370-
**auth server** AWS Autoscaling Group (ASG) - the refresh is triggered by
370+
**Auth Service** AWS Autoscaling Group (ASG) - the refresh is triggered by
371371
changes to the launch template or configuration.
372372
Enable the auth ASG instance refresh with caution - upgrading the version of
373373
Teleport will trigger an instance refresh and **auth servers must be scaled down

0 commit comments

Comments
 (0)