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.

Sign up for GitHub

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

Add Table of Contents pages to two sections #42488

Merged
merged 1 commit into from
Jun 5, 2024
Merged

Add Table of Contents pages to two sections #42488

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 0 additions & 10 deletions docs/config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2702,11 +2702,6 @@
"destination": "/",
"permanent": true
},
{
"source": "/deploy-a-cluster/",
"destination": "/deploy-a-cluster/introduction/",
"permanent": true
},
{
"source": "/management/",
"destination": "/management/introduction/",
Expand All @@ -2717,11 +2712,6 @@
"destination": "/connect-your-client/introduction/",
"permanent": true
},
{
"source": "/server-access/",
"destination": "/server-access/introduction/",
"permanent": true
},
{
"source": "/machine-id/",
"destination": "/machine-id/introduction/",
Expand Down
32 changes: 32 additions & 0 deletions docs/pages/deploy-a-cluster.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: Deploying a Self-Hosted Teleport Cluster
description: Guides for deploying self-hosted Teleport clusters on various platforms and cloud providers.
---

{/*TOPICS*/}
Copy link
Contributor

@hugoShaka hugoShaka Jun 5, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does this do? Do we have a reference of all the magic syntax we can use in our doc engine?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a table of contents page generator to the feature branch I'm using for docs reorganization (it's not in master). This ensures that we have a comprehensive set of TOC pages as I move docs around. Here's the README: https://github.com/gravitational/teleport/tree/paul.gottschling/2024-06-reorg/docs/gen-topic-pages

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll be more explicit that these PRs are for my feature branch, not master


- [Deploying a High Availability Teleport Cluster](deploy-a-cluster/high-availability.mdx): Deploying a High Availability Teleport Cluster
- [Running a Production Teleport Cluster](deploy-a-cluster/introduction.mdx): Guides to running Teleport in production.

## Guides for running Teleport using Helm

How to install and configure a self-hosted Teleport cluster on Kubernetes using Helm ([more info](deploy-a-cluster/helm-deployments.mdx))

- [Deploy Teleport on Kubernetes](deploy-a-cluster/helm-deployments/kubernetes-cluster.mdx): This guide shows you how to deploy Teleport on a Kubernetes cluster using Helm.
- [Get started with Teleport on DigitalOcean Kubernetes](deploy-a-cluster/helm-deployments/digitalocean.mdx): How to get started with Teleport on DigitalOcean Kubernetes
- [Kubernetes 1.25 and PSP removal](deploy-a-cluster/helm-deployments/migration-kubernetes-1-25-psp.mdx): How to prepare for the PodSecurityPolicy removal happening in Kubernetes 1.25
- [Migrating to teleport-cluster v12](deploy-a-cluster/helm-deployments/migration-v12.mdx): How to upgrade to teleport-cluster Helm chart version 12
- [Running Teleport with a Custom Configuration using Helm](deploy-a-cluster/helm-deployments/custom.mdx): Install and configure a Teleport cluster with a custom configuration using Helm
- [Running an HA Teleport cluster using AWS, EKS, and Helm](deploy-a-cluster/helm-deployments/aws.mdx): Install and configure an HA Teleport cluster using an AWS EKS cluster
- [Running an HA Teleport cluster using GCP, GKE, and Helm](deploy-a-cluster/helm-deployments/gcp.mdx): Install and configure an HA Teleport cluster using a Google Cloud GKE cluster.
- [Running an HA Teleport cluster using Microsoft Azure, AKS, and Helm](deploy-a-cluster/helm-deployments/azure.mdx): Install and configure an HA Teleport cluster using a Microsoft Azure AKS cluster.

## Reference Deployment Guides

How to deploy a self-hosted Teleport cluster on different cloud providers. ([more info](deploy-a-cluster/deployments.mdx))

- [AWS Multi-Region Proxy Deployment](deploy-a-cluster/deployments/aws-gslb-proxy-peering-ha-deployment.mdx): Deploying a high-availability Teleport cluster using Proxy Peering and Route 53 to create global server load balancing.
- [Running Teleport on GCP](deploy-a-cluster/deployments/gcp.mdx): How to install and configure Teleport on GCP
- [Running Teleport on IBM Cloud](deploy-a-cluster/deployments/ibm.mdx): How to install and configure Gravitational Teleport on IBM cloud for SSH and Kubernetes access.
- [Teleport High Availability mode on AWS](deploy-a-cluster/deployments/aws-ha-autoscale-cluster-terraform.mdx): How to configure Teleport in High Availability mode for AWS deployments.
- [Teleport Single-Instance Deployment on AWS](deploy-a-cluster/deployments/aws-starter-cluster-terraform.mdx): How to quickly configure Teleport on a single instance for testing in AWS.

