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.

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

[docs reorg] Reorganize Kubernetes Access and Desktop Access #42708

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions docs/pages/admin-guides.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ Guides for enrolling servers, databases, and other infrastructure resources with
- [Protect Linux Servers with Teleport (section)](admin-guides/protect-resources/server-access.mdx): How to enroll Linux servers in your Teleport cluster to enable secure SSH access.
- [Teleport Agents (section)](admin-guides/protect-resources/agents.mdx): How to use Teleport Agents, which enable users to connect to resources in your infrastructure.
- [Teleport Auto-Discovery (section)](admin-guides/protect-resources/auto-discovery.mdx): Learn how to use the Teleport Discovery Service, which automatically enrolls resources by query APIs
- [Teleport Desktop Access (section)](admin-guides/protect-resources/desktop-access.mdx): How to proctect Windows Desktops with Teleport
- [Teleport Kubernetes Access (section)](admin-guides/protect-resources/kubernetes-access.mdx): Protect Kubernetes clusters with Teleport

## Self-Hosting Teleport

Expand Down
23 changes: 23 additions & 0 deletions docs/pages/admin-guides/protect-resources.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,26 @@ Learn how to use the Teleport Discovery Service, which automatically enrolls res
- [Automatically Enroll Kubernetes Clusters (section)](protect-resources/auto-discovery/kubernetes.mdx): Register Kubernetes clusters with your Teleport cluster by polling service discovery endpoints.
- [Enroll Kubernetes Services as Teleport Applications (section)](protect-resources/auto-discovery/kubernetes-applications.mdx): Teleport can automatically detect applications running in your Kubernetes clusters and register them with Teleport for secure access.
- [Server Auto-Discovery (section)](protect-resources/auto-discovery/servers.mdx): You can set up the Teleport Discovery Service to automatically enroll servers in your infrastructure.

## Teleport Desktop Access

How to proctect Windows Desktops with Teleport ([more info](protect-resources/desktop-access.mdx))

- [Automatic User Creation](protect-resources/desktop-access/user-creation.mdx): Using Automatic User Creation with Teleport desktop access.
- [Clipboard Sharing](protect-resources/desktop-access/clipboard.mdx): Using Clipboard Sharing with Teleport desktop access.
- [Configure access for Active Directory manually](protect-resources/desktop-access/active-directory-manual.mdx): Explains how to manually connect Teleport to an Active Directory domain.
- [Configure access for local Windows users](protect-resources/desktop-access/getting-started.mdx): Use Teleport to configure passwordless access for local Windows users.
- [Directory Sharing](protect-resources/desktop-access/directory-sharing.mdx): Teleport desktop Directory Sharing lets you easily send files to a remote desktop.
- [Manage Access to Windows Resources](protect-resources/desktop-access/introduction.mdx): Demonstrates how you can manage access to Windows desktops with Teleport.
- [Session Recording and Playback](protect-resources/desktop-access/sessions.mdx): Recording and playing back Teleport desktop access sessions.
- [Troubleshooting Desktop Access](protect-resources/desktop-access/troubleshooting.mdx): Common issues and resolutions for Teleport's desktop access

## Teleport Kubernetes Access

Protect Kubernetes clusters with Teleport ([more info](protect-resources/kubernetes-access.mdx))

- [Access Kubernetes Clusters with Teleport](protect-resources/kubernetes-access/introduction.mdx): Learn how Teleport can protect your Kubernetes clusters with RBAC, audit logging, and more.
- [Enroll a Kubernetes Cluster](protect-resources/kubernetes-access/getting-started.mdx): Demonstrates how to enroll a Kubernetes cluster as a resource protected by Teleport.
- [Kubernetes Access Troubleshooting](protect-resources/kubernetes-access/troubleshooting.mdx): Troubleshooting common issues with Kubernetes access
- [Registering Kubernetes Clusters with Teleport (section)](protect-resources/kubernetes-access/register-clusters.mdx): How to manually add a Kubernetes cluster to Teleport after creating it.
- [Setting Up Teleport Access Controls for Kubernetes](protect-resources/kubernetes-access/manage-access.mdx): How to configure Teleport roles to access clusters, groups, users, and resources in Kubernetes.
15 changes: 15 additions & 0 deletions docs/pages/admin-guides/protect-resources/desktop-access.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Teleport Desktop Access
description: How to proctect Windows Desktops with Teleport
---

{/*TOPICS*/}

