Teleport
Database Access with Vitess (MySQL protocol)
- Version 16.x
- Version 15.x
- Version 14.x
- Version 13.x
- Older Versions
Teleport can provide secure access to Vitess via the Teleport Database Service. This allows for fine-grained access control through Teleport's RBAC.
In this guide, you will:
- Configure an Vitess database (MySQL protocol).
- Join the Vitess database to your Teleport cluster.
- Connect to the Vitess database via the Teleport Database Service.
How it works
The Teleport Database Service authenticates to your self-hosted Vitess database using mutual TLS. Vitess trusts the Teleport certificate authority for database clients, and presents a certificate signed by either the Teleport database CA or a custom CA. When a user initiates a database session, the Database Service presents a certificate signed by Teleport. The authenticated connection then proxies client traffic from the user.
Accessing Vitess using the gRPC protocol is not currently supported by Teleport.
Prerequisites
-
A running Teleport cluster version 15.2.4 or above. If you want to get started with Teleport, sign up for a free trial or set up a demo environment.
-
The
tctl
admin tool andtsh
client tool.On Teleport Enterprise, you must use the Enterprise version of
tctl
, which you can download from your Teleport account workspace. Otherwise, visit Installation for instructions on downloadingtctl
andtsh
for Teleport Community Edition.
- A self-hosted Vitess instance.
- A host, e.g., an Amazon EC2 instance, where you will run the Teleport Database Service.
- To check that you can connect to your Teleport cluster, sign in with
tsh login
, then verify that you can runtctl
commands using your current credentials.tctl
is supported on macOS and Linux machines. For example:If you can connect to the cluster and run thetsh login --proxy=teleport.example.com --user=[email protected]tctl statusCluster teleport.example.com
Version 15.2.4
CA pin sha256:abdc1245efgh5678abdc1245efgh5678abdc1245efgh5678abdc1245efgh5678
tctl status
command, you can use your current credentials to run subsequenttctl
commands from your workstation. If you host your own Teleport cluster, you can also runtctl
commands on the computer that hosts the Teleport Auth Service for full permissions.
Step 1/4. Create the Teleport Database Token
The Database Service requires a valid auth token to connect to the cluster. Generate
one by running the following command against your Teleport Auth Service and save
it in /tmp/token
on the node that will run the Database Service:
tctl tokens add --type=db
Step 2/4. Create a certificate/key pair
Teleport uses mutual TLS authentication with self-hosted databases. These databases must be configured with Teleport's certificate authority to be able to verify client certificates. They also need a certificate/key pair that Teleport can verify.
If you are using Teleport Cloud, your Teleport user must be allowed to
impersonate the system role Db
in order to be able to generate the database
certificate.
Include the following allow
rule in in your Teleport Cloud user's role:
allow:
impersonate:
users: ["Db"]
roles: ["Db"]
From your local workstation, create the secrets:
Export Teleport's certificate authority and generate certificate/key pair
for host db.example.com with a 3-month validity period.
tctl auth sign --format=db --host=db.example.com --out=server --ttl=2190h
In this example, db.example.com
is the hostname where the Teleport Database
Service can reach the Vitess server.
We recommend using a shorter TTL, but keep mind that you'll need to update the database server certificate before it expires to not lose the ability to connect. Pick the TTL value that best fits your use-case.
The command will create 3 files: server.cas
, server.crt
and server.key
which you'll need to enable mutual TLS.
Step 3/4. Configure Vitess
If you are running your Vitess cluster using a Vitess Operator for Kubernetes,
as a first step copy the contents of files server.cas
, server.crt
and server.key
into a secret containing the cluster configuration.
---
apiVersion: v1
kind: Secret
metadata:
name: example-cluster-config
type: Opaque
stringData:
server.cas: |
-----BEGIN CERTIFICATE-----
MIIDlDCCAnygAwIBAgIQcCge3zdTWnA7isWitaG5yzANBgkqhkiG9w0BAQsFADBk
...
jtOP8B0/0xc=
-----END CERTIFICATE-----
server.crt: |
-----BEGIN CERTIFICATE-----
MIIDqjCCApKgAwIBAgIRAKq0OQqYIx3pbkSVpIgMooowDQYJKoZIhvcNAQELBQAw
...
aRWuAdb7KYfHgZgC+k5jiFS9MYPbOc3qMK6KwGAU
-----END CERTIFICATE-----
server.key: |
-----BEGIN RSA PRIVATE KEY-----
MIIEpQIBAAKCAQEAsiejNWoNPPgcjjNZvG0pA+eADXxPyiGf6Or7oiy2ZmkblC4I
...
hr6KW+m+bBx0ABXrJVZ4dfv7ppP173vhavmSG3dvo2D5savAay6L/bE=
-----END RSA PRIVATE KEY-----
Next, update the gateway configuration:
- Add a new
extraFlags
section with a new entrymysql_auth_server_impl: clientcert
. - Add a new
secureTransport
section referencing the added files.
cells:
- name: zone1
gateway:
extraFlags:
mysql_auth_server_impl: clientcert
secureTransport:
required: true
tls:
clientCACertSecret:
name: teleport-cluster-config
key: server.cas
certSecret:
name: teleport-cluster-config
key: server.crt
keySecret:
name: teleport-cluster-config
key: server.key
If you are running your Vitess cluster using a custom deployment, you will need to update the flags for the vtgate
service. The following flags needs to be added:
vtgate ... \
--mysql_server_ssl_ca=/path/to/server.cas \
--mysql_server_ssl_cert=/path/to/server.crt \
--mysql_server_ssl_key=/path/to/server.key \
--mysql_auth_server_impl=clientcert
The files server.cas
, server.crt
and server.key
must be in a location
accessible by the vtgate
service.
For more details about vtgate
and Vitess configuration, please see the
documentation.
Create a Teleport user
To modify an existing user to provide access to the Database Service, see Database Access Access Controls
Create a local Teleport user with the built-in access
role:
tctl users add \ --roles=access \ --db-users=\* \ --db-names=\* \ alice
Create a local Teleport user with the built-in access
and requester
roles:
tctl users add \ --roles=access,requester \ --db-users=\* \ --db-names=\* \ alice
Flag | Description |
---|---|
--roles | List of roles to assign to the user. The builtin access role allows them to connect to any database server registered with Teleport. |
--db-users | List of database usernames the user will be allowed to use when connecting to the databases. A wildcard allows any user. |
--db-names | List of logical databases (aka schemas) the user will be allowed to connect to within a database server. A wildcard allows any database. |
Database names are only enforced for PostgreSQL and MongoDB databases.
For more detailed information about database access controls and how to restrict access see RBAC documentation.
Configure and Start the Database Service
Install and configure Teleport where you will run the Teleport Database Service:
Install Teleport on your Linux server:
-
Assign edition to one of the following, depending on your Teleport edition:
Edition Value Teleport Enterprise Cloud cloud
Teleport Enterprise (Self-Hosted) enterprise
Teleport Community Edition oss
-
Get the version of Teleport to install. If you have automatic agent updates enabled in your cluster, query the latest Teleport version that is compatible with the updater:
TELEPORT_DOMAIN=example.teleport.comTELEPORT_VERSION="$(curl https://$TELEPORT_DOMAIN/v1/webapi/automaticupgrades/channel/default/version | sed 's/v//')"Otherwise, get the version of your Teleport cluster:
TELEPORT_DOMAIN=example.teleport.comTELEPORT_VERSION="$(curl https://$TELEPORT_DOMAIN/v1/webapi/ping | jq -r '.server_version')" -
Install Teleport on your Linux server:
curl https://goteleport.com/static/install.sh | bash -s ${TELEPORT_VERSION} editionThe installation script detects the package manager on your Linux server and uses it to install Teleport binaries. To customize your installation, learn about the Teleport package repositories in the installation guide.
(!docs/pages/includes/database-access/db-configure-start.mdx dbName="example-vitess" dbProtocol="mysql" databaseAddress="db.example.com:3306" !)
Teleport provides Helm charts for installing the Teleport Database Service in Kubernetes Clusters.
Set up the Teleport Helm repository.
Allow Helm to install charts that are hosted in the Teleport Helm repository:
helm repo add teleport https://charts.releases.teleport.dev
Update the cache of charts from the remote repository so you can upgrade to all available releases:
helm repo update
(!docs/pages/includes/database-access/db-helm-install.mdx dbName="example-vitess" dbProtocol="mysql" databaseAddress="db.example.com:3306" !)
A single Teleport process can run multiple services, for example multiple Database Service instances as well as other services such the SSH Service or Application Service.
Step 4/4. Connect
Once the Database Service has joined the cluster, log in to see the available databases:
tsh login --proxy=teleport.example.com --user=alicetsh db lsName Description Labels
-------------- -------------- --------
example-vitess Example Vitess env=dev
tsh login --proxy=mytenant.teleport.sh --user=alicetsh db lsName Description Labels
-------------- -------------- --------
example-vitess Example Vitess env=dev
Note that you will only be able to see databases your role has access to. See the RBAC guide for more details.
To retrieve credentials for a database and connect to it:
tsh db connect example-vitess
You can optionally specify the database name and the user to use by default when connecting to the database instance:
tsh db connect --db-user=root --db-name=mysql example-vitess
The mysql
or mariadb
command-line client should be available in PATH
in
order to be able to connect. mariadb
is a default command-line client for
MySQL and MariaDB.
To log out of the database and remove credentials:
Remove credentials for a particular database instance.
tsh db logout example-vitessRemove credentials for all database instances.
tsh db logout