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

[v9] Include Teleport agent installation instructions for App,DB Guides #12313

Merged
merged 2 commits into from
Apr 29, 2022
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
Binary file added docs/img/application-access/grafana_cloud.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/database-access/guides/azure_cloud.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/database-access/guides/mongodb_cloud.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/database-access/guides/mysql_cloud.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/database-access/guides/rds_cloud.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/database-access/guides/redis_cloud.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 13 additions & 3 deletions docs/pages/application-access/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,15 @@ Let's connect to Grafana using Teleport Application Access in three steps:
- Install the Teleport Application Service on a node and configure it to proxy Grafana.
- Access Grafana through Teleport.

<ScopedBlock scope={["oss", "enterprise"]}>
![Teleport Application Access Grafana Self-Hosted](../../img/application-access/grafana_selfhosted.png)
</ScopedBlock>


<ScopedBlock scope={["cloud"]}>
![Teleport Database Access CockroachDB Cloud](../../img/application-access/grafana_cloud.png)
</ScopedBlock>

## Prerequisites

- The Teleport Auth Service and Proxy Service, deployed on your own infrastructure or via Teleport Cloud.
Expand Down Expand Up @@ -62,8 +71,9 @@ $ tctl tokens add \

### Start Teleport

On the host where you will run the Teleport Application Service, download the latest version of Teleport for your platform from our
[downloads page](https://goteleport.com/teleport/download).
Install Teleport on the host where you will run the Teleport Application Service. See our [Installation](../installation.mdx) page for options besides Linux servers.

(!docs/pages/includes/install-linux.mdx!)

Now start Teleport and point it to the application endpoint:

Expand Down Expand Up @@ -115,4 +125,4 @@ Dive deeper into the topics relevant to your Application Access use-case:
- Learn about integrating with [JWT tokens](./guides/jwt.mdx) for auth.
- Learn how to use Application Access with [RESTful APIs](./guides/api-access.mdx).
- See full configuration and CLI [reference](./reference.mdx).
- Read about how Let's Encrypt uses the [ACME protocol](https://letsencrypt.org/how-it-works/).
- Read about how Let's Encrypt uses the [ACME protocol](https://letsencrypt.org/how-it-works/).
4 changes: 4 additions & 0 deletions docs/pages/application-access/guides/connecting-apps.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,10 @@ $ tctl --config=/path/to/teleport.yaml users add --roles=access appuser

## Start application service with CLI flags

Install Teleport:

(!docs/pages/includes/install-linux.mdx!)

A Teleport Application Proxy agent can be started with a single CLI command:

```code
Expand Down
12 changes: 12 additions & 0 deletions docs/pages/database-access/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,15 @@ Here's an overview of what we will do:
2. Join the Aurora database to your Teleport cluster.
3. Connect to the Aurora database via the Teleport Database Service.

<ScopedBlock scope={["oss", "enterprise"]}>
![Teleport Database Access RDS Self-Hosted](../../img/database-access/guides/rds_selfhosted.png)
</ScopedBlock>


<ScopedBlock scope={["cloud"]}>
![Teleport Database Access RDS Cloud](../../img/database-access/guides/rds_cloud.png)
</ScopedBlock>

## Prerequisites

<Admonition type="note" title="Supported versions">
Expand Down Expand Up @@ -99,6 +108,9 @@ see the AWS [documentation](https://docs.aws.amazon.com/AmazonRDS/latest/UserGui

(!docs/pages/includes/database-access/token.mdx!)

Install Teleport on the host where you will run the Teleport Database Service:

(!docs/pages/includes/install-linux.mdx!)

<ScopedBlock scope={["oss", "enterprise"]}>

Expand Down
14 changes: 14 additions & 0 deletions docs/pages/database-access/guides/azure-postgres-mysql.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,15 @@ This guide will help you to:
- Set up access to Azure Database for PostgreSQL or Azure Database for MySQL.
- Connect to the database server through Teleport.

<ScopedBlock scope={["oss", "enterprise"]}>
![Teleport Database Access Azure PostgreSQL/MySQL Self-Hosted](../../../img/database-access/guides/azure_selfhosted.png)
</ScopedBlock>


<ScopedBlock scope={["cloud"]}>
![Teleport Database Access Azure PostgreSQL/MySQL Cloud](../../../img/database-access/guides/azure_cloud.png)
</ScopedBlock>

<Admonition type="note">
Teleport uses Azure Active Directory authentication with Azure PostgreSQL
and MySQL databases which at the moment of this writing is only supported
Expand Down Expand Up @@ -47,6 +56,11 @@ This guide will help you to:

(!docs/pages/includes/database-access/token.mdx!)

Install Teleport on the host where you will run the Teleport Database Service:

(!docs/pages/includes/install-linux.mdx!)


<ScopedBlock scope={["oss", "enterprise"]}>

Start the Teleport Database Service. Make sure to update `--auth-server` to point to
Expand Down
16 changes: 15 additions & 1 deletion docs/pages/database-access/guides/cockroachdb-self-hosted.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,15 @@ This guide will help you to:
2. Configure mutual TLS authentication between Teleport and your CockroachDB cluster.
3. Connect to your CockroachDB cluster via Teleport.

<ScopedBlock scope={["oss", "enterprise"]}>
![Teleport Database Access CockroachDB Self-Hosted](../../../img/database-access/guides/cockroachdb_selfhosted.png)
</ScopedBlock>


<ScopedBlock scope={["cloud"]}>
![Teleport Database Access CockroachDB Cloud](../../../img/database-access/guides/cockroachdb_cloud.png)
</ScopedBlock>

## Prerequisites

- CockroachDB cluster.
Expand All @@ -38,6 +47,11 @@ This guide will help you to:
### Set up the Teleport Database Service

(!docs/pages/includes/database-access/token.mdx!)

Install Teleport on the host where you will run the Teleport Database Service:

(!docs/pages/includes/install-linux.mdx!)

<Tabs>
<TabItem label="Self-Hosted" scope={["enterprise","oss"]}>
Start the Teleport Database Service, pointing the `--auth-server` flag to the address of your Teleport Proxy Service:
Expand Down Expand Up @@ -208,4 +222,4 @@ $ tsh db logout roach
## Next steps

(!docs/pages/includes/database-access/guides-next-steps.mdx!)
- [CockroachDB client authentication](https://www.cockroachlabs.com/docs/stable/authentication.html#client-authentication)
- [CockroachDB client authentication](https://www.cockroachlabs.com/docs/stable/authentication.html#client-authentication)
15 changes: 14 additions & 1 deletion docs/pages/database-access/guides/mongodb-atlas.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,15 @@ In this guide you will:
2. Configure self-managed X.509 authentication on your Atlas cluster.
3. Connect to your Atlas cluster via Teleport.

<ScopedBlock scope={["oss", "enterprise"]}>
![Teleport Database Access MongoDB Self-Hosted](../../../img/database-access/guides/mongodbatlas_selfhosted.png)
</ScopedBlock>


<ScopedBlock scope={["cloud"]}>
![Teleport Database Access MongoDB Cloud](../../../img/database-access/guides/mongodbatlas_cloud.png)
</ScopedBlock>

## Prerequisites

- [MongoDB Atlas](https://www.mongodb.com/cloud/atlas) cluster.
Expand All @@ -30,6 +39,10 @@ In this guide you will:

(!docs/pages/includes/database-access/token.mdx!)

Install Teleport on the host where you will run the Teleport Database Service:

(!docs/pages/includes/install-linux.mdx!)

Next, start the Database Service.

<ScopedBlock scope={["enterprise","oss"]}>
Expand Down Expand Up @@ -283,4 +296,4 @@ $ tsh db logout
(!docs/pages/includes/database-access/guides-next-steps.mdx!)

## Further reading
- [Which certificate authority signs MongoDB Atlas cluster TLS certificates?](https://docs.atlas.mongodb.com/reference/faq/security/#which-certificate-authority-signs-mongodb-atlas-cluster-tls-certificates-)
- [Which certificate authority signs MongoDB Atlas cluster TLS certificates?](https://docs.atlas.mongodb.com/reference/faq/security/#which-certificate-authority-signs-mongodb-atlas-cluster-tls-certificates-)
13 changes: 13 additions & 0 deletions docs/pages/database-access/guides/mongodb-self-hosted.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,15 @@ In this guide you will:
2. Configure mutual TLS authentication between Teleport and your MongoDB cluster.
3. Connect to your MongoDB instance via Teleport.

<ScopedBlock scope={["oss", "enterprise"]}>
![Teleport Database Access MongoDB Self-Hosted](../../../img/database-access/guides/mongodb_selfhosted.png)
</ScopedBlock>


<ScopedBlock scope={["cloud"]}>
![Teleport Database Access MongoDB Cloud](../../../img/database-access/guides/mongodb_cloud.png)
</ScopedBlock>

## Prerequisites

- MongoDB cluster (standalone or replica set) version `(=mongodb.min_version=)` or newer.
Expand Down Expand Up @@ -38,6 +47,10 @@ MongoDB instances.

(!docs/pages/includes/database-access/token.mdx!)

Install Teleport on the host where you will run the Teleport Database Service:

(!docs/pages/includes/install-linux.mdx!)

<ScopedBlock scope={["oss", "enterprise"]}>

Start the Teleport Database Service, pointing the `--auth-server` flag to the
Expand Down
20 changes: 18 additions & 2 deletions docs/pages/database-access/guides/mysql-cloudsql.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,20 @@ title: Database Access with MySQL on GCP Cloud SQL
description: How to configure Teleport Database Access with GCP Cloud SQL MySQL.
---

In this guide, we will show you how to use Teleport Database Access with MySQL
on Google Cloud SQL.
This guide will help you to:

- Install Teleport `(=teleport.version=)`.
- Set up Teleport to access your MySQL on Google Cloud SQL.
- Connect to your databases through Teleport.

<ScopedBlock scope={["oss", "enterprise"]}>
![Teleport Database Access CloudSQL Self-Hosted](../../../img/database-access/guides/cloudsql_selfhosted.png)
</ScopedBlock>


<ScopedBlock scope={["cloud"]}>
![Teleport Database Access CloudSQL Cloud](../../../img/database-access/guides/cloudsql_cloud.png)
</ScopedBlock>

## Prerequisites

Expand Down Expand Up @@ -108,6 +120,10 @@ Teleport Database Access for Cloud SQL MySQL is available starting from the

(!docs/pages/includes/database-access/token.mdx!)

Install Teleport on the host where you will run the Teleport Database Service:

(!docs/pages/includes/install-linux.mdx!)

### Create a user

(!docs/pages/includes/database-access/create-user.mdx!)
Expand Down
20 changes: 18 additions & 2 deletions docs/pages/database-access/guides/mysql-self-hosted.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,20 @@ title: Database Access with Self-Hosted MySQL/MariaDB
description: How to configure Teleport Database Access with self-hosted MySQL/MariaDB.
---

This guide will show you how to access a self-hosted MySQL or MariaDB database
using the Teleport Database Service.
This guide will help you to:

- Install Teleport `(=teleport.version=)`.
- Set up Teleport to access your MySQL or MariaDB database.
- Connect to your databases through Teleport.

<ScopedBlock scope={["oss", "enterprise"]}>
![Teleport Database Access MySQL Self-Hosted](../../../img/database-access/guides/mysql_selfhosted.png)
</ScopedBlock>


<ScopedBlock scope={["cloud"]}>
![Teleport Database Access MySQL Cloud](../../../img/database-access/guides/mysql_cloud.png)
</ScopedBlock>

## Prerequisites

Expand All @@ -25,6 +37,10 @@ Teleport Database Access for MySQL is available starting from Teleport version

(!docs/pages/includes/database-access/token.mdx!)

Install Teleport on the host where you will run the Teleport Database Service:

(!docs/pages/includes/install-linux.mdx!)

## Step 2/4. Create a certificate/key pair

(!docs/pages/includes/database-access/tctl-auth-sign.mdx!)
Expand Down
18 changes: 16 additions & 2 deletions docs/pages/database-access/guides/postgres-cloudsql.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,18 @@ description: How to configure Teleport Database Access with GCP Cloud SQL Postgr
videoBanner: br9LZ3ZXqCk
---

In this guide, we will show you how to use Teleport Database Access with PostgreSQL
on Google Cloud SQL.
This guide will help you to:

- Set up Teleport to access your PostgreSQL on Google Cloud SQL.
- Connect to your databases through Teleport.

<ScopedBlock scope={["oss", "enterprise"]}>
![Teleport Database Access CloudSQL Self-Hosted](../../../img/database-access/guides/cloudsql_selfhosted.png)
</ScopedBlock>

<ScopedBlock scope={["cloud"]}>
![Teleport Database Access CloudSQL Cloud](../../../img/database-access/guides/cloudsql_cloud.png)
</ScopedBlock>

## Prerequisites

Expand Down Expand Up @@ -178,6 +188,10 @@ the `6.2` Teleport release.

(!docs/pages/includes/database-access/token.mdx!)

Install Teleport on the host where you will run the Teleport Database Service:

(!docs/pages/includes/install-linux.mdx!)

### Create a user

(!docs/pages/includes/database-access/create-user.mdx!)
Expand Down
18 changes: 18 additions & 0 deletions docs/pages/database-access/guides/postgres-redshift.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,20 @@ description: How to configure Teleport Database Access with AWS Redshift Postgre
videoBanner: UFhT52d5bYg
---

This guide will help you to:

- Set up Teleport to access your AWS Redshift instances.
- Connect to your databases through Teleport.

<ScopedBlock scope={["oss", "enterprise"]}>
![Teleport Database Access Redshift Self-Hosted](../../../img/database-access/guides/redshift_selfhosted.png)
</ScopedBlock>


<ScopedBlock scope={["cloud"]}>
![Teleport Database Access Redshift Cloud](../../../img/database-access/guides/redshift_cloud.png)
</ScopedBlock>

## Prerequisites

- AWS account with a Redshift cluster and permissions to create and attach IAM
Expand All @@ -27,6 +41,10 @@ videoBanner: UFhT52d5bYg

(!docs/pages/includes/database-access/token.mdx!)

Install Teleport on the host where you will run the Teleport Database Service:

(!docs/pages/includes/install-linux.mdx!)

On the node that is running the Database Service, create a configuration file:

<ScopedBlock scope={["oss", "enterprise"]}>
Expand Down
19 changes: 17 additions & 2 deletions docs/pages/database-access/guides/postgres-self-hosted.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,19 @@ title: Database Access with Self-Hosted PostgreSQL
description: How to configure Teleport Database Access with self-hosted PostgreSQL.
---

This guide will show you how to access a self-hosted PostgreSQL database using
the Teleport Database Service.
This guide will help you to:

- Set up Teleport to access your self-hosted PostgreSQL.
- Connect to your databases through Teleport.

<ScopedBlock scope={["oss", "enterprise"]}>
![Teleport Database Access PostgreSQL Self-Hosted](../../../img/database-access/guides/postgresqlselfhosted_selfhosted.png)
</ScopedBlock>


<ScopedBlock scope={["cloud"]}>
![Teleport Database Access PostgreSQL Cloud](../../../img/database-access/guides/postgresqlselfhosted_cloud.png)
</ScopedBlock>

## Prerequisites

Expand All @@ -25,6 +36,10 @@ release.

(!docs/pages/includes/database-access/token.mdx!)

Install Teleport on the host where you will run the Teleport Database Service:

(!docs/pages/includes/install-linux.mdx!)

### Create a Teleport user

(!docs/pages/includes/database-access/create-user.mdx!)
Expand Down
12 changes: 12 additions & 0 deletions docs/pages/database-access/guides/rds.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,14 @@ This guide will help you to:
- Set up Teleport to access your RDS instances and Aurora clusters.
- Connect to your databases through Teleport.

<ScopedBlock scope={["oss", "enterprise"]}>
![Teleport Database Access RDS Self-Hosted](../../../img/database-access/guides/rds_selfhosted.png)
</ScopedBlock>

<ScopedBlock scope={["cloud"]}>
![Teleport Database Access RDS Cloud](../../../img/database-access/guides/rds_cloud.png)
</ScopedBlock>

<Admonition type="note" title="Supported versions">
The following products are not compatible with Database Access as they don't support IAM authentication:
- Aurora Serverless.
Expand Down Expand Up @@ -39,6 +47,10 @@ This guide will help you to:

(!docs/pages/includes/database-access/token.mdx!)

Install Teleport on the host where you will run the Teleport Database Service:

(!docs/pages/includes/install-linux.mdx!)

Create the Database Service configuration:

<ScopedBlock scope={["oss", "enterprise"]}>
Expand Down
Loading