Check failure on line 32 in docs/pages/deploy-a-cluster.mdx

View workflow job for this annotation

GitHub Actions / Lint docs prose style 

[vale] reported by reviewdog 🐶
[messaging.subjective-terms] Avoid using 'quickly' as a qualifier, since it is subject to interpretation. Use more technically precise terms instead.

Raw Output:
{"message": "[messaging.subjective-terms] Avoid using 'quickly' as a qualifier, since it is subject to interpretation. Use more technically precise terms instead.", "location": {"path": "docs/pages/deploy-a-cluster.mdx", "range": {"start": {"line": 32, "column": 120}}}, "severity": "ERROR"}
19 changes: 8 additions & 11 deletions docs/pages/deploy-a-cluster/deployments.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,16 @@
---
title: Reference Deployment Guides
description: Teleport Installation and Configuration Reference Deployment Guides.
description: How to deploy a self-hosted Teleport cluster on different cloud providers.
layout: tocless-doc
---

These guides show you how to set up a full self-hosted Teleport deployment on
the platform of your choice.

- [AWS High Availability Deployment with Terraform](./deployments/aws-ha-autoscale-cluster-terraform.mdx): Deploy HA Teleport with
Terraform on AWS.
- [AWS Single-Instance Deployment with Terraform](./deployments/aws-starter-cluster-terraform.mdx): Deploy Teleport on a single instance with
Terraform on AWS.
- [AWS Multi-Region Proxy
Deployment](./deployments/aws-gslb-proxy-peering-ha-deployment.mdx): Deploy HA
Teleport with Proxy Service instances in multiple regions for low-latency
access.
- [GCP](./deployments/gcp.mdx): Deploy HA Teleport on GCP.
- [IBM Cloud](./deployments/ibm.mdx): Deploy HA Teleport on IBM cloud.
{/*TOPICS*/}

- [AWS Multi-Region Proxy Deployment](deployments/aws-gslb-proxy-peering-ha-deployment.mdx): Deploying a high-availability Teleport cluster using Proxy Peering and Route 53 to create global server load balancing.
- [Running Teleport on GCP](deployments/gcp.mdx): How to install and configure Teleport on GCP
- [Running Teleport on IBM Cloud](deployments/ibm.mdx): How to install and configure Gravitational Teleport on IBM cloud for SSH and Kubernetes access.
- [Teleport High Availability mode on AWS](deployments/aws-ha-autoscale-cluster-terraform.mdx): How to configure Teleport in High Availability mode for AWS deployments.
- [Teleport Single-Instance Deployment on AWS](deployments/aws-starter-cluster-terraform.mdx): How to quickly configure Teleport on a single instance for testing in AWS.

Check failure on line 16 in docs/pages/deploy-a-cluster/deployments.mdx

View workflow job for this annotation

GitHub Actions / Lint docs prose style 

[vale] reported by reviewdog 🐶
[messaging.subjective-terms] Avoid using 'quickly' as a qualifier, since it is subject to interpretation. Use more technically precise terms instead.

Raw Output:
{"message": "[messaging.subjective-terms] Avoid using 'quickly' as a qualifier, since it is subject to interpretation. Use more technically precise terms instead.", "location": {"path": "docs/pages/deploy-a-cluster/deployments.mdx", "range": {"start": {"line": 16, "column": 103}}}, "severity": "ERROR"}
29 changes: 10 additions & 19 deletions docs/pages/deploy-a-cluster/helm-deployments.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Guides for running Teleport using Helm
description: How to install and configure Teleport in Kubernetes using Helm
description: How to install and configure a self-hosted Teleport cluster on Kubernetes using Helm
layout: tocless-doc
---

Expand All @@ -17,22 +17,13 @@ Kubernetes Service on a Linux server. For instructions on enrolling a Kubernetes
cluster with Teleport, read the [Kubernetes
Access](../kubernetes-access/introduction.mdx) documentation.

