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

[v15] [docs] update GCP Cloud SQL database guides #41995

Merged
merged 1 commit into from
May 24, 2024
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 modified docs/img/database-access/guides/cloudsql/[email protected]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/database-access/guides/cloudsql/[email protected]
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 not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/img/database-access/guides/cloudsql/[email protected]
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.
306 changes: 99 additions & 207 deletions docs/pages/database-access/guides/mysql-cloudsql.mdx

Large diffs are not rendered by default.

261 changes: 55 additions & 206 deletions docs/pages/database-access/guides/postgres-cloudsql.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,12 @@ videoBanner: br9LZ3ZXqCk
(!docs/pages/includes/database-access/how-it-works/iam.mdx db="PostgreSQL" cloud="Google Cloud"!)

<Tabs>
<TabItem scope={["oss", "enterprise"]} label="Self-Hosted">
![Teleport Database Access CloudSQL Self-Hosted](../../../img/database-access/guides/cloudsql_selfhosted.png)
<TabItem label="Self-Hosted">
![Self-Hosted Teleport Architecture for Cloud SQL Access](../../../img/database-access/guides/cloudsql_selfhosted.png)
</TabItem>
<TabItem scope={["cloud"]} label="Teleport Enterprise Cloud">
![Teleport Database Access CloudSQL Cloud](../../../img/database-access/guides/cloudsql_cloud.png)
<TabItem label="Cloud-Hosted">
![Cloud-Hosted Teleport Architecture for Cloud SQL Access](../../../img/database-access/guides/cloudsql_cloud.png)
</TabItem>

</Tabs>

## Prerequisites
Expand All @@ -30,26 +29,37 @@ videoBanner: br9LZ3ZXqCk
Service
- (!docs/pages/includes/tctl.mdx!)

## Step 1/7. Enable Cloud SQL IAM authentication
## Step 1/9. Create a service account for the Teleport Database Service

