Fork me on GitHub
Teleport

Database Access with MySQL on GCP Cloud SQL

GCP Cloud SQL MySQL

Create service account for 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.

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

Create Service Account

Assign it the "Cloud SQL Admin" role:

Grant Cloud SQL Admin to Service Account
Service account permissions

The default "Cloud SQL Admin" IAM role includes more permissions than the database agent needs to generate one-time user passwords. To further restrict the service account, you can create a role that includes only the following permissions:

cloudsql.users.list
cloudsql.users.update

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

Service Account Keys

Make sure to choose JSON format:

Service Account New Key

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

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
  • 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:

Instance Public IP
  • 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:

Instance Root Certificate

Setup Teleport Auth and Proxy services

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

Download the latest version of Teleport for your platform from our downloads page and follow the installation instructions.

Teleport requires a valid TLS certificate to operate and can fetch one automatically using Let's Encrypt ACME protocol. We will assume that you have configured DNS records for teleport.example.com and *.teleport.example.com to point to the Teleport node.

Generate Teleport config with ACME enabled:

$ teleport configure --cluster-name=teleport.example.com --acme [email protected] -o file
Web Proxy Port
Teleport uses TLS-ALPN-01 ACME challenge to validate certificate requests which only works on port 443. As such, in order to use ACME for certificate management, web proxy needs to be accessible on port 443.

Start Teleport Auth and Proxy services:

$ sudo teleport start

Database service requires a valid auth token to connect to the cluster. Generate one and save it in /tmp/token:

$ tctl tokens add --type=db

Create user

Create local Teleport user with the built-in access role:

tctl users add --roles=access alice

The access role allows users to see all connected database servers, but allowed database users are restricted to the user's db_users traits. Normally, these traits come from the identity provider. For the local user you've just created you can update them manually to allow it to connect as a alice database user.

First, export the user resource:

tctl get users/alice > alice.yaml

Update the resource to include the following traits:

traits:
  # Database account names the user will be allowed to use.
  db_users:
  - alice

Update the user:

tctl create alice.yaml -f

For more detailed information about database access controls see RBAC documentation.

Setup Teleport Database service

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

teleport:
  data_dir: /var/lib/teleport-db
  nodename: test
  # Proxy address to connect to. Note that it has to be the proxy address
  # because database service always connects to the cluster over reverse
  # tunnel.
  auth_servers:
  - 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 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"
Tip
A single Teleport process can run multiple different services, for example multiple database access proxies as well as running other services such an SSH service or an application access proxy.

Start the database service:

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

GCP credentials

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

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

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

Connect

Once the database service has joined the cluster, login to see the available databases:

tsh login --proxy=teleport.example.com --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 RBAC section for more details.

To connect to a particular database server, first retrieve credentials from Teleport using tsh db login command:

tsh db login cloudsql
Tip
You can be logged into multiple databases simultaneously.

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

tsh db login --db-user=alice --db-name=mysql cloudsql

Once logged in, connect to the database:

tsh db connect cloudsql
Note
The mysql command-line client should be available in PATH in order to be able to connect.

If you would like to see the native mysql shell connect command, run:

tsh db config --format=cmd cloudsql

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
Have a suggestion or can’t find something?
IMPROVE THE DOCS