- [Automatic User Creation](desktop-access/user-creation.mdx): Using Automatic User Creation with Teleport desktop access.
- [Clipboard Sharing](desktop-access/clipboard.mdx): Using Clipboard Sharing with Teleport desktop access.
- [Configure access for Active Directory manually](desktop-access/active-directory-manual.mdx): Explains how to manually connect Teleport to an Active Directory domain.
- [Configure access for local Windows users](desktop-access/getting-started.mdx): Use Teleport to configure passwordless access for local Windows users.
- [Directory Sharing](desktop-access/directory-sharing.mdx): Teleport desktop Directory Sharing lets you easily send files to a remote desktop.
- [Manage Access to Windows Resources](desktop-access/introduction.mdx): Demonstrates how you can manage access to Windows desktops with Teleport.
- [Session Recording and Playback](desktop-access/sessions.mdx): Recording and playing back Teleport desktop access sessions.
- [Troubleshooting Desktop Access](desktop-access/troubleshooting.mdx): Common issues and resolutions for Teleport's desktop access
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Recorded sessions can be viewed in the *Session Recordings* page under the
*Activity* section in the *Management* area. Desktop recordings show a
desktop icon in the first column to distinguish them from SSH recordings.

![Desktop Session Recording](../../../img/desktop-access/session-recording@2x.png)
![Desktop Session Recording](../../../../img/desktop-access/session-recording@2x.png)

Click the play button to open the player in a new tab. To export desktop session
recordings to video for playback outside of Teleport, use the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,8 @@ description: Protect Kubernetes clusters with Teleport

- [Access Kubernetes Clusters with Teleport](kubernetes-access/introduction.mdx): Learn how Teleport can protect your Kubernetes clusters with RBAC, audit logging, and more.
- [Enroll a Kubernetes Cluster](kubernetes-access/getting-started.mdx): Demonstrates how to enroll a Kubernetes cluster as a resource protected by Teleport.
- [Kubernetes Access FAQ](kubernetes-access/faq.mdx): Frequently asked questions about Teleport Kubernetes Access
- [Kubernetes Access Troubleshooting](kubernetes-access/troubleshooting.mdx): Troubleshooting common issues with Kubernetes access
- [Setting Up Teleport Access Controls for Kubernetes](kubernetes-access/manage-access.mdx): How to configure Teleport roles to access clusters, groups, users, and resources in Kubernetes.
- [Teleport Kubernetes Access Controls](kubernetes-access/controls.mdx): How the Teleport Kubernetes Service applies RBAC to manage access to Kubernetes

## Registering Kubernetes Clusters with Teleport

Expand Down
24 changes: 0 additions & 24 deletions docs/pages/desktop-access.mdx

This file was deleted.

14 changes: 0 additions & 14 deletions docs/pages/desktop-access/reference.mdx

This file was deleted.

7 changes: 6 additions & 1 deletion docs/pages/reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ description: Comprehensive guides to commands, configuration options, and other

Contains guides to frequently asked questions for various Teleport features and use cases. ([more info](reference/faq.mdx))

- [Kubernetes Access FAQ](reference/faq/kubernetes-access.mdx): Frequently asked questions about Teleport Kubernetes Access
- [Teleport Enterprise Cloud FAQ](reference/faq/cloud-hosting.mdx): Teleport cloud frequently asked questions.
- [Teleport FAQ](reference/faq/faq.mdx): Frequently Asked Questions About Using Teleport