## Helm deployment guides
{/*TOPICS*/}

These guides show you how to set up a full self-hosted Teleport deployment using
our `teleport-cluster` Helm chart.

- [Deploy Teleport on Kubernetes](./helm-deployments/kubernetes-cluster.mdx): Run a Teleport cluster in a Kubernetes cluster using
the default configuration. This deployment is a great starting point to try a self-hosted
Teleport with minimal resources.
- [HA AWS Teleport Cluster](./helm-deployments/aws.mdx): Running an HA Teleport cluster in Kubernetes using an AWS EKS Cluster
- [HA Azure Teleport Cluster](./helm-deployments/azure.mdx): Running an HA Teleport cluster in Kubernetes using an Azure AKS Cluster
- [HA GCP Teleport Cluster](./helm-deployments/gcp.mdx): Running an HA Teleport cluster in Kubernetes using a Google Cloud GKE Cluster
- [DigitalOcean Kubernetes Cluster](./helm-deployments/digitalocean.mdx):
Running Teleport on DigitalOcean Kubernetes.
- [Custom Teleport config](./helm-deployments/custom.mdx): Running a Teleport cluster in Kubernetes with a custom Teleport config

## Migration Guides

- [Migrating from v11 to v12](./helm-deployments/migration-v12.mdx)
- [Kubernetes 1.25 and PSP removal](./helm-deployments/migration-kubernetes-1-25-psp.mdx)
- [Deploy Teleport on Kubernetes](helm-deployments/kubernetes-cluster.mdx): This guide shows you how to deploy Teleport on a Kubernetes cluster using Helm.
- [Get started with Teleport on DigitalOcean Kubernetes](helm-deployments/digitalocean.mdx): How to get started with Teleport on DigitalOcean Kubernetes
- [Kubernetes 1.25 and PSP removal](helm-deployments/migration-kubernetes-1-25-psp.mdx): How to prepare for the PodSecurityPolicy removal happening in Kubernetes 1.25
- [Migrating to teleport-cluster v12](helm-deployments/migration-v12.mdx): How to upgrade to teleport-cluster Helm chart version 12
- [Running Teleport with a Custom Configuration using Helm](helm-deployments/custom.mdx): Install and configure a Teleport cluster with a custom configuration using Helm
- [Running an HA Teleport cluster using AWS, EKS, and Helm](helm-deployments/aws.mdx): Install and configure an HA Teleport cluster using an AWS EKS cluster
- [Running an HA Teleport cluster using GCP, GKE, and Helm](helm-deployments/gcp.mdx): Install and configure an HA Teleport cluster using a Google Cloud GKE cluster.
- [Running an HA Teleport cluster using Microsoft Azure, AKS, and Helm](helm-deployments/azure.mdx): Install and configure an HA Teleport cluster using a Microsoft Azure AKS cluster.
31 changes: 31 additions & 0 deletions docs/pages/server-access.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: Protect Linux Servers with Teleport
description: How to enroll Linux servers in your Teleport cluster to enable secure SSH access.
---

{/*TOPICS*/}

- [Access Controls for Servers](server-access/rbac.mdx): Role-based access control (RBAC) for Teleport server access.
- [Server Access Getting Started Guide](server-access/getting-started.mdx): Getting started with Teleport server access.

Check failure on line 9 in docs/pages/server-access.mdx

View workflow job for this annotation

GitHub Actions / Lint docs prose style 

[vale] reported by reviewdog 🐶
[messaging.protocol-products] Avoid the impression that Teleport consists of multiple products for secure access, e.g., "Database Access" or "Server Access". Instead, talk about enrolling resources in your Teleport cluster, protecting resources with Teleport, or the ability for Teleport to proxy various protocols.

Raw Output:
{"message": "[messaging.protocol-products] Avoid the impression that Teleport consists of multiple products for secure access, e.g., \"Database Access\" or \"Server Access\". Instead, talk about enrolling resources in your Teleport cluster, protecting resources with Teleport, or the ability for Teleport to proxy various protocols.", "location": {"path": "docs/pages/server-access.mdx", "range": {"start": {"line": 9, "column": 4}}}, "severity": "ERROR"}
- [Teleport Server Access Features and Introduction](server-access/introduction.mdx): Teleport server access features and introduction.

Check failure on line 10 in docs/pages/server-access.mdx

View workflow job for this annotation

