From b74176c9e090182f24237ab966c65ce97785e5bb Mon Sep 17 00:00:00 2001 From: Paul Gottschling Date: Wed, 24 Jul 2024 16:35:40 -0400 Subject: [PATCH 1/2] Update the list of preset roles Closes #44086 In the Access Controls reference, mention preset roles based on `constants.go`. Since we use a list of preset roles in two guides, extract the table of preset roles from the Access Controls reference into a partial. --- docs/pages/access-controls/getting-started.mdx | 13 ++----------- docs/pages/access-controls/reference.mdx | 12 +++--------- docs/pages/includes/preset-roles-table.mdx | 13 +++++++++++++ 3 files changed, 18 insertions(+), 20 deletions(-) create mode 100644 docs/pages/includes/preset-roles-table.mdx diff --git a/docs/pages/access-controls/getting-started.mdx b/docs/pages/access-controls/getting-started.mdx index 33cb5224b410b..0bc74d3710db5 100644 --- a/docs/pages/access-controls/getting-started.mdx +++ b/docs/pages/access-controls/getting-started.mdx @@ -20,18 +20,9 @@ wrap up with creating your own role. ## Step 1/3. Add local users with preset roles -Teleport provides several preset roles: `editor`, `auditor`, and `access`. +Teleport provides several preset roles: -- The `editor` role authorizes users to modify cluster configuration. -- The `auditor` role authorizes users to view audit logs. -- The `access` role authorizes users to access cluster resources. - -
-Teleport Enterprise contains two additional preset roles: `reviewer` and `requester`. - -- The `reviewer` role authorizes users to review Access Requests. -- The `requester` role authorizes users to request resources. -
+(!docs/pages/includes/preset-roles-table.mdx!) diff --git a/docs/pages/access-controls/reference.mdx b/docs/pages/access-controls/reference.mdx index ccdc012592432..68432fd468ff9 100644 --- a/docs/pages/access-controls/reference.mdx +++ b/docs/pages/access-controls/reference.mdx @@ -74,15 +74,9 @@ user: ## Preset roles -Teleport provides several pre-defined roles out-of-the-box: - -| Role | Description | -| --- | --- | -| `editor` | Allows editing of cluster configuration settings. | -| `auditor`| Allows reading cluster events, audit logs, and playing back session records. | -| `access`| Allows access to cluster resources. | -| `requester`| Enterprise-only role that allows a user to create Access Requests. | -| `reviewer`| Enterprise-only role that allows review of Access Requests. | +Teleport provides several preset roles: + +(!docs/pages/includes/preset-roles-table.mdx!) ### Role versions diff --git a/docs/pages/includes/preset-roles-table.mdx b/docs/pages/includes/preset-roles-table.mdx new file mode 100644 index 0000000000000..5c0f8f3099027 --- /dev/null +++ b/docs/pages/includes/preset-roles-table.mdx @@ -0,0 +1,13 @@ +| Role | Description | +| --- | --- | +| `access`| Allows access to cluster resources. | +| `auditor`| Allows reading cluster events, audit logs, and playing back session records. | +| `device-admin`| Used to manage trusted devices.| +| `device-enroll`| Used to grant device enrollment powers to users.| +| `editor` | Allows editing of cluster configuration settings. | +| `group-access`| Allows access to all user groups.| +| `requester`| Enterprise-only role that allows a user to create Access Requests. | +| `require-trusted-device`| Requires trusted device access to resources.| +| `reviewer`| Enterprise-only role that allows review of Access Requests. | +| `terraform-provider`|Allows the Teleport Terraform provider to configure all of its supported Teleport resources.| + From 8dc911592b00dd6e37000dd72c8047ef78dc32e6 Mon Sep 17 00:00:00 2001 From: Paul Gottschling Date: Fri, 26 Jul 2024 17:23:56 -0400 Subject: [PATCH 2/2] Update docs/pages/includes/preset-roles-table.mdx Co-authored-by: Nic Klaassen --- docs/pages/includes/preset-roles-table.mdx | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/pages/includes/preset-roles-table.mdx b/docs/pages/includes/preset-roles-table.mdx index 5c0f8f3099027..5d757ff8e2e00 100644 --- a/docs/pages/includes/preset-roles-table.mdx +++ b/docs/pages/includes/preset-roles-table.mdx @@ -1,13 +1,13 @@ | Role | Description | | --- | --- | | `access`| Allows access to cluster resources. | -| `auditor`| Allows reading cluster events, audit logs, and playing back session records. | -| `device-admin`| Used to manage trusted devices.| -| `device-enroll`| Used to grant device enrollment powers to users.| | `editor` | Allows editing of cluster configuration settings. | -| `group-access`| Allows access to all user groups.| +| `auditor`| Allows reading cluster events, audit logs, and playing back session records. | | `requester`| Enterprise-only role that allows a user to create Access Requests. | -| `require-trusted-device`| Requires trusted device access to resources.| | `reviewer`| Enterprise-only role that allows review of Access Requests. | -| `terraform-provider`|Allows the Teleport Terraform provider to configure all of its supported Teleport resources.| +| `group-access`| Allows access to all user groups. | +| `device-admin`| Used to manage trusted devices. | +| `device-enroll`| Used to grant device enrollment powers to users. | +| `require-trusted-device`| Requires trusted device access to resources. | +| `terraform-provider`| Allows the Teleport Terraform provider to configure all of its supported Teleport resources. |