AWS Redshift PostgreSQL

Prerequisites

Collect a few pieces of information about your Redshift cluster which you'll need to configure access.

Get cluster identifier from the General information panel:

Copy cluster endpoint from the General information panel:

You'll only need the host:port portion of the endpoint.

Take note of database user name and database name you will use to connect.

If you haven't created any database users, default database admin user name and maintenance database are displayed on the Database configurations panel of the Properties tab:

Create IAM policy

Teleport uses IAM tokens to authenticate with Redshift databases. IAM authentication is enabled by default for all Redshift databases.

In order to authorize Teleport to generate temporary IAM tokens, create an IAM role with the following permissions:

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": "redshift:GetClusterCredentials",
            "Resource": [
                "arn:aws:redshift:*:1234567890:dbuser:*/*",
                "arn:aws:redshift:*:1234567890:dbname:*/*",
                "arn:aws:redshift:*:1234567890:dbgroup:*/*"
            ]
        },
        {
            "Effect": "Allow",
            "Action": "redshift:DescribeClusters",
            "Resource": "*"
        }
    ]
}

The DescribeClusters permission is required to allow Teleport to retrieve cluster ID, region and port.

The GetClusterCredentials permission controls access to generating IAM tokens. The resource ARN string has the following format:

arn:aws:redshift:<region>:<account-id>:<resource>:<cluster-id>/<name>

Parameters:

• region: AWS region where Redshift cluster is deployed, or a wildcard.
• account-id: AWS account ID the Redshift cluster is deployed in.
• resource: One of dbuser, dbname or dbgroup to restrict access to database accounts, names or groups respectively.
• cluster-id: Redshift cluster identifier, or a wildcard.
• name: Name of a particular database account, name or group (depending on the resource), or a wildcard.

See AWS documentation for more information about setting up an IAM role.

Setup Teleport Auth and Proxy services

Teleport Database Access for Redshift is available starting from 6.2 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

Start Teleport Auth and Proxy services:

$ sudo teleport start

Database agent requires a valid auth token to connect to the cluster. Generate one by running the following command against your Teleport auth server and save it in /tmp/token on the node which will be running the database agent:

$ tctl tokens add --type=db

Create user

Create a 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 database names and accounts are restricted to the user's db_names and 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 to the dev database as a awsuser 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:
  - awsuser
  # Database names the user will be allowed to connect to.
  db_names:
  - dev

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 Redshift 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: "redshift"
    # Free-form description of the database proxy instance.
    description: "AWS Redshift PostgreSQL"
    # Database protocol.
    protocol: "postgres"
    # Database endpoint.
    uri: "redshift-cluster-1.abcdefg.us-east-1.redshift.amazonaws.com:5439"
    # AWS specific configuration.
    aws:
      # Region the database is deployed in.
      region: "us-east-1"
      # Redshift specific configuration.
      redshift:
        # Redshift cluster identifier.
        cluster_id: "redshift-cluster-1"
    # 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"

Start the database service:

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

AWS credentials

Teleport Database Service must have an IAM role allowing it to generate IAM auth tokens which we created in the Create IAM Policy section above.

Teleport uses the default credential provider chain to find AWS credentials. See Specifying Credentials for more information.

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
-------- ----------------------- --------
redshift AWS Redshift PostgreSQL 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 redshift

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

tsh db login --db-user=awsuser --db-name=dev redshift

Once logged in, connect to the database:

tsh db connect aurora

To log out of the database and remove credentials:

Remove credentials for a particular database instance.
tsh db logout redshift
Remove credentials for all database instances.
tsh db logout