# Database Access with Amazon Redshift Teleport can provide secure access to Amazon Redshift via the [Teleport Database Service](https://goteleport.com/docs/enroll-resources/database-access.md). This allows for fine-grained access control through [Teleport's RBAC](https://goteleport.com/docs/enroll-resources/database-access/rbac.md). In this guide, you will: 1. Configure your Amazon Redshift database with IAM authentication. 2. Add the database to your Teleport cluster. 3. Connect to the database via Teleport. ## How it works The Teleport Database Service uses IAM authentication to communicate with Amazon Redshift. When a user connects to the database via Teleport, the Teleport Database Service obtains AWS credentials and authenticates to AWS as an IAM principal with permissions to access the database. **Self-Hosted** ![Enroll Redshift with a self-hosted Teleport cluster](/docs/assets/images/redshift_selfhosted-582a68f6d3d5e58783369b45533208c6.png) **Teleport Enterprise Cloud** ![Enroll Redshift with a cloud-hosted Teleport cluster](/docs/assets/images/redshift_cloud-59c6b5e443a2266fd77127c4715eb043.png) This guide shows how to register a single Amazon Redshift cluster with your Teleport cluster. For a more scalable approach, learn how to set up [Database Auto-Discovery](https://goteleport.com/docs/enroll-resources/auto-discovery/databases.md) to automatically enroll all AWS databases in your infrastructure. ## Prerequisites - A running Teleport cluster. If you want to get started with Teleport, [sign up](https://goteleport.com/signup) for a free trial or [set up a demo environment](https://goteleport.com/docs/get-started/deploy-community.md). - The `tctl` and `tsh` clients. Installing `tctl` and `tsh` clients 1. Determine the version of your Teleport cluster. The `tctl` and `tsh` clients must be at most one major version behind your Teleport cluster version. Send a GET request to the Proxy Service at `/v1/webapi/find` and use a JSON query tool to obtain your cluster version. Replace teleport.example.com:443 with the web address of your Teleport Proxy Service: ``` $ TELEPORT_DOMAIN=teleport.example.com:443 $ TELEPORT_VERSION="$(curl -s https://$TELEPORT_DOMAIN/v1/webapi/find | jq -r '.server_version')" ``` 2. Follow the instructions for your platform to install `tctl` and `tsh` clients: **Mac** Download the signed macOS .pkg installer for Teleport, which includes the `tctl` and `tsh` clients: ``` $ curl -O https://cdn.teleport.dev/teleport-${TELEPORT_VERSION?}.pkg ``` In Finder double-click the `pkg` file to begin installation. --- DANGER Using Homebrew to install Teleport is not supported. The Teleport package in Homebrew is not maintained by Teleport and we can't guarantee its reliability or security. --- **Windows - Powershell** ``` $ curl.exe -O https://cdn.teleport.dev/teleport-v${TELEPORT_VERSION?}-windows-amd64-bin.zip Unzip the archive and move the `tctl` and `tsh` clients to your %PATH% NOTE: Do not place the `tctl` and `tsh` clients in the System32 directory, as this can cause issues when using WinSCP. Use %SystemRoot% (C:\Windows) or %USERPROFILE% (C:\Users\) instead. ``` **Linux** All of the Teleport binaries in Linux installations include the `tctl` and `tsh` clients. For more options (including RPM/DEB packages and downloads for i386/ARM/ARM64) see our [installation page](https://goteleport.com/docs/installation.md). ``` $ curl -O https://cdn.teleport.dev/teleport-v${TELEPORT_VERSION?}-linux-amd64-bin.tar.gz $ tar -xzf teleport-v${TELEPORT_VERSION?}-linux-amd64-bin.tar.gz $ cd teleport $ sudo ./install Teleport binaries have been copied to /usr/local/bin ``` * AWS account with a Redshift cluster and permissions to create and attach IAM policies. * Command-line client `psql` installed and added to your system's `PATH` environment variable. * A host, e.g., an 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 run `tctl` commands using your current credentials. For example, run the following command, assigning teleport.example.com to the domain name of the Teleport Proxy Service in your cluster and email\@example.com to your Teleport username: ``` $ tsh login --proxy=teleport.example.com --user=email@example.com $ tctl status Cluster teleport.example.com Version 19.0.0-dev CA pin sha256:abdc1245efgh5678abdc1245efgh5678abdc1245efgh5678abdc1245efgh5678 ``` If you can connect to the cluster and run the `tctl status` command, you can use your current credentials to run subsequent `tctl` commands from your workstation. If you host your own Teleport cluster, you can also run `tctl` commands on the computer that hosts the Teleport Auth Service for full permissions. ## Step 1/5. Create a Teleport user --- TIP To modify an existing user to provide access to the Database Service, see [Database Access Controls](https://goteleport.com/docs/enroll-resources/database-access/rbac.md) --- **Teleport Community Edition** Create a local Teleport user with the built-in `access` role: ``` $ tctl users add \ --roles=access \ --db-users="*" \ --db-names="*" \ alice ``` **Teleport Enterprise/Enterprise Cloud** 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. | --- WARNING Database names are only enforced for PostgreSQL, MongoDB, and Cloud Spanner databases. --- For more detailed information about database access controls and how to restrict access see [RBAC](https://goteleport.com/docs/enroll-resources/database-access/rbac.md) documentation. ## Step 2/5. Create a Database Service configuration The Database Service requires a valid join token to join your Teleport cluster. Run the following `tctl` command and save the token output in `/tmp/token` on the server that will run the Database Service: ``` $ tctl tokens add --type=db --format=text abcd123-insecure-do-not-use-this ``` Alternative methods For users with a lot of infrastructure in AWS, or who might create or recreate many instances, consider alternative methods for joining new EC2 instances running Teleport: - [Configure Teleport to Automatically Enroll EC2 instances](https://goteleport.com/docs/enroll-resources/auto-discovery/servers/ec2-discovery.md) - [Joining Teleport Services via AWS IAM Role](https://goteleport.com/docs/enroll-resources/agents/aws-iam.md) - [Joining Teleport Services via AWS EC2 Identity Document](https://goteleport.com/docs/enroll-resources/agents/aws-ec2.md) To install a Teleport Agent on your Linux server: The recommended installation method is the cluster install script. It will select the correct version, edition, and installation mode for your cluster. 1. Assign teleport.example.com:443 to your Teleport cluster hostname and port, but not the scheme (https\://). 2. Run your cluster's install script: ``` $ curl "https://teleport.example.com:443/scripts/install.sh" | sudo bash ``` On the node that is running the Database Service, create a configuration file. Assign `CLUSTER_URI` to the domain name and port of the cluster: **Self-Hosted** ``` $ sudo teleport db configure create \ -o file \ --name="redshift-postgres" \ --proxy=teleport.example.com:443 \ --protocol=postgres \ --token=/tmp/token \ --uri=${CLUSTER_URI?} ``` **Teleport Enterprise Cloud** ``` $ sudo teleport db configure create \ -o file \ --name="redshift-postgres" \ --proxy=mytenant.teleport.sh:443 \ --protocol=postgres \ --token=/tmp/token \ --uri=${CLUSTER_URI?} ``` The command will generate a Database Service configuration to proxy your AWS Redshift cluster place it at the `/etc/teleport.yaml` location. ## Step 3/5. Configure IAM permissions for the Database Service The Teleport Database Service needs AWS IAM permissions to provide access to Redshift databases. ### Create an IAM role for Teleport Grant the Database Service access to credentials that it can use to authenticate to AWS. - If you are running the Database Service on an EC2 instance, you may use the EC2 Instance Metadata Service method - If you are running the Database Service in Kubernetes, you can use IAM Roles for Service Accounts (IRSA) - Otherwise, you must use environment variables **Instance Metadata Service** Teleport will detect when it is running on an EC2 instance and use the Instance Metadata Service to fetch credentials. The EC2 instance should be configured to use an EC2 instance profile. For more information, see: [Using Instance Profiles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html). **Kubernetes IRSA** Refer to [IAM Roles for Service Accounts (IRSA)](https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html) to set up an OIDC provider in AWS and configure an AWS IAM role that allows the pod's service account to assume the role. **Environment Variables** Teleport's built-in AWS client reads credentials from the following environment variables: - `AWS_ACCESS_KEY_ID` - `AWS_SECRET_ACCESS_KEY` - `AWS_DEFAULT_REGION` When you start the Database Service, the service reads environment variables from a file at the path `/etc/default/teleport`. Obtain these credentials from your organization. Ensure that `/etc/default/teleport` has the following content, replacing the values of each variable: ``` AWS_ACCESS_KEY_ID=00000000000000000000 AWS_SECRET_ACCESS_KEY=0000000000000000000000000000000000000000 AWS_DEFAULT_REGION= ``` Have multiple sources of AWS credentials? Teleport's AWS client loads credentials from different sources in the following order: - Environment Variables - Shared credentials file - Shared configuration file (Teleport always enables shared configuration) - EC2 Instance Metadata (credentials only) While you can provide AWS credentials via a shared credentials file or shared configuration file, you will need to run the Database Service with the `AWS_PROFILE` environment variable assigned to the name of your profile of choice. If you have a specific use case that the instructions above do not account for, consult the documentation for the [AWS SDK for Go](https://docs.aws.amazon.com/sdk-for-go/api/aws/session/) for a detailed description of credential loading behavior. ### Grant permissions Attach the following AWS IAM permissions to the Database Service IAM role: Assign aws-account-id to your AWS account ID: ``` { "Version": "2012-10-17", "Statement": [ { "Sid": "RedshiftConnectAsDBUser", "Effect": "Allow", "Action": "redshift:GetClusterCredentials", "Resource": "*" }, { "Sid": "RedshiftConnectAsIAMRole", "Effect": "Allow", "Action": "sts:AssumeRole", "Resource": [ "arn:aws:iam::aws-account-id:role/redshift-user-role" ] }, { "Sid": "RedshiftFetchMetadata", "Effect": "Allow", "Action": "redshift:DescribeClusters", "Resource": "*" } ] } ``` | Statement | Purpose | | -------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | `RedshiftConnectAsDBUser` | Connect to a database as an existing database user. | | `RedshiftConnectAsIAMRole` | Assume an IAM role to connect to a database with permissions mapped into the database 1:1 from the role's IAM permissions. | | `RedshiftFetchMetadata` | Automatically import AWS tags as database labels or find missing information such as the database's AWS region. | You can reduce the scope of the `RedshiftConnectAsDBUser` statement by updating it to only allow specific users, databases, and database groups. The resource ARN you can specify has the following formats: ``` arn:aws:redshift:{Region}:{AccountID}:dbuser:{ClusterName}/{UserName} arn:aws:redshift:{Region}:{AccountID}:dbname:{ClusterName}/{DatabaseName} arn:aws:redshift:{Region}:{AccountID}:dbgroup:{ClusterName}/{DatabaseGroupName} ``` See [Create an IAM role or user with permissions to call GetClusterCredentials](https://docs.aws.amazon.com/redshift/latest/mgmt/generating-iam-credentials-role-permissions.html) for more information about the `redshift:GetClusterCredentials` permission grant syntax. You can authenticate as an existing database user or as an IAM role that will be automatically mapped into the database. The corresponding IAM statement is only required for the method(s) you want to use. If an IAM role names the Database Service's identity as a trusted principal, and both identities are in the same AWS account, then the `RedshiftConnectAsIAMRole` statement can also be omitted. Databases discovered by the Teleport Discovery Service should be registered with complete metadata, so you can also omit the `RedshiftFetchMetadata` permissions if all of your AWS databases are being auto-discovered. ## Step 4/5. Start the Database Service Configure the Database Service to start automatically when the host boots up by creating a systemd service for it. The instructions depend on how you installed the Database Service. **Package Manager** On the host where you will run the Database Service, enable and start Teleport: ``` $ sudo systemctl enable teleport $ sudo systemctl start teleport ``` **TAR Archive** On the host where you will run the Database Service, create a systemd service configuration for Teleport, enable the Teleport service, and start Teleport: ``` $ sudo teleport install systemd -o /etc/systemd/system/teleport.service $ sudo systemctl enable teleport $ sudo systemctl start teleport ``` You can check the status of the Database Service with `systemctl status teleport` and view its logs with `journalctl -fu teleport`. The Database Service will proxy the Amazon Redshift cluster with the ID you specified earlier. Keep in mind that AWS IAM changes may not propagate immediately and can take a few minutes to come into effect. ## Step 5/5. Connect **Self-Hosted** Once the Database Service has started and joined the cluster, log in to see the registered databases. Replace `--proxy` with the address of your Teleport Proxy Service. ``` $ tsh login --proxy=teleport.example.com --user=alice $ tsh db ls Name Description Labels ----------- ------------------------------ -------- my-redshift ... ``` **Teleport Enterprise Cloud** Once the Database Service has started and joined the cluster, log in to see the registered databases. Replace `--proxy` with the address of your Teleport Cloud tenant. ``` $ tsh login --proxy=mytenant.teleport.sh --user=alice $ tsh db ls Name Description Labels ----------- ------------------------------ -------- my-redshift ... ``` To retrieve credentials for a database and connect to it: ``` $ tsh db connect --db-user=alice --db-name=dev my-redshift ``` --- DATABASE USERS MUST EXIST Teleport does not currently use the auto-create option when generating tokens for Redshift databases. Users must exist in the database. --- --- TIP You can also [access your PostgreSQL databases using the Web UI.](https://goteleport.com/docs/connect-your-client/teleport-clients/web-ui.md#starting-a-database-session) --- To log out of the database and remove credentials: ``` $ tsh db logout my-redshift ``` ## Authenticate Redshift with as an IAM role Amazon Redshift supports two methods of IAM-based authentication, and Teleport is compatible with both. **First method: Authenticate as a Database User (Default)** In this method, the Teleport Database Service generates a temporary IAM authentication token for an existing database user in Redshift. This user must already exist in the Redshift database. Teleport uses this method by default. **Second method: Authenticate as an IAM Role** In this alternative method, the Teleport Database Service assumes an AWS IAM role to authenticate to Redshift. Redshift maps the IAM role to a database user and automatically creates that user if it doesn't already exist. If you use this method, you must first create an AWS IAM role that grants access to the Redshift database. If you use this method, you must first create an AWS IAM role that grants access to the Redshift database. The following permissions policy should be attached to an IAM role that Teleport users can specify as a database user. ``` { "Version": "2012-10-17", "Statement": [ { "Sid": "RedshiftConnectWithIAM", "Effect": "Allow", "Action": "redshift:GetClusterCredentialsWithIAM", "Resource": "*" } ] } ``` | Statement | Purpose | | ------------------------ | ------------------------------------------------------------------------------------ | | `RedshiftConnectWithIAM` | Connect to a Redshift database as a database user mapped 1:1 from this IAM identity. | An IAM role can connect as an automatically created database user with permissions mapped 1:1 from the identity's IAM permissions. Permissions in the database are granted with `redshift-data:*` statements attached to the IAM identity, for example `redshift-data:GetStatementResult`. Teleport users can connect as that role by specifying "role/{RoleName}" as a database user, e.g. ``` $ tsh db connect my-redshift --db-user=role/redshift-user-role ``` See [Using identity-based policies for Amazon Redshift](https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html) for more information about available Redshift IAM permissions that are mapped to the database user. ## Troubleshooting ### Certificate error If your `tsh db connect` error includes the following text, you likely have an RDS or DocumentDB database created before July 28, 2020, which presents an X.509 certificate that is incompatible with Teleport: ``` x509: certificate relies on legacy Common Name field, use SANs instead ``` AWS provides instructions to rotate your [SSL/TLS certificate](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html). ### No credential providers error If you see the error `NoCredentialProviders: no valid providers in chain` in Database Service logs then Teleport is not detecting the required credentials to connect via AWS IAM permissions. Check whether the credentials or security role has been applied in the machine running the Teleport Database Service. When running on EKS, this error may occur if the Teleport Database Service cannot access IMDSv2 when the PUT requests hop limit on the worker node instance is set to 1. You can use the following commands to check the hop limit: ``` $ aws ec2 describe-instances --instance-ids | grep HttpPutResponseHopLimit "HttpPutResponseHopLimit": 1, ``` See [IMDSv2 support for EKS](https://aws.amazon.com/about-aws/whats-new/2020/08/amazon-eks-supports-ec2-instance-metadata-service-v2/) and [EKS best practices](https://aws.github.io/aws-eks-best-practices/security/docs/iam/#when-your-application-needs-access-to-imds-use-imdsv2-and-increase-the-hop-limit-on-ec2-instances-to-2) for more details. ### Timeout errors The Teleport Database Service requires connectivity to your database endpoints. Check that firewall rules (e.g., AWS security groups) allow connectivity between the Teleport Database Service and the database endpoint. - Inbound firewall rules for the database must allow connections from the Teleport Database Service. - Outbound firewall rules for the Teleport Database Service must allow connections to the database endpoint. --- TIP On the same host as the Teleport Database Service, try running `nc` to check if it can reach the database port. - Database host: database-host - Database port: database-port ``` $ nc -zv database-host database-port Connection to postgres-instance-1.sadas.us-east-1.rds.amazonaws.com (172.31.24.172) 5432 port [tcp/postgresql] succeeded! ``` --- Debugging connection timeout errors in AWS For deployments in AWS, it may be helpful to use [AWS Reachability Analyzer](https://docs.aws.amazon.com/vpc/latest/reachability/what-is-reachability-analyzer.html) to analyze the network path between the Teleport Database Service and the database. 1. Identify the Elastic Network Interface (ENI) associated with the Teleport Database Service host. This can be found in the [EC2 console](https://console.aws.amazon.com/ec2/home?NIC). 2. Identify the private IP address of the database. 3. Create and analyze a network path: - Set the path source to the ENI associated with the Teleport Database Service host. - Set the path destination to the database IP. 4. Check the analysis results to identify reachability issues. If your database is registered dynamically or via auto-discovery, repeat the above connectivity test for *every*\* Teleport Database Service instance that proxies this database. To list all Teleport Database Service instances associated with a given database, run the `tctl get db_server/` command. For example: ``` $ tctl get db_server/postgres-instance-1 --format json | jq '.[] | {hostname: .spec.hostname, host_id: .spec.host_id, version: .spec.version, target_health: .status.target_health}' { "hostname": "ip-10-0-0-111.ca-central-1.compute.internal", "host_id": "e5e670ac-a7b8-44ef-b373-6296d87f50e8", "version": "18.3.0", "target_health": { "status": "unhealthy", ... } } { "hostname": "ip-10-0-0-222.ca-central-1.compute.internal", ... } ``` If any of the Database Service instances listed here **should not** proxy the database, (for example, a Database Service instance in a different VPC or AWS region without connectivity), locate and update their configurations so they only receive or discover databases they can reach. In most cases, you can achieve this by refining your tag filters, such as adding the `vpc-id` label. ### Not authorized to perform `sts:AssumeRole` The Database Service assumes an IAM role in one of following situations: - A Teleport user specifies an IAM role as the database user they wish to use when accessing AWS services that require IAM roles as database users. Databases that support using an IAM role as a database user include: DynamoDB, Keyspaces, Opensearch, Redshift, and Redshift Serverless. - The `assume_role_arn` field is specified for the database resources or dynamic resource matchers. What if both situations apply? (role chaining) When both of the above conditions are true for a database connection, the Database Service performs a role chaining by assuming the IAM role specified in `assume_role_arn` first, then using that IAM role to assume the IAM role for the database user. You may encounter the following error if the trust relationship is not configured properly between the IAM roles: ``` AccessDenied: User: arn:aws:sts::111111111111:assumed-role/teleport-db-service-role/i-* is not authorized to perform: sts:AssumeRole on resource: arn:aws:iam::111111111111:role/db-user-role ``` how to properly configure the trust relationship? To allow IAM Role `teleport-db-service-role` to assume IAM Role `db-user-role`, the following is generally required: **1. Configure Trust Relationships on db-user-role** `teleport-db-service-role` or its AWS account should be set as `Principal` in `db-user-role`'s trust policy. **Role as principal** Assign aws-account-id to your AWS account ID: ``` { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::aws-account-id:role/teleport-db-service-role" }, "Action": "sts:AssumeRole" } ] } ``` **Account as principal** Assign aws-account-id to your AWS account ID: ``` { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::aws-account-id:root" }, "Action": "sts:AssumeRole" } ] } ``` **Cross-account with external-id** Assign external-aws-account-id to an external AWS account ID: ``` { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::external-aws-account-id:role/teleport-db-service-role" }, "Action": "sts:AssumeRole", "Condition": { "StringEquals": { "sts:ExternalId": "example-external-id" } } } ] } ``` **2. Configure Permissions Policies on teleport-db-service-role** `teleport-db-service-role` requires `sts:AssumeRole` permissions, for example: ``` { "Version": "2012-10-17", "Statement": [ { "Action": "sts:AssumeRole", "Effect": "Allow", "Resource": "arn:aws:iam::aws-account-id:role/db-user-role" } ] } ``` Note that this policy can be omitted when `teleport-db-service-role` and `db-user-role` are in the same AWS account and `teleport-db-service-role`'s full ARN is configured as Principal in `db-user-role`'s trust policy. **3. Configure Permissions Boundary on teleport-db-service-role** If `teleport-db-service-role` does not have an attached [Permissions boundary](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) then you can skip this step. Otherwise, the boundary policy attached to `teleport-db-service-role` must include `sts:AssumeRole` permissions, for example: ``` { "Version": "2012-10-17", "Statement": [ { "Action": "sts:AssumeRole", "Effect": "Allow", "Resource": "*" } ] } ``` You can test the trust relationship by running this AWS CLI command as `teleport-db-service-role`: ``` $ aws sts assume-role --role-arn arn:aws:iam::111111111111:role/db-user-role --role-session-name test-trust-relationship ``` Learn more on [how to use trust policies with IAM roles](https://aws.amazon.com/blogs/security/how-to-use-trust-policies-with-iam-roles/). ### Maximum policy size exceeded errors Due to [IAM and STS character limits](https://docs.aws.amazon.com/iam/latest/userguide/reference_iam-quotas.html#reference_iam-quotas-entity-length), you may encounter one of the following errors in the Database Service logs when large numbers of databases are registered: - `LimitExceeded: Maximum policy size of 2048 bytes exceeded for user ` - `LimitExceeded: Maximum policy size of 10240 bytes exceeded for role ` For reference, a user policy can maintain permissions for approximately 6 Redshift databases, or 20 RDS databases due to the IAM policy character limits. A role policy can maintain permissions for approximately 30 Redshift databases, or 100 RDS databases. To get around this limit, try using one or a combination of the following methods: Method 1: Organize IAM roles with "assume\_role\_arn" You can reduce the policy size by separating them into multiple IAM roles. Use `assume_role_arn` to specify different IAM roles for accessing the databases: **Auto-Discovery by Discovery Service** You can specify `assume_role_arn` in the AWS matchers of Discovery Service's configuration: --- WARNING Discovery Service exposes a configuration parameter - `discovery_service.discovery_group` - that allows you to group discovered resources into different sets. This parameter is used to prevent Discovery Agents watching different sets of cloud resources from colliding against each other and deleting resources created by another services. When running multiple Discovery Services, you must ensure that each service is configured with the same `discovery_group` value if they are watching the same cloud resources or a different value if they are watching different cloud resources. It is possible to run a mix of configurations in the same Teleport cluster meaning that some Discovery Services can be configured to watch the same cloud resources while others watch different resources. As an example, a 4-agent high availability configuration analyzing data from two different cloud accounts would run with the following configuration. - 2 Discovery Services configured with `discovery_group: "prod"` polling data from Production account. - 2 Discovery Services configured with `discovery_group: "staging"` polling data from Staging account. --- ``` discovery_service: discovery_group: "prod" enabled: true aws: - types: ["rds"] regions: ["us-west-1", "us-west-2"] assume_role_arn: "arn:aws:iam::123456789012:role/example-role-rds-env-prod-discovery" tags: "env": "prod" - types: ["redshift", "redshift-serverless"] regions: ["us-west-2"] assume_role_arn: "arn:aws:iam::123456789012:role/example-role-redshift-env-dev" tags: "env": "dev" ``` The Discovery Service will use the IAM roles specified in `assume_role_arn` for discovery, and by default the Database Service will use the same IAM roles for authentication. However, you can also overwrite the IAM roles for authentication by Database Service if you wish to use different roles: ``` db_service: enabled: true resources: # Matches us-west-1 env=prod RDS databases from Discovery Service, and # overwrites assume_role_arn. - labels: "env": "prod" "region": "us-west-1" aws: assume_role_arn: "arn:aws:iam::123456789012:role/example-role-rds-env-prod-us-west-1-access" # Matches us-west-2 env=prod RDS databases from Discovery Service, and # overwrites assume_role_arn. - labels: "env": "prod" "region": "us-west-2" aws: assume_role_arn: "arn:aws:iam::123456789012:role/example-role-rds-env-prod-us-west-2-access" # Matches env=dev Redshift databases from Discovery Service and inherits # "arn:aws:iam::123456789012:role/example-role-redshift-env-dev" - labels: "env": "dev" ``` --- AUTO-DISCOVERY LABELS Teleport generates certain labels derived from the cloud resource attributes during discovery. See [Auto-Discovery labels](https://goteleport.com/docs/enroll-resources/database-access/reference/labels.md) /labels/#auto-discovery) for more details. --- Create or print the required IAM policies with the following commands and attach them to the respective IAM roles: ``` $ teleport db configure aws create-iam --types redshift,redshift-serverless --name teleport-redshift-access $ teleport db configure aws print-iam --types redshift,redshift-serverless ``` Refer to the command usage for a complete list of database types supported by the `--types` option. **Auto-Discovery by Database Service** You can specify `assume_role_arn` in the AWS matchers of Database Service's configuration: ``` db_service: enabled: true aws: - types: ["rds"] regions: ["us-west-1", "us-west-2"] assume_role_arn: "arn:aws:iam::123456789012:role/example-role-rds-env-prod" tags: "env": "prod" - types: ["redshift", "redshift-serverless"] regions: ["us-west-2"] assume_role_arn: "arn:aws:iam::123456789012:role/example-role-redshift-env-dev" tags: "env": "dev" ``` The Database Service will use the IAM roles specified `assume_role_arn` for both discovery and authentication. To bootstrap IAM permissions, run the bootstrap command for each `assume_role_arn`: ``` $ teleport db configure bootstrap \ -c /etc/teleport.yaml \ --policy-name teleport-policy-rds-env-prod \ --attach-to-role "arn:aws:iam::123456789012:role/example-role-rds-env-prod" ``` **Static config** You can specify `aws.assume_role_arn` when defining databases in Database Service's configuration: ``` db_service: enabled: true databases: - name: "rds-postgres" protocol: "postgres" uri: "rds-postgres.abcdef012345.us-west-1.rds.amazonaws.com:5432" aws: assume_role_arn: "arn:aws:iam::123456789012:role/example-rds-access-role" ``` To bootstrap IAM permissions, run the bootstrap command for each `assume_role_arn`: ``` $ teleport db configure bootstrap \ -c /etc/teleport.yaml \ --policy-name teleport-policy-rds-access \ --attach-to-role "arn:aws:iam::123456789012:role/example-rds-access-role" ``` **Other dynamic resources** You can specify `aws.assume_role_arn` when defining databases: ``` kind: db version: v3 metadata: name: "rds-postgres" labels: env: "dev" spec: protocol: "postgres" uri: "rds-postgres.abcdef012345.us-west-1.rds.amazonaws.com:5432" aws: assume_role_arn: "arn:aws:iam::123456789012:role/example-rds-access-role" ``` Alternatively, you can overwrite the IAM roles for authentication by Database Service: ``` db_service: enabled: true resources: # Matches env=dev databases and overwrites assume_role_arn. - labels: "env": "dev" aws: assume_role_arn: "arn:aws:iam::123456789012:role/example-env-dev-access" # Matches env=prod database, and use the assume_role_arn in the database's # definition or use the host IAM identity if assume_role_arn is empty. - labels: "env": "prod" ``` Create or print the required IAM policies with the following commands and attach them to the respective IAM roles: ``` $ teleport db configure aws create-iam --types rds --name teleport-rds-access $ teleport db configure aws print-iam --types rds ``` Refer to the command usage for a complete list of database types supported by the `--types` option. The IAM roles specified in `assume_role_arn` must [trust](https://aws.amazon.com/blogs/security/how-to-use-trust-policies-with-iam-roles/) the IAM identity of the host running the Database Service. The `assume_role_arn` is not limited to the same AWS account so you can also use this feature for [AWS Cross-Account Access](https://goteleport.com/docs/enroll-resources/database-access/enrollment/aws/aws-cross-account.md). Method 2: Manually manage your IAM policies You can manually manage IAM policies for database connections instead of relying on the Database Service to update them. For example, you can limit the character size by attaching a policy with a wildcard "\*" for "Resource": **RDS or RDS Proxy** ``` { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "rds-db:connect", "Resource": "*" } ] } ``` **Redshift** ``` { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "redshift:GetClusterCredentials", "Resource": "*" } ] } ``` You can safely remove the inline policy created by the Database Service and the IAM permissions for the Database Service to `Get/Put/Delete` the user or role policy. Method 3: Separate Database Services You can deploy [the Database Service in a highly available (HA) configuration](https://goteleport.com/docs/enroll-resources/agents/high-availability.md) where databases can be sharded to separate Database Services with different IAM roles. Method 4: Use IAM roles instead of IAM users IAM users have a lower character limit compared to IAM roles. If the limit is exceeded for a user policy, it is recommended to use IAM roles for the Database Service instead. ### Unable to cancel a query If you use a PostgreSQL cli client like `psql`, and you try to cancel a query with `Ctrl+C`, but it doesn't cancel the query, then you need to connect using a tsh local proxy instead. When `psql` cancels a query, it establishes a new connection without TLS certificates, however Teleport requires TLS certificates not only for authentication, but also to route database connections. If you [enable TLS Routing in Teleport](https://goteleport.com/docs/zero-trust-access/deploy-a-cluster/tls-routing.md) then `tsh db connect` will automatically start a local proxy for every connection. Alternatively, you can connect via [Teleport Connect](https://goteleport.com/docs/connect-your-client/teleport-clients/teleport-connect.md) which also uses a local proxy. Otherwise, you need to start a tsh local proxy manually using `tsh proxy db` and connect via the local proxy. If you have already started a long-running query in a `psql` session that you cannot cancel with `Ctrl+C`, you can start a new client session to cancel that query manually: First, find the query's process identifier (PID): ``` SELECT pid,starttime,duration,trim(user_name) AS user,trim(query) AS query FROM stv_recents WHERE status = 'Running'; ``` Next, gracefully cancel the query using its PID. This will send a SIGINT signal to the postgres backend process for that query: ``` SELECT pg_cancel_backend(); ``` You should always try to gracefully terminate a query first, but if graceful cancellation is taking too long, then you can forcefully terminate the query instead. This will send a SIGTERM signal to the postgres backend process for that query: ``` SELECT pg_terminate_backend(); ``` See the PostgreSQL documentation on [admin functions](https://www.postgresql.org/docs/current/functions-admin.html#functions-admin-signal) for more information about the `pg_cancel_backend` and `pg_terminate_backend` functions. ### SSL SYSCALL error You may encounter the following error when your local `psql` is not compatible with newer versions of OpenSSL: ``` $ tsh db connect --db-user postgres --db-name postgres postgres psql: error: connection to server at "localhost" (::1), port 12345 failed: Connection refused Is the server running on that host and accepting TCP/IP connections? connection to server at "localhost" (127.0.0.1), port 12345 failed: SSL SYSCALL error: Undefined error: 0 ``` Please upgrade your local `psql` to the latest version. ## Next steps - Learn more about [using IAM authentication to generate database user credentials](https://docs.aws.amazon.com/redshift/latest/mgmt/generating-user-credentials.html) for Amazon Redshift. - Learn how to [restrict access](https://goteleport.com/docs/enroll-resources/database-access/rbac.md) to certain users and databases. - View the [High Availability (HA)](https://goteleport.com/docs/enroll-resources/agents/high-availability.md) guide. - Take a look at the YAML configuration [reference](https://goteleport.com/docs/enroll-resources/database-access/reference/configuration.md).