Teleport uses [IAM database authentication](https://cloud.google.com/sql/docs/postgres/authentication)
with Cloud SQL PostgreSQL instances.
(!docs/pages/includes/database-access/cloudsql-create-service-account-for-db-service.mdx!)

### (Optional) Grant permissions

(!docs/pages/includes/database-access/cloudsql_enable_iam_auth.mdx type="PostgreSQL" !)
(!docs/pages/includes/database-access/cloudsql_grant_db_service_account.mdx!)

## Step 2/7. Create a service account for a database user
## Step 2/9. Create a service account for a database user

Teleport uses service accounts to connect to Cloud SQL databases.

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

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

### Configure authentication for your service account
(!docs/pages/includes/database-access/cloudsql-grant-impersonation.mdx!)

## Step 3/9. Configure your Cloud SQL database

Teleport uses [IAM database authentication](https://cloud.google.com/sql/docs/postgres/authentication)
with Cloud SQL PostgreSQL instances.

(!docs/pages/includes/database-access/cloudsql_enable_iam_auth.mdx type="PostgreSQL"!)

### Create a database user

Now go back to the Users page of your Cloud SQL instance and add a new user
account. In the sidebar, choose "Cloud IAM" authentication type and add the
service account you've just created:
"cloudsql-user" service account that you created in
[the second step](#step-29-create-a-service-account-for-a-database-user):

![Add Cloud SQL User Account](../../../img/database-access/guides/cloudsql/[email protected])

Expand All @@ -60,202 +70,43 @@ Press "Add" and your Users table should look similar to this:
See [Creating and managing IAM users](https://cloud.google.com/sql/docs/postgres/create-manage-iam-users)
in Google Cloud documentation for more info.

## Step 3/7. Create a service account for the Teleport Database Service

The final part of GCP configuration is to create a service account for the
Teleport Database Service.

### Create a service account

Go to the [Service Accounts](https://console.cloud.google.com/iam-admin/serviceaccounts)
page and create a service account:

![Create Service Account](../../../img/database-access/guides/cloudsql/[email protected])

### Grant permissions
## Step 4/9. Install Teleport

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

<Admonition type="note" title="Service account permissions">
"Service Account Token Creator", "Cloud SQL Viewer", and "Cloud SQL Admin"
IAM roles include more permissions than the Database Service needs. To further
restrict the service account, you can create a role that includes only the
following permissions:
```ini
# Used to generate IAM auth tokens when connecting to a database instance.
iam.serviceAccounts.getAccessToken
# Used to auto-download the instance's root CA certificate.
cloudsql.instances.get
```
</Admonition>

### (Optional) Allow only SSL connections

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

### (Optional) Create a key for the service account

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

## Step 4/7. Gather Cloud SQL instance information

To connect a Cloud SQL database to Teleport, you'll need to gather a few pieces
of information about the instance.

- GCP Project ID.

You can normally see it in the organization view at the top of the GCP dashboard.

- Cloud SQL instance ID.

The instance ID is the name of your Cloud SQL instance shown at the top of the
Overview page:

![Instance ID](../../../img/database-access/guides/cloudsql/[email protected])
(!docs/pages/includes/install-linux.mdx!)

- Cloud SQL instance endpoint.
## Step 5/9. Configure the Teleport Database Service

You will use the instance's public IP address to connect to it. It can be viewed
on the "Connect to this instance" panel on the Overview page:
### Create a join token

![Instance Public IP](../../../img/database-access/guides/cloudsql/[email protected])
(!docs/pages/includes/database-access/token.mdx tokenFile="/tmp/token"!)

- (Optional) Cloud SQL instance root certificate.
### (Optional) Download the Cloud SQL CA certificate

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

## Step 5/7. Create a Teleport user
### Generate Teleport config

(!docs/pages/includes/database-access/create-user.mdx!)
(!docs/pages/includes/database-access/cloudsql-configure-create.mdx dbPort="5432" dbProtocol="postgres" token="/tmp/token"!)

## Step 6/7. Set up the Teleport Database Service
## Step 6/9. Configure GCP credentials

(!docs/pages/includes/database-access/token.mdx!)
(!docs/pages/includes/database-access/cloudsql_service_credentials.mdx serviceAccount="teleport-db-service"!)

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

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

Below is an example of a Database Service configuration file that proxies
a single Cloud SQL PostgreSQL database. Save this to `/etc/teleport.yaml`:

<Tabs>
<TabItem scope={["oss", "enterprise"]} label="Self-Hosted">

```yaml
version: v3
teleport:
data_dir: /var/lib/teleport
nodename: test
# Proxy address to connect to. Note that it has to be the proxy address
# because the Database Service always connects to the cluster over a reverse
# tunnel.
proxy_server: teleport.example.com:443
auth_token: "/tmp/token"
db_service:
enabled: "yes"
# This section contains definitions of all databases proxied by this
# service, can contain multiple items.
databases:
# Name of the database proxy instance, used to reference in CLI.
- name: "cloudsql"
# Free-form description of the database proxy instance.
description: "GCP Cloud SQL PostgreSQL"
# Database protocol.
protocol: "postgres"
# Database endpoint. For Cloud SQL use instance's public IP address.
uri: "35.1.2.3:5432"
# (Optional) path to Cloud SQL instance root certificate you downloaded
# manually above.
ca_cert_file: /path/to/cloudsql/instance/root.pem
# GCP specific configuration when connecting Cloud SQL instance.
gcp:
# GCP project ID.
project_id: "<project-id>"
# Cloud SQL instance ID.
instance_id: "test"
# Labels to assign to the database, used in RBAC.
static_labels:
env: dev
auth_service:
enabled: "no"
ssh_service:
enabled: "no"
proxy_service:
enabled: "no"
```

</TabItem>
<TabItem scope={["cloud"]} label="Teleport Enterprise Cloud">

```yaml
version: v3
teleport:
data_dir: /var/lib/teleport
nodename: test
# Proxy address to connect to. Use your Teleport Cloud tenant address here.
proxy_server: mytenant.teleport.sh:443
auth_token: "/tmp/token"
db_service:
enabled: "yes"
# This section contains definitions of all databases proxied by this
# service, can contain multiple items.
databases:
# Name of the database proxy instance, used to reference in CLI.
- name: "cloudsql"
# Free-form description of the database proxy instance.
description: "GCP Cloud SQL PostgreSQL"
# Database protocol.
protocol: "postgres"
# Database endpoint. For Cloud SQL use instance's public IP address.
uri: "35.1.2.3:5432"
# (Optional) path to Cloud SQL instance root certificate you downloaded
# manually above.
ca_cert_file: /path/to/cloudsql/instance/root.pem
# GCP specific configuration when connecting Cloud SQL instance.
gcp:
# GCP project ID.
project_id: "<project-id>"
# Cloud SQL instance ID.
instance_id: "test"
# Labels to assign to the database, used in RBAC.
static_labels:
env: dev
auth_service:
enabled: "no"
ssh_service:
enabled: "no"
proxy_service:
enabled: "no"
```

</TabItem>

</Tabs>

<Notice
type="tip"
>

A single Teleport process can run multiple different services, for example
multiple Database Services instances as well as other services such the SSH
Service or Application Service.

</Notice>
## Step 7/9. Start the Teleport Database Service

(!docs/pages/includes/start-teleport.mdx service="the Teleport Database Service"!)

### GCP credentials
## Step 8/9. Create a Teleport user

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

## Step 7/7. Connect
## Step 9/9. Connect

Once the Database Service has joined the cluster, log in to see the available
databases:

<Tabs>
<TabItem scope={["oss", "enterprise"]} label="Self-Hosted">
<TabItem label="Self-Hosted">

```code
$ tsh login --proxy=teleport.example.com --user=alice
Expand All @@ -266,7 +117,7 @@ $ tsh db ls
```

</TabItem>
<TabItem scope={["cloud"]} label="Teleport Enterprise Cloud">
<TabItem label="Teleport Enterprise (cloud-hosted)">

```code
$ tsh login --proxy=mytenant.teleport.sh --user=alice
Expand All @@ -280,39 +131,37 @@ $ tsh db ls

</Tabs>

Note that you will only be able to see databases your role has access to. See
our [RBAC](../rbac.mdx) guide for more details.

To retrieve credentials for a database and connect to it:

```code
$ tsh db connect --db-user=teleport@<project-id>.iam --db-name=postgres cloudsql
```

<Admonition
<Notice
type="note"
title="What database user name to use?"
>
You will only be able to see databases that your Teleport role has
access to. See our [RBAC](../rbac.mdx) guide for more details.
</Notice>

When connecting to the database, use the name of the database's service account
that you added as an IAM database user
[above](#step-27-create-a-service-account-for-a-database-user),
minus the `.gserviceaccount.com` suffix. The database user name is shown on
the Users page of your Cloud SQL instance.
When connecting to the database, use the name of the database's service account
that you added as an IAM database user
[above](#step-29-create-a-service-account-for-a-database-user),
minus the ".gserviceaccount.com" suffix. The database user name is shown on
the Users page of your Cloud SQL instance.
Retrieve credentials for the "cloudsql" example database and connect to it:

</Admonition>
```code
$ tsh db connect --db-user=cloudsql-user@<Var name="project-id"/>.iam --db-name=postgres cloudsql
```

To log out of the database and remove credentials:

```code
# Remove credentials for a particular database instance.
# Remove credentials for a particular database instance:
$ tsh db logout cloudsql
# Remove credentials for all database instances.
# Or remove credentials for all databases:
$ tsh db logout
```

## Troubleshooting

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

(!docs/pages/includes/database-access/pg-cancel-request-limitation.mdx!)

(!docs/pages/includes/database-access/psql-ssl-syscall-error.mdx!)
Expand Down
Loading
Loading