Skip to content

Commit c5caaca

Browse files
committed
[docs reorganization] Move "Choose an Edition" and edit nav (#42698)
* Move "Choose an Edition" and edit nav Integrate Choose an Edition pages into the new docs organization: - Move Enterprise guides into the Self-Hosting Teleport section. - Move the cloud-hosted Teleport Getting Started guide to the root of docs/pages so we can make it the Try Out Teleport guide. - Move FAQ pagesfrom Choose an Edition and Home into a FAQ reference section. - Remove the Documentation Overview It is no longer accurate. In addition, the new Table of Contents pages provide an overview. - Remove the Teleport Cloud intro page. We're assuming that cloud-hosted Enterprise is the happy path, so remove a page that assumes users begin with Teleport Community Edition. - Remove the Choose an Edition intro. Users who want an edition comparison can use the main Teleport site. - Move External Audit Storage into the Common Operations subsection. - Move the Cloud Downloads page to the root of the docs content directory until we determine a more appropriate home. Edit the docs navigation according to the reorganization plan: - Remove all redirects. We will add new redirects based on differences between the reorganized doc paths and links in Teleport sites that depend on them. - Edit the sidebar configuration per the reorganization plan. - Ensure that pages linked to on the sidebar can be visited without runtime errors and have reasonable titles. * Respond to mmcallister feedback
1 parent 9d3a6bd commit c5caaca

31 files changed

+150
-2206
lines changed

docs/config.json

Lines changed: 40 additions & 1901 deletions
Large diffs are not rendered by default.

docs/pages/access-controls/sso/overview.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -479,11 +479,11 @@ of SSO buttons in the Teleport Web UI.
479479

480480
| Provider | YAML | Example |
481481
| - | - | - |
482-
| GitHub | `display: GitHub` | ![github](../../img/teleport-sso/github@2x.png) |
483-
| Microsoft | `display: Microsoft` | ![microsoft](../../img/teleport-sso/microsoft@2x.png) |
484-
| Google | `display: Google` | ![google](../../img/teleport-sso/google@2x.png) |
485-
| BitBucket | `display: Bitbucket` | ![bitbucket](../../img/teleport-sso/bitbucket@2x.png) |
486-
| OpenID | `display: Okta` | ![Okta](../../img/teleport-sso/openId@2x.png) |
482+
| GitHub | `display: GitHub` | ![github](../../../img/teleport-sso/github@2x.png) |
483+
| Microsoft | `display: Microsoft` | ![microsoft](../../../img/teleport-sso/microsoft@2x.png) |
484+
| Google | `display: Google` | ![google](../../../img/teleport-sso/google@2x.png) |
485+
| BitBucket | `display: Bitbucket` | ![bitbucket](../../../img/teleport-sso/bitbucket@2x.png) |
486+
| OpenID | `display: Okta` | ![Okta](../../../img/teleport-sso/openId@2x.png) |
487487

488488
## Troubleshooting
489489

@@ -511,7 +511,7 @@ If something is not working, we recommend to:
511511
If you get "access denied" or other login errors, the number one place to check is the Audit
512512
Log. You can access it in the **Activity** tab of the Teleport Web UI.
513513

514-
![Audit Log Entry for SSO Login error](../../img/sso/teleportauditlogssofailed.png)
514+
![Audit Log Entry for SSO Login error](../../../img/sso/teleportauditlogssofailed.png)
515515

516516
Example of a user being denied because the role `clusteradmin` wasn't set up:
517517

docs/pages/admin-guides.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Contains guides for performing common tasks on a Teleport cluster after the init
1111

1212
- [Backup and Restore](admin-guides/common-operations/backup-restore.mdx): How to back up and restore your Teleport cluster state.
1313
- [Exporting Teleport Audit Events (section)](admin-guides/common-operations/export-audit-events.mdx): Learn how to export Teleport audit events to your log management solution.
14+
- [External Audit Storage](admin-guides/common-operations/external-audit-storage.mdx): Store audit logs and session recordings on your own infrastructure with Teleport Enterprise Cloud.
1415
- [Run Teleport as a Daemon](admin-guides/common-operations/daemon.mdx): Configure Teleport to run as a daemon using systemd
1516
- [Secure Practices for Teleport Clusters (section)](admin-guides/common-operations/security.mdx): Highlights recommended practices and ways to harden security for your Teleport cluster.
1617
- [Troubleshooting](admin-guides/common-operations/troubleshooting.mdx): Troubleshooting and Collecting Metrics of Teleport Processes
@@ -21,7 +22,7 @@ Contains guides for performing common tasks on a Teleport cluster after the init
2122

2223
Use configuration files and dynamic resources to adjust access controls, enroll infrastructure resources, and edit cluster-wide settings. ([more info](admin-guides/configure-teleport.mdx))
2324

24-
- [Dynamic Resources (section)](admin-guides/configure-teleport/dynamic-resources.mdx): Guides to using Teleport's dynamic resources, which make it possible to apply settings to remote clusters using infrastructure as code.
25+
- [Infrastructure as Code Guides (section)](admin-guides/configure-teleport/dynamic-resources.mdx): Guides to using Teleport's dynamic resources, which make it possible to apply settings to remote clusters using infrastructure as code.
2526
- [Teleport API Introduction (section)](admin-guides/configure-teleport/api.mdx): Introduction to the Teleport gRPC API.
2627

2728
## Protect Infrastructure Resources
@@ -38,8 +39,11 @@ Guides for enrolling servers, databases, and other infrastructure resources with
3839
Guides to deploying and managing the Teleport Auth Service and Proxy Service. ([more info](admin-guides/self-hosting.mdx))
3940

4041
- [Deploying a Self-Hosted Teleport Cluster (section)](admin-guides/self-hosting/deploy-a-cluster.mdx): Guides for deploying self-hosted Teleport clusters on various platforms and cloud providers.
42+
- [Enterprise License File](admin-guides/self-hosting/license.mdx): How to manage your Teleport Enterprise license file.
43+
- [Key Management in Self-Hosted Teleport (section)](admin-guides/self-hosting/key-management.mdx): Guides for managing private key material in self-hosted Teleport clusters.
4144
- [Manage a Self-Hosted Teleport Cluster (section)](admin-guides/self-hosting/management.mdx): Guides to completing common tasks on self-hosted Teleport clusters after the initial deployment.
4245
- [Running a Self-Hosted Teleport Demo Cluster (section)](admin-guides/self-hosting/demo-clusters.mdx): Guides to running small-scale, self-hosted Teleport clusters to test functionality.
46+
- [Self-Hosted Teleport Enterprise Overview](admin-guides/self-hosting/introduction.mdx): Introduction to features and benefits of using Teleport Enterprise.
4347

4448
## Teleport Access Controls
4549

docs/pages/admin-guides/common-operations.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ description: Contains guides for performing common tasks on a Teleport cluster a
66
{/*TOPICS*/}
77

88
- [Backup and Restore](common-operations/backup-restore.mdx): How to back up and restore your Teleport cluster state.
9+
- [External Audit Storage](common-operations/external-audit-storage.mdx): Store audit logs and session recordings on your own infrastructure with Teleport Enterprise Cloud.
910
- [Run Teleport as a Daemon](common-operations/daemon.mdx): Configure Teleport to run as a daemon using systemd
1011
- [Troubleshooting](common-operations/troubleshooting.mdx): Troubleshooting and Collecting Metrics of Teleport Processes
1112
- [Uninstall Teleport](common-operations/uninstall-teleport.mdx): How to remove Teleport from your system

docs/pages/admin-guides/configure-teleport.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,18 @@ enroll infrastructure resources, and edit cluster-wide settings.
88

99
{/*TOPICS*/}
1010

11-
## Dynamic Resources
11+
## Infrastructure as Code Guides
1212

1313
Guides to using Teleport's dynamic resources, which make it possible to apply settings to remote clusters using infrastructure as code. ([more info](configure-teleport/dynamic-resources.mdx))
1414

1515
- [Creating Access Lists with IaC](configure-teleport/dynamic-resources/access-list.mdx): Use Infrastructure-as-Code tooling to create Teleport AccessLists.
1616
- [Kubernetes Operator in teleport-cluster Helm chart](configure-teleport/dynamic-resources/teleport-operator-helm.mdx): Deploy the operator alongside your Helm-deployed Teleport Cluster.
17+
- [Manage Teleport with Infrastructure as Code](configure-teleport/dynamic-resources/overview.mdx): An introduction to Teleport's dynamic resources, which make it possible to apply settings to remote clusters using infrastructure as code.
1718
- [Managing Users And Roles With IaC](configure-teleport/dynamic-resources/user-and-role.mdx): Use infrastructure-as-code tooling to create Teleport users and roles.
1819
- [Registering Agentless OpenSSH Servers with IaC](configure-teleport/dynamic-resources/agentless-ssh-servers.mdx): Use infrastructure-as-code tooling to register Agentless OpenSSH servers in Teleport.
1920
- [Set up the Teleport Terraform Provider](configure-teleport/dynamic-resources/terraform-provider.mdx): How to manage dynamic resources using the Teleport Terraform provider.
2021
- [Standalone Kubernetes Operator](configure-teleport/dynamic-resources/teleport-operator-standalone.mdx): Run a standalone operator against a remote Teleport cluster such as Teleport Cloud.
2122
- [Teleport Kubernetes Operator](configure-teleport/dynamic-resources/teleport-operator.mdx): Easily manage Teleport resources from Kubernetes
22-
- [Using Dynamic Resources](configure-teleport/dynamic-resources/overview.mdx): An introduction to Teleport's dynamic resources, which make it possible to apply settings to remote clusters using infrastructure as code.
2323

2424
## Teleport API Introduction
2525

docs/pages/admin-guides/configure-teleport/dynamic-resources.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Dynamic Resources
2+
title: Infrastructure as Code Guides
33
description: Guides to using Teleport's dynamic resources, which make it possible to apply settings to remote clusters using infrastructure as code.
44
---
55

@@ -11,9 +11,9 @@ infrastructure changes.
1111

1212
- [Creating Access Lists with IaC](dynamic-resources/access-list.mdx): Use Infrastructure-as-Code tooling to create Teleport AccessLists.
1313
- [Kubernetes Operator in teleport-cluster Helm chart](dynamic-resources/teleport-operator-helm.mdx): Deploy the operator alongside your Helm-deployed Teleport Cluster.
14+
- [Manage Teleport with Infrastructure as Code](dynamic-resources/overview.mdx): An introduction to Teleport's dynamic resources, which make it possible to apply settings to remote clusters using infrastructure as code.
1415
- [Managing Users And Roles With IaC](dynamic-resources/user-and-role.mdx): Use infrastructure-as-code tooling to create Teleport users and roles.
1516
- [Registering Agentless OpenSSH Servers with IaC](dynamic-resources/agentless-ssh-servers.mdx): Use infrastructure-as-code tooling to register Agentless OpenSSH servers in Teleport.
1617
- [Set up the Teleport Terraform Provider](dynamic-resources/terraform-provider.mdx): How to manage dynamic resources using the Teleport Terraform provider.
1718
- [Standalone Kubernetes Operator](dynamic-resources/teleport-operator-standalone.mdx): Run a standalone operator against a remote Teleport cluster such as Teleport Cloud.
1819
- [Teleport Kubernetes Operator](dynamic-resources/teleport-operator.mdx): Easily manage Teleport resources from Kubernetes
19-
- [Using Dynamic Resources](dynamic-resources/overview.mdx): An introduction to Teleport's dynamic resources, which make it possible to apply settings to remote clusters using infrastructure as code.

docs/pages/admin-guides/configure-teleport/dynamic-resources/overview.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Using Dynamic Resources
2+
title: Manage Teleport with Infrastructure as Code
33
description: An introduction to Teleport's dynamic resources, which make it possible to apply settings to remote clusters using infrastructure as code.
44
tocDepth: 3
55
---
@@ -24,7 +24,7 @@ There are two ways to configure a Teleport cluster:
2424
This approach makes it possible to incrementally adjust your Teleport
2525
configuration without restarting Teleport instances.
2626

27-
![Architecture of dynamic resources](../../img/dynamic-resources.png)
27+
![Architecture of dynamic resources](../../../../img/dynamic-resources.png)
2828

2929
A cluster is composed of different objects (i.e., resources) and there are three
3030
common operations that can be performed on them: `get` , `create` , and `remove`

docs/pages/admin-guides/protect-resources.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,17 @@ title: Protect Infrastructure Resources
33
description: Guides for enrolling servers, databases, and other infrastructure resources with Teleport so you can set up secure access.
44
---
55

6+
You can use Teleport to set up secure access to resources in your infrastructure
7+
such as Linux servers, databases, and Windows desktops.
8+
9+
The guides in this section show you how to enroll infrastructure resources in
10+
your Teleport cluster.
11+
12+
Teleport **Agents** are Teleport processes that proxy traffic to and from
13+
infrastructure resources. Agents check the permissions of a user who attempts
14+
to access proxied resources, and only permit a connection to a resource if the
15+
resource's **labels** match the labels allowed by the user's role.
16+
617
{/*TOPICS*/}
718

819
- [AWS OIDC Integration](protect-resources/awsoidc-integration.mdx): How to connect your AWS account with Teleport and provide access to AWS resources.

docs/pages/admin-guides/self-hosting.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ description: Guides to deploying and managing the Teleport Auth Service and Prox
55

66
{/*TOPICS*/}
77

8+
- [Enterprise License File](self-hosting/license.mdx): How to manage your Teleport Enterprise license file.
9+
- [Self-Hosted Teleport Enterprise Overview](self-hosting/introduction.mdx): Introduction to features and benefits of using Teleport Enterprise.
10+
811
## Deploying a Self-Hosted Teleport Cluster
912

1013
Guides for deploying self-hosted Teleport clusters on various platforms and cloud providers. ([more info](self-hosting/deploy-a-cluster.mdx))
@@ -14,6 +17,14 @@ Guides for deploying self-hosted Teleport clusters on various platforms and clou
1417
- [Reference Deployment Guides (section)](self-hosting/deploy-a-cluster/deployments.mdx): How to deploy a self-hosted Teleport cluster on different cloud providers.
1518
- [Running a Production Teleport Cluster](self-hosting/deploy-a-cluster/introduction.mdx): Guides to running Teleport in production.
1619

20+
## Key Management in Self-Hosted Teleport
21+
22+
Guides for managing private key material in self-hosted Teleport clusters. ([more info](self-hosting/key-management.mdx))
23+
24+
- [AWS KMS](self-hosting/key-management/aws-kms.mdx): Configure Teleport to store CA private keys in the AWS Key Management Service
25+
- [Google Cloud KMS](self-hosting/key-management/gcp-kms.mdx): Configure Teleport to store CA private keys in the Google Cloud Key Management Service
26+
- [HSM Support](self-hosting/key-management/hsm.mdx): How to configure Hardware Security Modules to manage your Teleport CA private keys
27+
1728
## Manage a Self-Hosted Teleport Cluster
1829

1930
Guides to completing common tasks on self-hosted Teleport clusters after the initial deployment. ([more info](self-hosting/management.mdx))

docs/pages/choose-an-edition/teleport-enterprise/introduction.mdx renamed to docs/pages/admin-guides/self-hosting/introduction.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Teleport Enterprise
3-
description: Introduction to features and benefits of using Teleport Enterprise. Why upgrade to Teleport Enterprise?
2+
title: Self-Hosted Teleport Enterprise Overview
3+
description: Introduction to features and benefits of using Teleport Enterprise.
44
h1: Teleport Enterprise
55
---
66

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: Key Management in Self-Hosted Teleport
3+
description: Guides for managing private key material in self-hosted Teleport clusters.
4+
---
5+
6+
{/*TOPICS*/}
7+
8+
- [AWS KMS](key-management/aws-kms.mdx): Configure Teleport to store CA private keys in the AWS Key Management Service
9+
- [Google Cloud KMS](key-management/gcp-kms.mdx): Configure Teleport to store CA private keys in the Google Cloud Key Management Service
10+
- [HSM Support](key-management/hsm.mdx): How to configure Hardware Security Modules to manage your Teleport CA private keys

docs/pages/choose-an-edition.mdx

Lines changed: 0 additions & 28 deletions
This file was deleted.

docs/pages/choose-an-edition/introduction.mdx

Lines changed: 0 additions & 47 deletions
This file was deleted.

docs/pages/choose-an-edition/teleport-cloud.mdx

Lines changed: 0 additions & 35 deletions
This file was deleted.

0 commit comments

Comments
 (0)