diff --git a/docs/config.json b/docs/config.json index 870668dcb61d4..0c5f40ef41023 100644 --- a/docs/config.json +++ b/docs/config.json @@ -65,10 +65,23 @@ { "title": "Deployments", "slug": "/setup/deployments/", + "hideInScopes": "cloud", "entries": [ - { "title": "AWS Terraform", "slug": "/setup/deployments/aws-terraform/" }, - { "title": "GCP", "slug": "/setup/deployments/gcp/" }, - { "title": "IBM", "slug": "/setup/deployments/ibm/" } + { + "title": "AWS Terraform", + "slug": "/setup/deployments/aws-terraform/", + "hideInScopes": "cloud" + }, + { + "title": "GCP", + "slug": "/setup/deployments/gcp/", + "hideInScopes": "cloud" + }, + { + "title": "IBM", + "slug": "/setup/deployments/ibm/", + "hideInScopes": "cloud" + } ] }, { @@ -77,7 +90,8 @@ "entries": [ { "title": "Scaling", - "slug": "/setup/operations/scaling/" + "slug": "/setup/operations/scaling/", + "hideInScopes": "cloud" }, { "title": "Upgrading a Cluster", @@ -108,11 +122,35 @@ "title": "Integrations", "slug": "/setup/guides/", "entries": [ - { "title": "Terraform Provider", "slug": "/setup/guides/terraform-provider/" }, - { "title": "Docker", "slug": "/setup/guides/docker/" }, - { "title": "Fluentd", "slug": "/setup/guides/fluentd/" }, - { "title": "EC2 Tags", "slug": "/setup/guides/ec2-tags/" }, - { "title": "Joining Nodes in AWS", "slug": "/setup/guides/joining-nodes-aws/" } + { + "title": "Terraform Provider", + "slug": "/setup/guides/terraform-provider/" + }, + { + "title": "Docker", + "slug": "/setup/guides/docker/" + }, + { + "title": "Fluentd", + "slug": "/setup/guides/fluentd/" + }, + { + "title": "EC2 Tags", + "slug": "/setup/guides/ec2-tags/" + }, + { + "title": "Joining Nodes via AWS IAM", + "slug": "/setup/guides/joining-nodes-aws-iam/" + }, + { + "title": "Joining Nodes via AWS EC2", + "slug": "/setup/guides/joining-nodes-aws-ec2/", + "hideInScopes": "cloud" + }, + { + "title": "Using Teleport's CA with GitHub", + "slug": "/setup/guides/ssh-key-extensions/" + } ] }, { @@ -149,7 +187,8 @@ }, { "title": "Storage Backends", - "slug": "/setup/reference/backends/" + "slug": "/setup/reference/backends/", + "hideInScopes": "cloud" }, { "title": "Networking", diff --git a/docs/pages/setup/deployments.mdx b/docs/pages/setup/deployments.mdx index c400d4be4e070..d23e6a49228f7 100644 --- a/docs/pages/setup/deployments.mdx +++ b/docs/pages/setup/deployments.mdx @@ -4,6 +4,29 @@ description: Teleport Installation and Configuration Reference Deployment Guides layout: tocless-doc --- +These guides show you how to set up a full self-hosted Teleport deployment on +the platform of your choice. + + + + + View our deployment guides as an Open Source Teleport user. + + + View our deployment guides as a Teleport Enterprise user. + + + + + + diff --git a/docs/pages/setup/deployments/aws-terraform.mdx b/docs/pages/setup/deployments/aws-terraform.mdx index a61c287421cf8..6ed9b81f68ba4 100644 --- a/docs/pages/setup/deployments/aws-terraform.mdx +++ b/docs/pages/setup/deployments/aws-terraform.mdx @@ -5,14 +5,56 @@ h1: Running Teleport Enterprise in High Availability mode on AWS --- This guide is designed to accompany our [reference Terraform code](https://github.com/gravitational/teleport/tree/master/examples/aws/terraform/ha-autoscale-cluster#terraform-based-provisioning-example-amazon-single-ami) -and describe how to use and administrate the resulting Teleport deployment. +and describe how to manage the resulting Teleport deployment. -
-Our reference Terraform code deploys self-hosted instances of the Teleport Auth Service and Proxy Service. Since Teleport Cloud manages these services for you, users interested in Terraform should consult the following guides instead of this one: + -- To get started with Teleport and Terraform: [Terraform Provider](../guides/terraform-provider.mdx) -- For a full reference: [Terraform Provider Resources](../reference/terraform-provider.mdx) -
+Our reference Terraform code deploys self-hosted instances of the Teleport Auth +Service and Proxy Service. Since Teleport Cloud manages these services for you, +users interested in Terraform should consult the following guides instead of +this one: + + + + +Read our guide to using Teleport and Terraform + + + + +Read our Terraform provider reference + + + + +You can also view this guide as a user of another Teleport edition: + + + + + + + + + + + ## Prerequisites @@ -841,3 +883,5 @@ $ ./connect.sh proxy 1 # connect to the node $ ./connect.sh node ``` + + \ No newline at end of file diff --git a/docs/pages/setup/deployments/gcp.mdx b/docs/pages/setup/deployments/gcp.mdx index 950a7a0911c39..57f6908c666ff 100644 --- a/docs/pages/setup/deployments/gcp.mdx +++ b/docs/pages/setup/deployments/gcp.mdx @@ -3,17 +3,35 @@ title: Running Teleport on GCP description: How to install and configure Gravitational Teleport on GCP for SSH and Kubernetes access. --- -We've created this guide to give customers a high level overview of how to use Teleport -on [Google Cloud](https://cloud.google.com/gcp/) (GCP). This guide provides a high level -introduction leading to a deep dive into how to setup and run Teleport in production. +We've created this guide to give customers an overview of how to use Teleport on +[Google Cloud](https://cloud.google.com/gcp/) (GCP). This guide provides a +high-level introduction to setting up and running Teleport in production. - + This guide shows you how to deploy the Auth Service and Proxy Service, which -Teleport Cloud manages for you. You can read this guide if you are interested in -learning about self-hosting Teleport on Google Cloud. +Teleport Cloud manages for you. - +You can view this guide as a user of another Teleport edition: + + + + + + + + + + + We have split this guide into: @@ -221,3 +239,5 @@ proxy_service: **4. Add Users** Follow [adding users](../../enterprise/getting-started.mdx#adding-users) or integrate with [Google Workspace](../../enterprise/sso/google-workspace.mdx) to provide SSO access. + + \ No newline at end of file diff --git a/docs/pages/setup/deployments/ibm.mdx b/docs/pages/setup/deployments/ibm.mdx index d4fb484577f43..d6a4e81d93252 100644 --- a/docs/pages/setup/deployments/ibm.mdx +++ b/docs/pages/setup/deployments/ibm.mdx @@ -3,17 +3,35 @@ title: Running Teleport on IBM Cloud description: How to install and configure Gravitational Teleport on IBM cloud for SSH and Kubernetes access. --- -We've created this guide to give customers a high level overview of how to use Teleport -on the [IBM Cloud](https://www.ibm.com/cloud). This guide provides a high level -introduction leading to a deep dive into how to setup and run Teleport in production. +We've created this guide to give customers an overview of how to use Teleport on +[IBM Cloud](https://www.ibm.com/cloud). This guide provides a high-level +introduction to setting up and running Teleport in production. - + This guide shows you how to deploy the Auth Service and Proxy Service, which -Teleport Cloud manages for you. You can read this guide if you are interested in -learning about self-hosting Teleport on IBM Cloud. +Teleport Cloud manages for you. - +You can view this guide as a user of another Teleport edition: + + + + + + + + + + + We have split this guide into: @@ -198,3 +216,5 @@ the Teleport Proxy public address. # (see public_addr section below) public_addr: proxy.example.com:3080 ``` + + \ No newline at end of file diff --git a/docs/pages/setup/guides.mdx b/docs/pages/setup/guides.mdx index 84b47c20288d7..6d6909c3b3d70 100644 --- a/docs/pages/setup/guides.mdx +++ b/docs/pages/setup/guides.mdx @@ -4,20 +4,9 @@ description: Teleport Installation and Configuration Guides. layout: tocless-doc --- - + - [Terraform Provider](./guides/terraform-provider.mdx). How to configure Teleport Cloud, Open Source, and Enterprise with the Terraform Provider for Teleport. + - [Docker](./guides/docker.mdx). Getting started with Teleport Open Source using Docker. + - [Fluentd Event Forwarder](./guides/fluentd.mdx). Forwarding events with Fluentd and the Teleport Events Handler. + - [EC2 tags as Teleport Nodes](./guides/ec2-tags.mdx). How to set up Teleport Node labels based on EC2 tags. + - [Joining Nodes via AWS IAM Role](./guides/joining-nodes-aws-iam.mdx). Use the IAM join method to add Nodes to your Teleport cluster on AWS. + - [Using Teleport's Certificate Authority with GitHub](./guides/ssh-key-extensions.mdx). Use Teleport's short-lived certificates with GitHub's Certificate Authority. diff --git a/docs/pages/setup/operations.mdx b/docs/pages/setup/operations.mdx index 98ba32ce96a7c..10da9c79cac00 100644 --- a/docs/pages/setup/operations.mdx +++ b/docs/pages/setup/operations.mdx @@ -11,9 +11,11 @@ For guides on the fundamentals of setting up your cluster, you should consult the [Cluster Administration Guides](./admin.mdx) section. - - How to configure Teleport for large-scale deployments. - + + + How to configure Teleport for large-scale deployments. + + Learn about how to upgrade your Teleport cluster while ensuring that components remain compatible. @@ -23,7 +25,9 @@ the [Cluster Administration Guides](./admin.mdx) section. Rotating Teleport certificate authorities. - - Migrating your Teleport cluster to single-port TLS routing mode. - + + + Migrating your Teleport cluster to single-port TLS routing mode. + + diff --git a/docs/pages/setup/operations/scaling.mdx b/docs/pages/setup/operations/scaling.mdx index 42dc7871d2c9e..291fc4c004662 100644 --- a/docs/pages/setup/operations/scaling.mdx +++ b/docs/pages/setup/operations/scaling.mdx @@ -3,9 +3,35 @@ title: Scaling description: How to configure Teleport for large-scale deployments --- -This section covers recommended configurations for large-scale +This section explains the recommended configuration settings for large-scale deployments of Teleport. + + +For Teleport Cloud customers, the settings in this guide are configured +automatically. + +You can view this guide as a user of another Teleport edition: + + + + + + + + + + + + ## Prerequisites - Teleport v(=teleport.version=) Open Source or Enterprise. @@ -68,3 +94,5 @@ $ cat /proc/$(pidof teleport)/limits # Limit Soft Limit Hard Limit Units # Max open files 65536 65536 files ``` + + \ No newline at end of file diff --git a/docs/pages/setup/reference.mdx b/docs/pages/setup/reference.mdx index ca2cac031f593..fb742a576ef8b 100644 --- a/docs/pages/setup/reference.mdx +++ b/docs/pages/setup/reference.mdx @@ -26,9 +26,11 @@ layout: tocless-doc
  • [Authentication](./reference/authentication.mdx). Cluster authentication options.
    • +
  • [Backends](./reference/backends.mdx). Supported storage backends.
    • +
  • [Networking](./reference/networking.mdx). Ports, protocols and networking requirements.
    • diff --git a/docs/pages/setup/reference/backends.mdx b/docs/pages/setup/reference/backends.mdx index 5e234160d069a..eb99206339569 100644 --- a/docs/pages/setup/reference/backends.mdx +++ b/docs/pages/setup/reference/backends.mdx @@ -8,12 +8,31 @@ default everything is stored in a local directory at the Auth server. Integration with other storage types is implemented based on the nature of the stored data (size, read/write ratio, mutability, etc.). - + Teleport Cloud manages Auth Service and Proxy Service data for you, so there is no need to configure a backend. - +You can view this guide as a user of another Teleport edition: + + + + + + + + + + + | Data type | Description | Supported storage backends | | - | - | - | @@ -622,3 +641,4 @@ teleport: bucket, i.e.both `audit_xxx` settings must be present. If they are not set, Teleport will default to a local file system for the audit log, i.e. `/var/lib/teleport/log` on an auth server. +