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

Remove Auth/Proxy instructions from DB guides #20308

Merged
merged 3 commits into from
Feb 3, 2023
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
18 changes: 7 additions & 11 deletions docs/pages/database-access/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,16 @@ release.

</Admonition>

(!docs/pages/includes/edition-prereqs-tabs.mdx!)

- An AWS account with a PostgreSQL AWS Aurora database and permissions to create
and attach IAM policies.
- A host, e.g., an EC2 instance, where you will run the Teleport Database
Service.

(!docs/pages/includes/user-client-prereqs.mdx!)
(!docs/pages/includes/tctl.mdx!)

## Step 1/3. Set up Aurora
## Step 1/4. Set up Aurora

In order to allow Teleport connections to an Aurora instance, the instance needs
to support IAM authentication.
Expand Down Expand Up @@ -94,13 +96,7 @@ GRANT rds_iam TO alice;
For more information about connecting to the PostgreSQL instance directly,
see the AWS [documentation](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ConnectToPostgreSQLInstance.html).

## Step 2/3. Set up Teleport

### Start the Auth Service and Proxy Service

(!docs/pages/includes/database-access/start-auth-proxy.mdx!)

### Start the Teleport Database Service
## Step 2/4. Start the Teleport Database Service

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

Expand Down Expand Up @@ -153,7 +149,7 @@ $ teleport db start \
with the policy from [step 1](#step-13-set-up-aurora).
</Admonition>

### Create a user and role
## Step 3/4. Create a user and role

Create the role that will allow a user to connect to any database using any
database account:
Expand Down Expand Up @@ -181,7 +177,7 @@ Create the Teleport user assigned the `db` role we've just created:
$ tctl users add --roles=access,db alice
```

## Step 3/3. Connect
## Step 4/4. Connect

Now that Aurora is configured with IAM authentication, Teleport is running, and
the local user is created, we're ready to connect to the database.
Expand Down
13 changes: 4 additions & 9 deletions docs/pages/database-access/guides/aws-cassandra-keyspaces.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,20 +29,15 @@ This guide will help you to:

## Prerequisites

(!docs/pages/includes/edition-prereqs-tabs.mdx!)

- AWS Account with AWS Keyspaces database and permissions to create and attach IAM policies
- The `cqlsh` Cassandra client installed and added to your system's `PATH` environment variable.
- A host, e.g., an Amazon EC2 instance, where you will run the Teleport Database Service.

(!docs/pages/includes/user-client-prereqs.mdx!)


## Step 1/5. Install and configure Teleport

### Set up the Teleport Auth and Proxy Services

(!docs/pages/includes/database-access/start-auth-proxy.mdx!)
(!docs/pages/includes/tctl.mdx!)

### Set up the Teleport Database Service
## Step 1/5. Set up the Teleport Database Service

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

Expand Down
9 changes: 5 additions & 4 deletions docs/pages/database-access/guides/azure-postgres-mysql.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ to Azure PostgreSQL and MySQL servers.
## Prerequisites

(!docs/pages/includes/edition-prereqs-tabs.mdx!)

- Deployed Azure Database for PostgreSQL or MySQL server.
- Azure Active Directory administrative privileges.
- A host, e.g., an Azure VM instance, where you will run the Teleport Database
Expand Down Expand Up @@ -153,14 +154,14 @@ role 'azure-database-role.yaml' has been created

(\!docs/pages/includes/add-role-to-user.mdx role="azure-database-access" \!)

## Step 2/5. Configure Azure service principal
## Step 3/6. Configure Azure service principal

To authenticate with PostgreSQL or MySQL databases, Teleport Database Service
needs to obtain access tokens from Azure AD.

(!docs/pages/includes/database-access/azure-configure-service-principal.mdx!)

## Step 3/5. Configure IAM permissions for Teleport
## Step 4/6. Configure IAM permissions for Teleport

### Create a custom role

Expand Down Expand Up @@ -225,7 +226,7 @@ and replace the subscription in "assignableScopes" with your own subscription id

(!docs/pages/includes/database-access/azure-assign-service-principal.mdx!)

## Step 4/5. Create Azure database users
## Step 5/6. Create Azure database users

To let Teleport connect to your Azure database authenticating as a service
principal, you need to create Azure AD users authenticated by that principal in the database.
Expand Down Expand Up @@ -364,7 +365,7 @@ GRANT ALL ON `%`.* TO 'teleport'@'%';

You can create multiple database users identified by the same service principal.

## Step 5/5. Connect
## Step 6/6. Connect

Log in to your Teleport cluster. Your Azure database should appear in the list of
available databases:
Expand Down
18 changes: 8 additions & 10 deletions docs/pages/database-access/guides/azure-redis.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ This guide will help you to:

## Prerequisites

(!docs/pages/includes/edition-prereqs-tabs.mdx!)

- Deployed Azure Redis server or Azure Redis Enterprise cluster.
- Azure administrative privileges to manage service principals and access
controls.
Expand All @@ -27,17 +29,13 @@ This guide will help you to:
- `redis-cli` version `6.2` or newer installed and added to your system's
`PATH` environment variable.

(!docs/pages/includes/user-client-prereqs.mdx!)

## Step 1/6. Install Teleport

(!docs/pages/includes/database-access/start-auth-proxy.mdx!)
(!docs/pages/includes/tctl.mdx!)

## Step 2/6. Create a Teleport user
## Step 1/5. Create a Teleport user
alexfornuto marked this conversation as resolved.
Show resolved Hide resolved

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

## Step 3/6. Create a Database Service configuration
## Step 2/5. Create a Database Service configuration

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

Expand Down Expand Up @@ -78,7 +76,7 @@ addition to the region, you can optionally specify
further customize the scopes of the auto-discovery.
</Admonition>

## Step 4/6. Configure IAM permissions for Teleport
## Step 3/5. Configure IAM permissions for Teleport

The Teleport Database Service needs Azure IAM permissions to:

Expand Down Expand Up @@ -147,7 +145,7 @@ and replace the subscription in `assignableScopes` with your own subscription id

(!docs/pages/includes/database-access/azure-assign-service-principal.mdx!)

## Step 5/6. Start the Database Service
## Step 4/5. Start the Database Service

Once the service principal is configured with the required IAM permissions,
start the Teleport Database Service:
Expand All @@ -156,7 +154,7 @@ start the Teleport Database Service:
$ teleport start --config=/etc/teleport.yaml
```

## Step 6/6. Connect
## Step 5/5. Connect

Log in to your Teleport cluster. Your Azure Cache for Redis databases should
appear in the list of available databases:
Expand Down
24 changes: 11 additions & 13 deletions docs/pages/database-access/guides/azure-sql-server-ad.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,20 +34,18 @@ This guide will help you to:

## Prerequisites

(!docs/pages/includes/edition-prereqs-tabs.mdx!)

- SQL Server running on Azure.
- The Teleport Database Service running on an Azure virtual instance.

(!docs/pages/includes/user-client-prereqs.mdx!)

## Step 1/9. Set up the Teleport Auth and Proxy Services

(!docs/pages/includes/database-access/start-auth-proxy.mdx!)
(!docs/pages/includes/tctl.mdx!)

## Step 2/9. Create a Teleport user
## Step 1/8. Create a Teleport user
alexfornuto marked this conversation as resolved.
Show resolved Hide resolved

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

## Step 3/9. Enable the SQL Server Azure Active Directory integration
## Step 2/8. Enable the SQL Server Azure Active Directory integration

If you have it enabled, you can go to the next step.

Expand All @@ -62,7 +60,7 @@ login to SQL Server.

![Azure SQL Server Azure Active Directory admin page](../../../img/database-access/guides/sqlserver/azure-set-ad-admin.png)

## Step 4/9. Configure IAM permissions for Teleport
## Step 3/8. Configure IAM permissions for Teleport

The Teleport Database Service needs Azure IAM permissions to:
- Discover and register SQL Server instances.
Expand Down Expand Up @@ -123,7 +121,7 @@ with your own subscription id:

![Create JSON role](../../../img/database-access/guides/sqlserver/create-role-from-json.png)

## Step 5/9. Configure virtual machine identities
## Step 4/8. Configure virtual machine identities

In the Teleport Database Service virtual machine's **Identity**
section, enable the system assigned identity. This is used by Teleport to access
Expand Down Expand Up @@ -163,7 +161,7 @@ created:

![Azure Virtual machine user managed identities page](../../../img/database-access/guides/sqlserver/azure-attach-managed-identity-vm.png)

## Step 6/9. Enable managed identities login on SQL Server
## Step 5/8. Enable managed identities login on SQL Server

Azure AD SQL Server integration uses database-level authentication (contained
users), meaning we must create a user for our identities on each database we
Expand All @@ -186,7 +184,7 @@ the user as a member of the `db_datareader` role:
ALTER ROLE db_datareader ADD MEMBER [sqlserver-identity];
```

## Step 7/9. Create a Database Service configuration
## Step 6/8. Create a Database Service configuration

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

Expand Down Expand Up @@ -219,7 +217,7 @@ The command will generate a Database Service configuration with Azure SQL
Server auto-discovery enabled in the `eastus` region and place it at the
`/etc/teleport.yaml` location.

## Step 8/9. Start Teleport Database Service
## Step 7/8. Start Teleport Database Service

Start the Database Service:

Expand All @@ -236,7 +234,7 @@ $ teleport start --config=/etc/teleport.yaml
Service.
</Admonition>

## Step 9/9. Connect
## Step 8/8. Connect

Log in to your Teleport cluster. Your database should appear in the list of
available databases:
Expand Down
14 changes: 4 additions & 10 deletions docs/pages/database-access/guides/cassandra-self-hosted.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,20 +29,14 @@ This guide will help you to:

## Prerequisites

(!docs/pages/includes/edition-prereqs-tabs.mdx!)

- Self-hosted Cassandra or ScyllaDB instance.
- The `cqlsh` Cassandra client installed and added to your system's `PATH` environment variable.

(!docs/pages/includes/tctl.mdx!)

(!docs/pages/includes/user-client-prereqs.mdx!)


## Step 1/5. Install and configure Teleport

### Set up the Teleport Auth and Proxy Services

(!docs/pages/includes/database-access/start-auth-proxy.mdx!)

### Set up the Teleport Database Service
## Step 1/5. Set up the Teleport Database Service

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

Expand Down
18 changes: 7 additions & 11 deletions docs/pages/database-access/guides/cockroachdb-self-hosted.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,19 +29,15 @@ This guide will help you to:

## Prerequisites

(!docs/pages/includes/edition-prereqs-tabs.mdx!)

- CockroachDB cluster.
- A host, e.g., an Amazon EC2 instance, where you will run the Teleport Database
Service.

(!docs/pages/includes/user-client-prereqs.mdx!)

## Step 1/3. Install and configure Teleport

### Set up the Teleport Auth and Proxy Services

(!docs/pages/includes/database-access/start-auth-proxy.mdx!)
(!docs/pages/includes/tctl.mdx!)

### Set up the Teleport Database Service
## Step 1/4. Set up the Teleport Database Service

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

Expand Down Expand Up @@ -94,11 +90,11 @@ $ teleport db start \
See [YAML reference](../reference/configuration.mdx).
</Admonition>

### Create a Teleport user
## Step 2/4. Create a Teleport user

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

## Step 2/3. Configure CockroachDB
## Step 3/4. Configure CockroachDB

### Create a CockroachDB user

Expand Down Expand Up @@ -157,7 +153,7 @@ $ cockroach start \
# other flags...
```

## Step 3/3. Connect
## Step 4/4. Connect

Log in to your Teleport cluster. Your CockroachDB cluster should appear in the
list of available databases:
Expand Down
12 changes: 4 additions & 8 deletions docs/pages/database-access/guides/elastic.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ This guide will help you to configure secured access to an Elasticsearch databas

## Prerequisites

(!docs/pages/includes/edition-prereqs-tabs.mdx!)

- A self-hosted Elasticsearch database. Elastic Cloud [does not support client certificates](https://www.elastic.co/guide/en/cloud/current/ec-restrictions.html#ec-restrictions-security), which are required for setting up Database Access.

- A host where you will run the Teleport Database Service. If you are already running the Teleport
Expand All @@ -26,15 +28,9 @@ This guide will help you to configure secured access to an Elasticsearch databas

See [Installation](../../installation.mdx) for details.

(!docs/pages/includes/user-client-prereqs.mdx!)

## Step 1/5. Install and configure Teleport

### Set up the Teleport Auth and Proxy Services

(!docs/pages/includes/database-access/start-auth-proxy.mdx!)
(!docs/pages/includes/tctl.mdx!)

### Set up the Teleport Database Service
## Step 1/5. Set up the Teleport Database Service

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

Expand Down
Loading