Merge branch 'master' into tcsc/idc-app-resources

gravitational · Nov 20, 2024 · 60ae243 · 60ae243
2 parents f79e397 + 79c69d5
commit 60ae243
Show file tree

Hide file tree

Showing 101 changed files with 3,029 additions and 956 deletions.
diff --git a/api/gen/proto/go/teleport/devicetrust/v1/devicetrust_service.pb.go b/api/gen/proto/go/teleport/devicetrust/v1/devicetrust_service.pb.go
diff --git a/api/proto/teleport/devicetrust/v1/devicetrust_service.proto b/api/proto/teleport/devicetrust/v1/devicetrust_service.proto
@@ -274,16 +274,14 @@ message ListDevicesResponse {
 // Follows the pagination semantics of
 // https://cloud.google.com/apis/design/standard_methods#list.
 message ListDevicesByUserRequest {
+  reserved 3;
+  reserved "view";
   // The maximum number of items to return.
   // The server may impose a different page size at its discretion.
   int32 page_size = 1;
 
   // The next_page_token value returned from a previous List request, if any.
   string page_token = 2;
-
-  // Specifies which fields of the resource should be returned in the response.
-  // Defaults to DEVICE_VIEW_LIST.
-  DeviceView view = 3;
 }
 
 // Response for ListDevicesByUser.

diff --git a/docs/config.json b/docs/config.json
@@ -132,7 +132,7 @@
       "aws_secret_access_key": "zyxw9876-this-is-an-example"
     },
     "cloud": {
-      "version": "16.4.3",
+      "version": "16.4.7",
       "major_version": "16",
       "sla": {
         "monthly_percentage": "99.9%",

diff --git a/...pages/admin-guides/access-controls/access-request-plugins/ssh-approval-jira.mdx b/...pages/admin-guides/access-controls/access-request-plugins/ssh-approval-jira.mdx
@@ -137,27 +137,6 @@ unexpected ways. Remove all other columns and statuses.
 
 Click **Back to board** to review your changes.
 
-### Set up a request ID field
-
-The Teleport Jira plugin expects tasks in the Teleport Access Requests project
-to include a field called `teleportAccessRequestId`, which it uses to track
-individual Access Requests. This prevents users from tampering with or forging
-Access Requests.
-
-To set up the `teleportAccessRequestId` field, click **Project settings** on the
-left navigation bar, then click **Issues** -> **Fields**. 
-
-In the **Actions** menu, click **Edit fields**. Click the **Custom fields** tab
-in the left sidebar, then **Create custom field**. Add a **Short Text** field
-named `teleportAccessRequestId`. Click the checkbox next to **Default Screen**
-to associate that field with this screen. Click **Update**.
-
-Next, add the custom field to your Teleport Access Requests project. Click
-**Projects** > **Teleport Access Requests (TAR)**, then **Project settings**.
-Click **Issues** -> **Types** on the left sidebar, then click **Task** >
-**Fields**. Find the dropdown menu called **Select Field**, then select the
-`teleportAccessRequestId` field you added earlier.
-
 ### Retrieve your Jira API token
 
 Obtain an API token that the Teleport Access Request plugin uses to make

diff --git a/docs/pages/admin-guides/access-controls/sso/github-sso.mdx b/docs/pages/admin-guides/access-controls/sso/github-sso.mdx
@@ -8,6 +8,34 @@ This guide explains how to set up GitHub Single Sign On (SSO) so you can
 automatically map teams in your GitHub organization to users and roles in
 Teleport.
 
+## How it works
+
+A Teleport administrator creates a GitHub authentication connector on the
+Teleport Auth Service backend and requires Teleport users to authenticate
+through GitHub by creating a cluster authentication preference.
+
+When a user authenticates to Teleport, they receive instructions to finish
+authenticating using GitHub. The Teleport Auth Service receives an OAuth 2.0
+access token from GitHub and authenticates the token. (The GitHub authentication
+connector acts as an OAuth 2.0
+[client](https://datatracker.ietf.org/doc/html/rfc6749#section-4.1).)
+
+The Auth Service then issues short-lived TLS and SSH certificates to the user by
+reading data from the OAuth 2.0 access token. In particular, the Auth Service:
+- Maps the user's GitHub teams to Teleport roles in order to assign the user
+  permissions. 
+- Assigns the user's Teleport username to their GitHub username.
+
+<Notice type="warning">
+
+GitHub usernames are not formatted as email addresses. As a result, any Teleport
+plugin that expects to send email to a user based on their Teleport username
+will not work as expected. For example, the [PagerDuty Access Request
+plugin](../access-request-plugins/ssh-approval-pagerduty.mdx) has this
+limitation.
+
+</Notice>
+
 ## Prerequisites
 
 - A GitHub organization with at least one team. 

diff --git a/docs/pages/connect-your-client/teleport-connect.mdx b/docs/pages/connect-your-client/teleport-connect.mdx
@@ -491,6 +491,7 @@ Below is the list of the supported config properties.
 | `keymap.newTerminalTab`       | `` Control+Shift+` `` on macOS<br/>`` Ctrl+Shift+` `` on Windows/Linux                                               | Shortcut to open a new terminal tab.                                                                       |
 | `keymap.terminalCopy`         | `Command+C` on macOS<br/>`Ctrl+Shift+C` on Windows/Linux                                                             | Shortcut to copy text in the terminal.                                                                     |
 | `keymap.terminalPaste`        | `Command+V` on macOS<br/>`Ctrl+Shift+V` on Windows/Linux                                                             | Shortcut to paste text in the terminal.                                                                    |
+| `keymap.terminalSearch`       | `Command+F` on macOS<br/>`Ctrl+Shift+F` on Windows/Linux                                                             | Shortcut to open a search field in the terminal.                                                           |
 | `keymap.previousTab`          | `Control+Shift+Tab` on macOS<br/>`Ctrl+Shift+Tab` on Windows/Linux                                                   | Shortcut to go to the previous tab.                                                                        |
 | `keymap.nextTab`              | `Control+Tab` on macOS<br/>`Ctrl+Tab` on Windows/Linux                                                               | Shortcut to go to the next tab.                                                                            |
 | `keymap.openConnections`      | `Command+P` on macOS<br/>`Ctrl+Shift+P` on Windows/Linux                                                             | Shortcut to open the connection list.                                                                      |

diff --git a/docs/pages/enroll-resources/enroll-resources.mdx b/docs/pages/enroll-resources/enroll-resources.mdx
@@ -3,4 +3,27 @@ title: Enrolling Teleport Resources
 description: Provides step-by-step instructions for enrolling servers, databases, and other infrastructure resources with your Teleport cluster.
 ---
 
+You can use Teleport to protect infrastructure resources like servers,
+databases, and Kubernetes clusters. Once an infrastructure resource is protected
+by Teleport, you can restrict access to the resource using the Teleport
+[role-based access controls
+system](../admin-guides/access-controls/access-controls.mdx) and use Teleport
+features like session recordings and audit events to understand how your users
+interact with the resource.
+
+To enroll a resource with Teleport, you deploy a Teleport Agent, an instance of
+the `teleport` binary configured to run certain services, such as the Teleport
+SSH Service and Teleport Database Service. You then configure the Agent to proxy
+a resource by querying a service discovery API (Auto Discovery), using a
+[dynamic Teleport
+resource](../admin-guides/infrastructure-as-code/infrastructure-as-code.mdx), or
+naming the resource in the Agent's configuration file. Read more about [Teleport
+Agent architecture](../reference/architecture/agents.mdx).
+
+You can also create a Teleport bot user and set up Machine ID to enable service
+accounts to access Teleport-protected resources.
+
+Read the following documentation for more information on enrolling
+infrastructure resources with Teleport:
+
 (!toc!)
diff --git a/docs/pages/installation.mdx b/docs/pages/installation.mdx
@@ -750,15 +750,12 @@ Teleport AMIs are automatically published to all [non-opt-in AWS regions](https:
 
 ## Helm
 
-(!docs/pages/includes/kubernetes-access/helm/helm-repo-add.mdx!)
+Teleport maintains Helm charts for services and plugins, including self-hosted
+Auth Service and Proxy service deployments, Teleport Agents, the Event Handler,
+and Access Request plugins.
 
-There are two charts available to install. Please see our guide for using each
-chart.
-
-|Chart|Included Services|Values Reference|
-|-|-|-|
-|`teleport-cluster`|Auth Service<br/>Proxy Service<br/>Other Teleport services if using a custom configuration|[Reference](reference/helm-reference/teleport-cluster.mdx)
-|`teleport-kube-agent`|Kubernetes Service<br/>Application Service<br/>Database Service<br/>Discovery Service<br/>Jamf Service|[Reference](reference/helm-reference/teleport-kube-agent.mdx)|
+Consult the [Helm chart reference](reference/helm-reference/helm-reference.mdx)
+for documentation on all available Helm charts.
 
 ## macOS
 

diff --git a/docs/pages/reference/terraform-provider/data-sources/access_list.mdx b/docs/pages/reference/terraform-provider/data-sources/access_list.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_access_list Terraform data-source
+sidebar_label: access_list
 description: This page describes the supported values of the teleport_access_list data-source of the Teleport Terraform provider.
 ---
 

diff --git a/docs/pages/reference/terraform-provider/data-sources/access_monitoring_rule.mdx b/docs/pages/reference/terraform-provider/data-sources/access_monitoring_rule.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_access_monitoring_rule Terraform data-source
+sidebar_label: access_monitoring_rule
 description: This page describes the supported values of the teleport_access_monitoring_rule data-source of the Teleport Terraform provider.
 ---
 

diff --git a/docs/pages/reference/terraform-provider/data-sources/app.mdx b/docs/pages/reference/terraform-provider/data-sources/app.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_app Terraform data-source
+sidebar_label: app
 description: This page describes the supported values of the teleport_app data-source of the Teleport Terraform provider.
 ---
 

diff --git a/docs/pages/reference/terraform-provider/data-sources/auth_preference.mdx b/docs/pages/reference/terraform-provider/data-sources/auth_preference.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_auth_preference Terraform data-source
+sidebar_label: auth_preference
 description: This page describes the supported values of the teleport_auth_preference data-source of the Teleport Terraform provider.
 ---
 

diff --git a/.../pages/reference/terraform-provider/data-sources/cluster_maintenance_config.mdx b/.../pages/reference/terraform-provider/data-sources/cluster_maintenance_config.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_cluster_maintenance_config Terraform data-source
+sidebar_label: cluster_maintenance_config
 description: This page describes the supported values of the teleport_cluster_maintenance_config data-source of the Teleport Terraform provider.
 ---
 

diff --git a/docs/pages/reference/terraform-provider/data-sources/cluster_networking_config.mdx b/docs/pages/reference/terraform-provider/data-sources/cluster_networking_config.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_cluster_networking_config Terraform data-source
+sidebar_label: cluster_networking_config
 description: This page describes the supported values of the teleport_cluster_networking_config data-source of the Teleport Terraform provider.
 ---
 

diff --git a/docs/pages/reference/terraform-provider/data-sources/database.mdx b/docs/pages/reference/terraform-provider/data-sources/database.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_database Terraform data-source
+sidebar_label: database
 description: This page describes the supported values of the teleport_database data-source of the Teleport Terraform provider.
 ---
 

diff --git a/docs/pages/reference/terraform-provider/data-sources/dynamic_windows_desktop.mdx b/docs/pages/reference/terraform-provider/data-sources/dynamic_windows_desktop.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_dynamic_windows_desktop Terraform data-source
+sidebar_label: dynamic_windows_desktop
 description: This page describes the supported values of the teleport_dynamic_windows_desktop data-source of the Teleport Terraform provider.
 ---
 

diff --git a/docs/pages/reference/terraform-provider/data-sources/github_connector.mdx b/docs/pages/reference/terraform-provider/data-sources/github_connector.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_github_connector Terraform data-source
+sidebar_label: github_connector
 description: This page describes the supported values of the teleport_github_connector data-source of the Teleport Terraform provider.
 ---
 

diff --git a/docs/pages/reference/terraform-provider/data-sources/installer.mdx b/docs/pages/reference/terraform-provider/data-sources/installer.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_installer Terraform data-source
+sidebar_label: installer
 description: This page describes the supported values of the teleport_installer data-source of the Teleport Terraform provider.
 ---
 

diff --git a/docs/pages/reference/terraform-provider/data-sources/login_rule.mdx b/docs/pages/reference/terraform-provider/data-sources/login_rule.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_login_rule Terraform data-source
+sidebar_label: login_rule
 description: This page describes the supported values of the teleport_login_rule data-source of the Teleport Terraform provider.
 ---
 

diff --git a/docs/pages/reference/terraform-provider/data-sources/oidc_connector.mdx b/docs/pages/reference/terraform-provider/data-sources/oidc_connector.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_oidc_connector Terraform data-source
+sidebar_label: oidc_connector
 description: This page describes the supported values of the teleport_oidc_connector data-source of the Teleport Terraform provider.
 ---
 

diff --git a/docs/pages/reference/terraform-provider/data-sources/okta_import_rule.mdx b/docs/pages/reference/terraform-provider/data-sources/okta_import_rule.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_okta_import_rule Terraform data-source
+sidebar_label: okta_import_rule
 description: This page describes the supported values of the teleport_okta_import_rule data-source of the Teleport Terraform provider.
 ---
 

diff --git a/docs/pages/reference/terraform-provider/data-sources/provision_token.mdx b/docs/pages/reference/terraform-provider/data-sources/provision_token.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_provision_token Terraform data-source
+sidebar_label: provision_token
 description: This page describes the supported values of the teleport_provision_token data-source of the Teleport Terraform provider.
 ---
 

diff --git a/docs/pages/reference/terraform-provider/data-sources/role.mdx b/docs/pages/reference/terraform-provider/data-sources/role.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_role Terraform data-source
+sidebar_label: role
 description: This page describes the supported values of the teleport_role data-source of the Teleport Terraform provider.
 ---
 

diff --git a/docs/pages/reference/terraform-provider/data-sources/saml_connector.mdx b/docs/pages/reference/terraform-provider/data-sources/saml_connector.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_saml_connector Terraform data-source
+sidebar_label: saml_connector
 description: This page describes the supported values of the teleport_saml_connector data-source of the Teleport Terraform provider.
 ---
 

diff --git a/docs/pages/reference/terraform-provider/data-sources/session_recording_config.mdx b/docs/pages/reference/terraform-provider/data-sources/session_recording_config.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_session_recording_config Terraform data-source
+sidebar_label: session_recording_config
 description: This page describes the supported values of the teleport_session_recording_config data-source of the Teleport Terraform provider.
 ---
 

diff --git a/docs/pages/reference/terraform-provider/data-sources/static_host_user.mdx b/docs/pages/reference/terraform-provider/data-sources/static_host_user.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_static_host_user Terraform data-source
+sidebar_label: static_host_user
 description: This page describes the supported values of the teleport_static_host_user data-source of the Teleport Terraform provider.
 ---
 

diff --git a/docs/pages/reference/terraform-provider/data-sources/trusted_cluster.mdx b/docs/pages/reference/terraform-provider/data-sources/trusted_cluster.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_trusted_cluster Terraform data-source
+sidebar_label: trusted_cluster
 description: This page describes the supported values of the teleport_trusted_cluster data-source of the Teleport Terraform provider.
 ---
 

diff --git a/docs/pages/reference/terraform-provider/data-sources/trusted_device.mdx b/docs/pages/reference/terraform-provider/data-sources/trusted_device.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_trusted_device Terraform data-source
+sidebar_label: trusted_device
 description: This page describes the supported values of the teleport_trusted_device data-source of the Teleport Terraform provider.
 ---
 

diff --git a/docs/pages/reference/terraform-provider/data-sources/user.mdx b/docs/pages/reference/terraform-provider/data-sources/user.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_user Terraform data-source
+sidebar_label: user
 description: This page describes the supported values of the teleport_user data-source of the Teleport Terraform provider.
 ---
 

diff --git a/docs/pages/reference/terraform-provider/resources/access_list.mdx b/docs/pages/reference/terraform-provider/resources/access_list.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_access_list Terraform resource
+sidebar_label: access_list
 description: This page describes the supported values of the teleport_access_list resource of the Teleport Terraform provider.
 ---
 

diff --git a/docs/pages/reference/terraform-provider/resources/access_monitoring_rule.mdx b/docs/pages/reference/terraform-provider/resources/access_monitoring_rule.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_access_monitoring_rule Terraform resource
+sidebar_label: access_monitoring_rule
 description: This page describes the supported values of the teleport_access_monitoring_rule resource of the Teleport Terraform provider.
 ---
 

diff --git a/docs/pages/reference/terraform-provider/resources/app.mdx b/docs/pages/reference/terraform-provider/resources/app.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_app Terraform resource
+sidebar_label: app
 description: This page describes the supported values of the teleport_app resource of the Teleport Terraform provider.
 ---
 

diff --git a/docs/pages/reference/terraform-provider/resources/auth_preference.mdx b/docs/pages/reference/terraform-provider/resources/auth_preference.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_auth_preference Terraform resource
+sidebar_label: auth_preference
 description: This page describes the supported values of the teleport_auth_preference resource of the Teleport Terraform provider.
 ---
 

diff --git a/docs/pages/reference/terraform-provider/resources/bot.mdx b/docs/pages/reference/terraform-provider/resources/bot.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_bot Terraform resource
+sidebar_label: bot
 description: This page describes the supported values of the teleport_bot resource of the Teleport Terraform provider.
 ---
 

diff --git a/docs/pages/reference/terraform-provider/resources/cluster_maintenance_config.mdx b/docs/pages/reference/terraform-provider/resources/cluster_maintenance_config.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_cluster_maintenance_config Terraform resource
+sidebar_label: cluster_maintenance_config
 description: This page describes the supported values of the teleport_cluster_maintenance_config resource of the Teleport Terraform provider.
 ---
 

diff --git a/docs/pages/reference/terraform-provider/resources/cluster_networking_config.mdx b/docs/pages/reference/terraform-provider/resources/cluster_networking_config.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_cluster_networking_config Terraform resource
+sidebar_label: cluster_networking_config
 description: This page describes the supported values of the teleport_cluster_networking_config resource of the Teleport Terraform provider.
 ---
 

diff --git a/docs/pages/reference/terraform-provider/resources/database.mdx b/docs/pages/reference/terraform-provider/resources/database.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_database Terraform resource
+sidebar_label: database
 description: This page describes the supported values of the teleport_database resource of the Teleport Terraform provider.
 ---
 

diff --git a/docs/pages/reference/terraform-provider/resources/dynamic_windows_desktop.mdx b/docs/pages/reference/terraform-provider/resources/dynamic_windows_desktop.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_dynamic_windows_desktop Terraform resource
+sidebar_label: dynamic_windows_desktop
 description: This page describes the supported values of the teleport_dynamic_windows_desktop resource of the Teleport Terraform provider.
 ---
 

diff --git a/docs/pages/reference/terraform-provider/resources/github_connector.mdx b/docs/pages/reference/terraform-provider/resources/github_connector.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_github_connector Terraform resource
+sidebar_label: github_connector
 description: This page describes the supported values of the teleport_github_connector resource of the Teleport Terraform provider.
 ---
 

diff --git a/docs/pages/reference/terraform-provider/resources/installer.mdx b/docs/pages/reference/terraform-provider/resources/installer.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_installer Terraform resource
+sidebar_label: installer
 description: This page describes the supported values of the teleport_installer resource of the Teleport Terraform provider.
 ---
 

diff --git a/docs/pages/reference/terraform-provider/resources/login_rule.mdx b/docs/pages/reference/terraform-provider/resources/login_rule.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_login_rule Terraform resource
+sidebar_label: login_rule
 description: This page describes the supported values of the teleport_login_rule resource of the Teleport Terraform provider.
 ---
 

diff --git a/docs/pages/reference/terraform-provider/resources/oidc_connector.mdx b/docs/pages/reference/terraform-provider/resources/oidc_connector.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_oidc_connector Terraform resource
+sidebar_label: oidc_connector
 description: This page describes the supported values of the teleport_oidc_connector resource of the Teleport Terraform provider.
 ---
 

diff --git a/docs/pages/reference/terraform-provider/resources/okta_import_rule.mdx b/docs/pages/reference/terraform-provider/resources/okta_import_rule.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_okta_import_rule Terraform resource
+sidebar_label: okta_import_rule
 description: This page describes the supported values of the teleport_okta_import_rule resource of the Teleport Terraform provider.
 ---
 

diff --git a/docs/pages/reference/terraform-provider/resources/provision_token.mdx b/docs/pages/reference/terraform-provider/resources/provision_token.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reference for the teleport_provision_token Terraform resource
+sidebar_label: provision_token
 description: This page describes the supported values of the teleport_provision_token resource of the Teleport Terraform provider.
 ---