GitHub Actions / Lint docs prose style 

[vale] reported by reviewdog 🐶
[messaging.protocol-products] Avoid the impression that Teleport consists of multiple products for secure access, e.g., "Database Access" or "Server Access". Instead, talk about enrolling resources in your Teleport cluster, protecting resources with Teleport, or the ability for Teleport to proxy various protocols.

Raw Output:
{"message": "[messaging.protocol-products] Avoid the impression that Teleport consists of multiple products for secure access, e.g., \"Database Access\" or \"Server Access\". Instead, talk about enrolling resources in your Teleport cluster, protecting resources with Teleport, or the ability for Teleport to proxy various protocols.", "location": {"path": "docs/pages/server-access.mdx", "range": {"start": {"line": 10, "column": 13}}}, "severity": "ERROR"}
- [Troubleshooting Server Access](server-access/troubleshooting-server.mdx): Describes common issues and solutions for access to servers.

Check failure on line 11 in docs/pages/server-access.mdx

View workflow job for this annotation

GitHub Actions / Lint docs prose style 

[vale] reported by reviewdog 🐶
[messaging.protocol-products] Avoid the impression that Teleport consists of multiple products for secure access, e.g., "Database Access" or "Server Access". Instead, talk about enrolling resources in your Teleport cluster, protecting resources with Teleport, or the ability for Teleport to proxy various protocols.

Raw Output:
{"message": "[messaging.protocol-products] Avoid the impression that Teleport consists of multiple products for secure access, e.g., \"Database Access\" or \"Server Access\". Instead, talk about enrolling resources in your Teleport cluster, protecting resources with Teleport, or the ability for Teleport to proxy various protocols.", "location": {"path": "docs/pages/server-access.mdx", "range": {"start": {"line": 11, "column": 20}}}, "severity": "ERROR"}

## OpenSSH Guides

Teleport Agentless OpenSSH integration guides. ([more info](server-access/openssh.mdx))

- [Using Teleport with OpenSSH in agentless mode (manual installation)](server-access/openssh/openssh-manual-install.mdx): This guide shows you how to set up Teleport to enable secure access to OpenSSH servers so you can protect legacy systems that do not run a Teleport binary.
- [Using Teleport with OpenSSH in agentless mode](server-access/openssh/openssh.mdx): This guide shows you how to set up Teleport in agentless mode to enable secure access to OpenSSH servers so you can protect systems that do not run a Teleport binary.

## Protect SSH Servers with Teleport

Guides to enrolling SSH servers in your Teleport cluster with the Teleport SSH Service. ([more info](server-access/guides.mdx))

- [Ansible](server-access/guides/ansible.mdx): Using Teleport with Ansible
- [Configure SSH with Pluggable Authentication Modules](server-access/guides/ssh-pam.mdx): How to configure Teleport SSH with PAM (Pluggable Authentication Modules).
- [Configure SSH with the Linux Auditing System](server-access/guides/auditd.mdx): How to configure Teleport SSH with auditd (Linux Auditing System).
- [Configure Teleport to Create Host Users](server-access/guides/host-user-creation.mdx): How to configure Teleport to automatically create transient host users.
- [Enhanced Session Recording for SSH with BPF](server-access/guides/bpf-session-recording.mdx): How to record your SSH session commands using BPF.
- [JetBrains SFTP](server-access/guides/jetbrains-sftp.mdx): How to use a JetBrains IDE to manipulate files on a remote host with Teleport
- [Teleport Recording Proxy Mode](server-access/guides/recording-proxy-mode.mdx): Use Recording Proxy Mode to capture OpenSSH server activity
- [Visual Studio Code](server-access/guides/vscode.mdx): How to use Visual Studio Code's Remote Development plugin with Teleport
26 changes: 12 additions & 14 deletions docs/pages/server-access/guides.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,16 @@
---
title: Server Access Guides
description: Teleport server access guides.
title: Protect SSH Servers with Teleport
description: Guides to enrolling SSH servers in your Teleport cluster with the Teleport SSH Service.
layout: tocless-doc
---

