Skip to content

Commit

Permalink
Use generated TOC pages for smaller sections (#42374)
Browse files Browse the repository at this point in the history 
Sections included in this change:

- docs/pages/agents/
- docs/pages/auto-discovery/
- docs/pages/choose-an-edition/
- docs/pages/desktop-access/
- docs/pages/includes/
- docs/pages/kubernetes-access/

Other changes:

- Move Helm includes out of docs/pages/kubernetes-access to match the
  expectations of the TOC page generator. Also move "Connect your
  Client" includes to docs/pages/includes.
- Some pages were at the expected location of a TOC page (i.e., with the
  same name as a subdirectory), but included explanatory information
  that didn't fit the format of this kind of page. This change moves
  these pages to other locations as overview pages.
- Update config.json.
  • Loading branch information
@ptgott
ptgott committed Jun 18, 2024
1 parent 1045d8e commit fe3fc86
Show file tree
Hide file tree
Showing 28 changed files with 752 additions and 271 deletions.
322 changes: 306 additions & 16 deletions docs/config.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@
},
{
"title": "Teleport Enterprise Cloud",
"slug": "/choose-an-edition/teleport-cloud/introduction/",
"slug": "/choose-an-edition/teleport-cloud/",
"forScopes": ["cloud"],
"entries": [
{
Expand Down Expand Up @@ -941,7 +941,7 @@
"entries": [
{
"title": "Introduction",
"slug": "/auto-discovery/introduction/"
"slug": "/auto-discovery/"
},
{
"title": "Servers",
Expand Down Expand Up @@ -2032,18 +2032,313 @@
"permanent": true
},
{
"source": "/application-access/",
"destination": "/application-access/introduction/",
"source": "/kubernetes-access/guides/migration/",
"destination": "/kubernetes-access/introduction/",
"permanent": true
},
{
"source": "/desktop-access/",
"destination": "/desktop-access/introduction/",
"source": "/setup/guides/joining-nodes-aws/",
"destination": "/agents/join-services-to-your-cluster/aws-iam/",
"permanent": true
},
{
"source": "/kubernetes-access/",
"destination": "/kubernetes-access/introduction/",
"source": "/setup/reference/license/",
"destination": "/choose-an-edition/teleport-enterprise/license/",
"permanent": true
},
{
"source": "/intro/",
"destination": "/",
"permanent": true
},
{
"source": "/api-reference/",
"destination": "/api/getting-started/",
"permanent": true
},
{
"source": "/server-access/guides/tsh/",
"destination": "/connect-your-client/tsh/",
"permanent": true
},
{
"source": "/cluster/",
"destination": "/kubernetes-access/getting-started/",
"permanent": true
},
{
"source": "/application-access/guides/jwt/",
"destination": "/application-access/jwt/",
"permanent": true
},
{
"source": "/getting-started/digitalocean/",
"destination": "/",
"permanent": true
},
{
"source": "/kubernetes-access/getting-started/agent/",
"destination": "/kubernetes-access/getting-started/",
"permanent": true
},
{
"source": "/kubernetes-access/getting-started/cluster/",
"destination": "/deploy-a-cluster/helm-deployments/kubernetes-cluster/",
"permanent": true
},
{
"source": "/kubernetes-access/getting-started/local/",
"destination": "/kubernetes-access/",
"permanent": true
},
{
"source": "/kubernetes-access/helm/guides/",
"destination": "/deploy-a-cluster/helm-deployments/",
"permanent": true
},
{
"source": "/kubernetes-access/helm/guides/aws/",
"destination": "/deploy-a-cluster/helm-deployments/aws/",
"permanent": true
},
{
"source": "/kubernetes-access/helm/guides/custom/",
"destination": "/deploy-a-cluster/helm-deployments/custom/",
"permanent": true
},
{
"source": "/kubernetes-access/helm/guides/digitalocean/",
"destination": "/deploy-a-cluster/helm-deployments/digitalocean/",
"permanent": true
},
{
"source": "/kubernetes-access/helm/guides/gcp/",
"destination": "/deploy-a-cluster/helm-deployments/gcp/",
"permanent": true
},
{
"source": "/kubernetes-access/helm/guides/migration/",
"destination": "/deploy-a-cluster/helm-deployments/migration-v12/",
"permanent": true
},
{
"source": "/kubernetes-access/helm/reference/",
"destination": "/reference/helm-reference/",
"permanent": true
},
{
"source": "/kubernetes-access/helm/reference/teleport-cluster/",
"destination": "/reference/helm-reference/teleport-cluster/",
"permanent": true
},
{
"source": "/kubernetes-access/helm/reference/teleport-kube-agent/",
"destination": "/reference/helm-reference/teleport-kube-agent/",
"permanent": true
},
{
"source": "/access-controls/guides/u2f/",
"destination": "/access-controls/guides/webauthn/",
"permanent": true
},
{
"source": "/enterprise/workflow/",
"destination": "/access-controls/access-requests/",
"permanent": true
},
{
"source": "/enterprise/workflow/ssh-approval-mattermost/",
"destination": "/access-controls/access-request-plugins/ssh-approval-mattermost/",
"permanent": true
},
{
"source": "/enterprise/workflow/ssh-approval-pagerduty/",
"destination": "/access-controls/access-request-plugins/ssh-approval-pagerduty/",
"permanent": true
},
{
"source": "/enterprise/workflow/ssh-approval-jira-server/",
"destination": "/access-controls/access-request-plugins/ssh-approval-jira/",
"permanent": true
},
{
"source": "/enterprise/workflow/ssh-approval-jira-cloud/",
"destination": "/access-controls/access-request-plugins/ssh-approval-jira/",
"permanent": true
},
{
"source": "/enterprise/workflow/ssh-approval-jira-cloud/",
"destination": "/access-controls/access-request-plugins/ssh-approval-jira/",
"permanent": true
},
{
"source": "/enterprise/workflow/ssh-approval-slack/",
"destination": "/access-controls/access-request-plugins/ssh-approval-slack/",
"permanent": true
},
{
"source": "/enterprise/workflow/resource-requests/",
"destination": "/access-controls/access-requests/resource-requests/",
"permanent": true
},
{
"source": "/enterprise/workflow/role-requests/",
"destination": "/access-controls/access-requests/role-requests/",
"permanent": true
},
{
"source": "/user-manual/",
"destination": "/",
"permanent": true
},
{
"source": "/enterprise/fedramp/",
"destination": "/access-controls/compliance-frameworks/fedramp/",
"permanent": true
},
{
"source": "/enterprise/soc2/",
"destination": "/access-controls/compliance-frameworks/soc2/",
"permanent": true
},
{
"source": "/enterprise/sso/",
"destination": "/access-controls/sso/",
"permanent": true
},
{
"source": "/enterprise/sso/adfs/",
"destination": "/access-controls/sso/adfs/",
"permanent": true
},
{
"source": "/enterprise/sso/azuread/",
"destination": "/access-controls/sso/azuread/",
"permanent": true
},
{
"source": "/setup/admin/github-sso/",
"destination": "/access-controls/sso/github-sso/",
"permanent": true
},
{
"source": "/enterprise/sso/gitlab/",
"destination": "/access-controls/sso/gitlab/",
"permanent": true
},
{
"source": "/enterprise/sso/google-workspace/",
"destination": "/access-controls/sso/google-workspace/",
"permanent": true
},
{
"source": "/enterprise/sso/oidc/",
"destination": "/access-controls/sso/oidc/",
"permanent": true
},
{
"source": "/enterprise/sso/okta/",
"destination": "/access-controls/sso/okta/",
"permanent": true
},
{
"source": "/enterprise/sso/one-login/",
"destination": "/access-controls/sso/one-login/",
"permanent": true
},
{
"source": "/database-access/guides/gui-clients/",
"destination": "/connect-your-client/gui-clients/",
"permanent": true
},
{
"source": "/use-teleport/teleport-connect/",
"destination": "/connect-your-client/teleport-connect/",
"permanent": true
},
{
"source": "/use-teleport/tsh/",
"destination": "/connect-your-client/tsh/",
"permanent": true
},
{
"source": "/setup/deployments/",
"destination": "/deploy-a-cluster/deployments/",
"permanent": true
},
{
"source": "/setup/deployments/aws-terraform/",
"destination": "/deploy-a-cluster/deployments/aws-ha-autoscale-cluster-terraform/",
"permanent": true
},
{
"source": "/setup/deployments/digitalocean/",
"destination": "/",
"permanent": true
},
{
"source": "/setup/deployments/gcp/",
"destination": "/deploy-a-cluster/deployments/gcp/",
"permanent": true
},
{
"source": "/setup/deployments/ibm/",
"destination": "/deploy-a-cluster/deployments/ibm/",
"permanent": true
},
{
"source": "/setup/helm-deployments/",
"destination": "/deploy-a-cluster/helm-deployments/",
"permanent": true
},
{
"source": "/setup/helm-deployments/aws/",
"destination": "/deploy-a-cluster/helm-deployments/aws/",
"permanent": true
},
{
"source": "/setup/helm-deployments/custom/",
"destination": "/deploy-a-cluster/helm-deployments/custom/",
"permanent": true
},
{
"source": "/setup/helm-deployments/digitalocean/",
"destination": "/deploy-a-cluster/helm-deployments/digitalocean/",
"permanent": true
},
{
"source": "/setup/helm-deployments/gcp/",
"destination": "/deploy-a-cluster/helm-deployments/gcp/",
"permanent": true
},
{
"source": "/getting-started/kubernetes-cluster/",
"destination": "/deploy-a-cluster/helm-deployments/kubernetes-cluster/",
"permanent": true
},
{
"source": "/setup/helm-deployments/migration/",
"destination": "/deploy-a-cluster/helm-deployments/migration-v12/",
"permanent": true
},
{
"source": "/getting-started/linux-server/",
"destination": "/",
"permanent": true
},
{
"source": "/cloud/architecture/",
"destination": "/choose-an-edition/teleport-cloud/architecture/",
"permanent": true
},
{
"source": "/cloud/downloads/",
"destination": "/choose-an-edition/teleport-cloud/downloads/",
"permanent": true
},
{
"source": "/cloud/faq/",
"destination": "/choose-an-edition/teleport-cloud/faq/",
"permanent": true
},
{
Expand All @@ -2053,7 +2348,7 @@
},
{
"source": "/cloud/introduction/",
"destination": "/choose-an-edition/teleport-cloud/introduction/",
"destination": "/choose-an-edition/teleport-cloud/",
"permanent": true
},
{
Expand Down Expand Up @@ -2313,7 +2608,7 @@
},
{
"source": "/deploy-a-cluster/teleport-cloud/introduction/",
"destination": "/choose-an-edition/teleport-cloud/introduction/",
"destination": "/choose-an-edition/teleport-cloud/",
"permanent": true
},
{
Expand Down Expand Up @@ -2416,11 +2711,6 @@
"destination": "/",
"permanent": true
},
{
"source": "/choose-an-edition/",
"destination": "/choose-an-edition/introduction/",
"permanent": true
},
{
"source": "/deploy-a-cluster/",
"destination": "/deploy-a-cluster/introduction/",
Expand Down Expand Up @@ -2538,7 +2828,7 @@
},
{
"source": "/choose-an-edition/teleport-cloud/",
"destination": "/choose-an-edition/teleport-cloud/introduction/",
"destination": "/choose-an-edition/teleport-cloud/",
"permanent": true
},
{
Expand Down
21 changes: 21 additions & 0 deletions docs/pages/agents.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Teleport Agents
description: How to use Teleport Agents, which enable users to connect to resources in your infrastructure.
---

{/*TOPICS*/}

- [Deploy Teleport Agents with Terraform](agents/deploy-agents-terraform.mdx): In this guide, we will show you how to deploy a pool of Teleport agents so you can apply dynamic resources to enroll your infrastructure with Teleport.
- [Introduction to Teleport Agents](agents/introduction.mdx): Deploy agents to enroll resources in your infrastructure with Teleport. You can run multiple Teleport services per agent."

## Join Agents to your Teleport Cluster

Methods you can use to established trust between a newly deployed Teleport agent and your Teleport cluster so you can protect resources. ([more info](agents/join-services-to-your-cluster.mdx))

- [Join Methods for Teleport Agents](agents/join-services-to-your-cluster/overview.mdx): An overview of the available methods for registering the Proxy Service, Database Service, and other Teleport services with your cluster.
- [Join Services with GCP](agents/join-services-to-your-cluster/gcp.mdx): Use the GCP join method to add services to your Teleport cluster.
- [Join Services with a Secure Token](agents/join-services-to-your-cluster/join-token.mdx): This guide shows you how to join a Teleport instance to your cluster using a join token in order to proxy access to resources in your infrastructure.
- [Joining Services via AWS EC2 Identity Document](agents/join-services-to-your-cluster/aws-ec2.mdx): Use the EC2 join method to add services to your Teleport cluster on AWS
- [Joining Services via AWS IAM Role](agents/join-services-to-your-cluster/aws-iam.mdx): Use the IAM join method to add services to your Teleport cluster on AWS
- [Joining Services via Azure Managed Identity](agents/join-services-to-your-cluster/azure.mdx): Use the Azure join method to join Teleport services to your Teleport cluster on Azure
- [Joining Services via Kubernetes ServiceAccount Token](agents/join-services-to-your-cluster/kubernetes.mdx): Use Kubernetes ServiceAccount tokens to join services running in the same Kubernetes cluster as the Auth Service.
Loading

0 comments on commit fe3fc86

Please sign in to comment.