Expand All @@ -29,6 +30,8 @@ References for concepts and tools available for operating Teleport. ([more info]
Available options for configuring access to Teleport privileges and infrastructure resources. ([more info](reference/rbac.mdx))

- [Access Controls for Servers](reference/rbac/server-rbac.mdx): Role-based access control (RBAC) for Teleport server access.
- [Role-Based Access Control for Desktops](reference/rbac/desktop-access.mdx): Role-based access control (RBAC) for desktops protected by Teleport.
- [Teleport Kubernetes Access Controls](reference/rbac/controls.mdx): How the Teleport Kubernetes Service applies RBAC to manage access to Kubernetes

## Teleport Architecture Guides

Expand All @@ -52,6 +55,7 @@ Guides to the inner workings of components within a Teleport cluster. ([more inf
Comprehensive lists of commands, arguments, and flags for Teleport CLI tools. ([more info](reference/cli.mdx))

- [CLI Reference Introduction](reference/cli/overview.mdx): Detailed guide and reference documentation for Teleport's command line interface (CLI) tools.
- [Desktop Access CLI Reference](reference/cli/desktop-access.mdx): CLI reference for Teleport desktop access.
- [tbot CLI reference](reference/cli/tbot.mdx): Comprehensive reference of subcommands, flags, and arguments for the tbot CLI tool.
- [tctl CLI reference](reference/cli/tctl.mdx): Comprehensive reference of subcommands, flags, and arguments for the tctl CLI tool.
- [teleport CLI Reference](reference/cli/teleport.mdx): Comprehensive reference of subcommands, flags, and arguments for the teleport CLI tool.
Expand All @@ -61,6 +65,7 @@ Comprehensive lists of commands, arguments, and flags for Teleport CLI tools. ([

Comprehensive guides to configuring Teleport. ([more info](reference/config-references.mdx))

- [Desktop Access Configuration Reference](reference/config-references/database-access-config.mdx): Configuration reference for Teleport desktop access.
- [Helm Chart Reference (section)](reference/config-references/helm-reference.mdx): Comprehensive lists of configuration values in Teleport's Helm charts
- [Predicate Language](reference/config-references/predicate-language.mdx): How to use Teleport's predicate language to define filter conditions.
- [Teleport Configuration Reference](reference/config-references/config.mdx): The detailed guide and reference documentation for configuring Teleport for SSH and Kubernetes access.
Expand All @@ -71,9 +76,9 @@ Comprehensive guides to configuring Teleport. ([more info](reference/config-refe

How to obtain information about activity in your Teleport cluster. ([more info](reference/monitoring.mdx))

- [Audit Events and Records](reference/monitoring/audit.mdx): Reference of Teleport Audit Events and Session Records
- [Distributed Tracing Configuration Reference](reference/monitoring/configuration.mdx): Configuration reference for Distributed Tracing.
- [Distributed Tracing](reference/monitoring/tracing.mdx): How to enable tracing within Teleport.
- [Health Monitoring](reference/monitoring/monitoring.mdx): Monitoring health and readiness.
- [Metrics](reference/monitoring/metrics.mdx): How to enable and consume metrics
- [Profiling](reference/monitoring/profiles.mdx): Collecting pprof profiles.
- [Teleport Audit Event References (section)](reference/monitoring/audit.mdx): Reference guides to audit events that you can export and track in Teleport.
1 change: 1 addition & 0 deletions docs/pages/reference/cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ description: Comprehensive lists of commands, arguments, and flags for Teleport
{/*TOPICS*/}

- [CLI Reference Introduction](cli/overview.mdx): Detailed guide and reference documentation for Teleport's command line interface (CLI) tools.
- [Desktop Access CLI Reference](cli/desktop-access.mdx): CLI reference for Teleport desktop access.
- [tbot CLI reference](cli/tbot.mdx): Comprehensive reference of subcommands, flags, and arguments for the tbot CLI tool.
- [tctl CLI reference](cli/tctl.mdx): Comprehensive reference of subcommands, flags, and arguments for the tctl CLI tool.
- [teleport CLI Reference](cli/teleport.mdx): Comprehensive reference of subcommands, flags, and arguments for the teleport CLI tool.
Expand Down
1 change: 1 addition & 0 deletions docs/pages/reference/config-references.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ description: Comprehensive guides to configuring Teleport.

{/*TOPICS*/}

- [Desktop Access Configuration Reference](config-references/database-access-config.mdx): Configuration reference for Teleport desktop access.
- [Predicate Language](config-references/predicate-language.mdx): How to use Teleport's predicate language to define filter conditions.
- [Teleport Configuration Reference](config-references/config.mdx): The detailed guide and reference documentation for configuring Teleport for SSH and Kubernetes access.
- [Teleport Resource Reference](config-references/resources.mdx): Reference documentation for Teleport resources
Expand Down
1 change: 1 addition & 0 deletions docs/pages/reference/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@ description: Contains guides to frequently asked questions for various Teleport

{/*TOPICS*/}

- [Kubernetes Access FAQ](faq/kubernetes-access.mdx): Frequently asked questions about Teleport Kubernetes Access
- [Teleport Enterprise Cloud FAQ](faq/cloud-hosting.mdx): Teleport cloud frequently asked questions.
- [Teleport FAQ](faq/faq.mdx): Frequently Asked Questions About Using Teleport
8 changes: 7 additions & 1 deletion docs/pages/reference/monitoring.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,15 @@ description: How to obtain information about activity in your Teleport cluster.

{/*TOPICS*/}

- [Audit Events and Records](monitoring/audit.mdx): Reference of Teleport Audit Events and Session Records
- [Distributed Tracing Configuration Reference](monitoring/configuration.mdx): Configuration reference for Distributed Tracing.
- [Distributed Tracing](monitoring/tracing.mdx): How to enable tracing within Teleport.
- [Health Monitoring](monitoring/monitoring.mdx): Monitoring health and readiness.
- [Metrics](monitoring/metrics.mdx): How to enable and consume metrics
- [Profiling](monitoring/profiles.mdx): Collecting pprof profiles.

## Teleport Audit Event References

Reference guides to audit events that you can export and track in Teleport. ([more info](monitoring/audit.mdx))

- [Audit Events and Records](monitoring/audit/audit.mdx): Reference of Teleport Audit Events and Session Records
- [Desktop Access Audit Events Reference](monitoring/audit/desktop-events.mdx): Audit events reference for Teleport desktop access.
Loading
Loading