- [Using Teleport with PAM](./guides/ssh-pam.mdx): How to configure Teleport SSH with PAM (Pluggable Authentication Modules).
- [Agentless OpenSSH Integration](./openssh/openssh.mdx): How to use Teleport in agentless mode on systems with OpenSSH and `sshd`.
- [Agentless OpenSSH Integration (Manual Installation)](./openssh/openssh-manual-install.mdx): How to use Teleport in agentless mode
on systems with OpenSSH and `sshd` that can't run `teleport`.
- [Recording Proxy Mode](./guides/recording-proxy-mode.mdx): How to use Teleport Recording Proxy Mode to capture activity on OpenSSH servers.
- [BPF Session Recording](./guides/bpf-session-recording.mdx): How to use BPF to record SSH session commands, modified files and network connections.
- [Visual Studio Code](./guides/vscode.mdx): How to remotely develop with Visual Studio Code and Teleport.
- [JetBrains SFTP](./guides/jetbrains-sftp.mdx): How to use a JetBrains IDE to access SFTP with Teleport.
- [Host User Creation](./guides/host-user-creation.mdx): How to configure Teleport to automatically create transient host users.
- [Linux Auditing System](./guides/auditd.mdx): How to integrate Teleport with the Linux Auditing System (auditd).
- [Using Teleport with Ansible](./guides/ansible.mdx): How to use Ansible with
Teleport-issued SSH credentials.
{/*TOPICS*/}

- [Ansible](guides/ansible.mdx): Using Teleport with Ansible
- [Configure SSH with Pluggable Authentication Modules](guides/ssh-pam.mdx): How to configure Teleport SSH with PAM (Pluggable Authentication Modules).
- [Configure SSH with the Linux Auditing System](guides/auditd.mdx): How to configure Teleport SSH with auditd (Linux Auditing System).
- [Configure Teleport to Create Host Users](guides/host-user-creation.mdx): How to configure Teleport to automatically create transient host users.
- [Enhanced Session Recording for SSH with BPF](guides/bpf-session-recording.mdx): How to record your SSH session commands using BPF.
- [JetBrains SFTP](guides/jetbrains-sftp.mdx): How to use a JetBrains IDE to manipulate files on a remote host with Teleport
- [Teleport Recording Proxy Mode](guides/recording-proxy-mode.mdx): Use Recording Proxy Mode to capture OpenSSH server activity
- [Visual Studio Code](guides/vscode.mdx): How to use Visual Studio Code's Remote Development plugin with Teleport
7 changes: 4 additions & 3 deletions docs/pages/server-access/openssh.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: Teleport Agentless OpenSSH integration guides.
layout: tocless-doc
---

- [Agentless OpenSSH Integration](./openssh/openssh.mdx): How to use Teleport in agentless mode on systems with OpenSSH and `sshd`.
- [Agentless OpenSSH Integration (Manual Installation)](./openssh/openssh-manual-install.mdx): How to use Teleport in agentless mode
on systems with OpenSSH and `sshd` that can't run `teleport`.
{/*TOPICS*/}

- [Using Teleport with OpenSSH in agentless mode (manual installation)](openssh/openssh-manual-install.mdx): This guide shows you how to set up Teleport to enable secure access to OpenSSH servers so you can protect legacy systems that do not run a Teleport binary.
- [Using Teleport with OpenSSH in agentless mode](openssh/openssh.mdx): This guide shows you how to set up Teleport in agentless mode to enable secure access to OpenSSH servers so you can protect systems that do not run a Teleport binary.
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "teleport-ui",
"version": "1.0.0",
"scripts": {
"all-topics": "node docs/gen-topic-pages/index.js --in docs/pages/database-access,docs/pages/access-controls,docs/pages/desktop-access,docs/pages/kubernetes-access,docs/pages/connect-your-client,docs/pages/agents,docs/pages/auto-discovery,docs/pages/architecture,docs/pages/api,docs/pages/choose-an-edition",
"all-topics": "node docs/gen-topic-pages/index.js --in docs/pages/database-access,docs/pages/access-controls,docs/pages/desktop-access,docs/pages/kubernetes-access,docs/pages/connect-your-client,docs/pages/agents,docs/pages/auto-discovery,docs/pages/architecture,docs/pages/api,docs/pages/choose-an-edition,docs/pages/server-access,docs/pages/deploy-a-cluster",
"build-ui": "yarn build-ui-oss && yarn build-ui-e",
"build-ui-oss": "yarn workspace @gravitational/teleport build",
"build-ui-e": "yarn workspace @gravitational/teleport.e build",
Expand Down
Loading