mysql-cloudsql.mdx

title	description
Database Access with MySQL on GCP Cloud SQL	How to configure Teleport Database Access with GCP Cloud SQL MySQL.

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"]}> <ScopedBlock scope={["cloud"]}>

Prerequisites

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

Teleport Database Access for Cloud SQL MySQL is available starting from the 7.0 release.

• Google Cloud account
• A host, e.g., a Compute Engine instance, where you will run the Teleport Database Service

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

Step 1/5. Create a service account for the Teleport Database Service

Teleport uses one-time passwords to authenticate with Cloud SQL MySQL. To be able to authenticate with a database instance, Teleport must run as a service account that has a few of the "Cloud SQL Admin" role permissions. You can create a new service account or modify an existing one to add required permissions.

Create a service account

If creating a new service account, go to the Service Accounts page and create another service account:

Grant permissions

Assign the Service Account the "Cloud SQL Admin" role:

The default "Cloud SQL Admin" IAM role includes more permissions than the Database Service needs to generate one-time user passwords. To further restrict the service account, you can create a role that includes only the following permissions: ```ini # Used to download a list of database users. cloudsql.users.list # Used to update a user with a one-time password. cloudsql.users.update # Used to auto-download the instance's root CA certificate. cloudsql.instances.get # Used to generate an ephemeral client certificate when the GCP instance # is configured to "Allow only SSL connections." (optional) cloudsql.sslCerts.createEphemeral ```

Create a key for the service account

Once created, go to that service account's Keys tab and create a new key:

Make sure to choose JSON format:

Save the file. Your Teleport Database Service will need to use it as GCP application credentials file.

Step 2/5. 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:

• Cloud SQL instance endpoint.

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:

• Cloud SQL instance root certificate.

The instance's root certificate is required so Teleport can validate the certificate presented by the database instance. You can download server-ca.pem file from the Connections tab under Security section:

Step 3/5. 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!)

Create a user

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

Step 4/5. Set up the Teleport Database service

Below is an example of a database service configuration file that proxies a single Cloud SQL MySQL database:

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

version: v3
teleport:
  data_dir: /var/lib/teleport-db
  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:3080
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 MySQL"
    # Database protocol.
    protocol: "mysql"
    # Database endpoint. For Cloud SQL use instance's public IP address.
    uri: "35.1.2.3:3306"
    # Path to Cloud SQL instance root certificate you downloaded above.
    ca_cert_file: /path/to/cloudsql/instance/root.pem
    # GCP-specific configuration when connecting a 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"

version: v3
teleport:
  data_dir: /var/lib/teleport-db
  nodename: test
  # Proxy address to connect to. Use your Teleport Cloud tenant address.
  proxy_server: mytenant.teleport.sh:443
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 MySQL"
    # Database protocol.
    protocol: "mysql"
    # Database endpoint. For Cloud SQL use instance's public IP address.
    uri: "35.1.2.3:3306"
    # Path to Cloud SQL instance root certificate you downloaded above.
    ca_cert_file: /path/to/cloudsql/instance/root.pem
    # GCP-specific configuration when connecting a 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"

<Admonition type="tip" title="Tip"

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

Start the Database Service:

$ teleport start --config=/path/to/teleport-db.yaml --token=/tmp/token

GCP credentials

The Teleport Database Service must have the credentials of teleport-db-service GCP service account we created above in order to be able to log in.

The easiest way to ensure that is to set the GOOGLE_APPLICATION_CREDENTIALS environment variable to point to the JSON credentials file you downloaded earlier.

See Authenticating as a service account in the Google Cloud documentation for more details.

Step 5/5. Connect

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

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

$ tsh login --proxy=teleport.example.com --user=alice
$ tsh db ls
# Name     Description         Labels
# -------- ------------------- --------
# cloudsql GCP Cloud SQL MySQL env=dev

$ tsh login --proxy=mytenant.teleport.sh --user=alice
$ tsh db ls
# Name     Description         Labels
# -------- ------------------- --------
# cloudsql GCP Cloud SQL MySQL env=dev

Note that you will only be able to see databases your role has access to. See our RBAC guide for more details.

To retrieve credentials for a database and connect to it:

$ tsh db connect cloudsql

You can optionally specify the database user and database name to use by default when connecting to the database instance:

$ tsh db connect --db-user=alice --db-name=mysql cloudsql

The `mysql` command-line client should be available in PATH in order to be able to connect.

To log out of the database and remove credentials:

# Remove credentials for a particular database instance.
$ tsh db logout cloudsql
# Remove credentials for all database instances.
$ tsh db logout