# Database Access with Cloud SQL for PostgreSQL Teleport can provide secure access to PostgreSQL on Google Cloud SQL 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 PostgreSQL on Google Cloud SQL database with a service account. 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 PostgreSQL. When a user connects to the database via Teleport, the Teleport Database Service obtains Google Cloud credentials and authenticates to Google Cloud as an IAM principal with permissions to access the database. **Self-Hosted** ![Self-Hosted Teleport Architecture for Cloud SQL Access](/docs/assets/images/cloudsql_selfhosted-d65faab984c4e259628374696047b208.png) **Cloud-Hosted** ![Cloud-Hosted Teleport Architecture for Cloud SQL Access](/docs/assets/images/cloudsql_cloud-0d10000ea7aac3c68ebebb0417a577f6.png) ## 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 ``` * Google Cloud account * Command-line client `psql` installed and added to your system's `PATH` environment variable. * A host, e.g., a Compute Engine 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 18.7.3 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/9. Create a service account for the Teleport Database Service A GCP service account will be used by the Teleport Database Service to create ephemeral access tokens for *other* GCP service accounts when it's acting on the behalf of authorized Teleport users. ### Create a service account Go to the [Service Accounts](https://console.cloud.google.com/iam-admin/serviceaccounts) page and create a service account: ![Create Service Account](/docs/assets/images/service-account-db-service@2x-894c28edfe0f2f1477bc18d723688723.png) ### (Optional) Grant permissions The Teleport Database Service needs permissions to automatically download your Cloud SQL instance's root CA certificate and to generate an ephemeral client certificate. If you intend to download the CA certificate manually and your Cloud SQL instance SSL mode is not "require trusted client certificates", then you can skip this step. Otherwise, in the second step of the service account creation dialogue, assign the service account the pre-defined GCP IAM role "Cloud SQL Client", then click "Done". Cloud SQL Client permissions The "Cloud SQL Client" role has the following permissions: ``` # Used to auto-download the instance's root CA certificate and check SSL mode. cloudsql.instances.get # Used to generate an ephemeral client certificate cloudsql.instances.connect ``` If you only need one of these permissions, you can define and assign a custom IAM role to the service account instead. ## Step 2/9. Create a service account for a database user Teleport uses service accounts to connect to Cloud SQL databases. ### Create a service account Go to the IAM & Admin [Service Accounts](https://console.cloud.google.com/iam-admin/serviceaccounts) page and create a new service account named "cloudsql-user": ![Create Service Account](/docs/assets/images/service-account-db@2x-459b8d9fa3326f96869f90e028420bc7.png) Click "Create and continue". ### Grant permissions On the second step grant this service account the "Cloud SQL Instance User" role which will allow it to connect to Cloud SQL instances using an IAM token for authentication: ![Grant Cloud SQL Instance User to Service Account](/docs/assets/images/service-account-db-grant@2x-58b85a4c271e1f1cd71836a44da2c5fc.png) Click "Done". ### Grant access to the service account The Teleport Database Service must be able to impersonate this service account. Navigate to the "cloudsql-user" service account overview page and select the "permissions" tab: ![Select Service Account Permissions Tab](/docs/assets/images/service-account-permissions-tab@2x-9f2a3c83b688fe92f06ab9f3ac87f334.png) Click "Grant Access" and add the "teleport-db-service" principal ID. Select the "Service Account Token Creator" role and save the change: ![Grant Service Account Token Creator to Database Service](/docs/assets/images/grant-token-creator@2x-c4fcd3812bc55d11b21b48e6d5112775.png) --- SERVICE ACCOUNT PERMISSIONS The "Service Account Token Creator" IAM role includes more permissions than the Teleport Database Service needs. To further restrict the service account, you can create a role that includes only the following permission: ``` # Used to generate IAM auth tokens when connecting to a database instance. iam.serviceAccounts.getAccessToken ``` --- ## Step 3/9. Configure your Cloud SQL database Teleport uses [IAM database authentication](https://cloud.google.com/sql/docs/postgres/authentication) with Cloud SQL PostgreSQL instances. If you're [creating](https://console.cloud.google.com/sql/choose-instance-engine) a new PostgreSQL instance, make sure to add the `cloudsql.iam_authentication` database flag under "Customize your instance / Flags" section: ![Enable IAM Authentication](/docs/assets/images/iam-new-instance@2x-6445ba0d76c80d0bea5945eccc591065.png) To check whether IAM authentication is enabled for an existing Cloud SQL instance, look for the flag on the Configuration panel on the instance's Overview page: ![Check IAM Authentication](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAigAAACgCAMAAAARr2crAAABQmlDQ1BJQ0MgUHJvZmlsZQAAKJFjYGASSCwoyGFhYGDIzSspCnJ3UoiIjFJgf8rAwsDGIMygwqCfmFxc4BgQ4ANUwgCjUcG3awyMIPqyLsis3oc1Ogdct6wp3l3+cGmvkzamehTAlZJanAyk/wBxSnJBUQkDA2MCkK1cXlIAYrcA2SJFQEcB2TNA7HQIew2InQRhHwCrCQlyBrKvANkCyRmJKUD2EyBbJwlJPB2JDbUX7AYfdwUPlyAFE28CjiUVlKRWlIBo5/yCyqLM9IwSBUdgCKUqeOYl6+koGBkYGTIwgMIbovqzGDgcGcVOIcQqrzMwWAQCGTEIsZCbDAy7AhgYuGcjxDTUGBh4geF23LQgsSgR7gDGbyzFacZGEDZPEQMD64///z/LMjCw72Jg+Fv0///vuf///13CwMAMNPNAIQDtAl7Qi8IHvQAAAIplWElmTU0AKgAAAAgABAEaAAUAAAABAAAAPgEbAAUAAAABAAAARgEoAAMAAAABAAIAAIdpAAQAAAABAAAATgAAAAAAAACQAAAAAQAAAJAAAAABAAOShgAHAAAAEgAAAHigAgAEAAAAAQAAAiigAwAEAAAAAQAAAKAAAAAAQVNDSUkAAABTY3JlZW5zaG90cD5gsgAAAAlwSFlzAAAWJQAAFiUBSVIk8AAAAdZpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDYuMC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6ZXhpZj0iaHR0cDovL25zLmFkb2JlLmNvbS9leGlmLzEuMC8iPgogICAgICAgICA8ZXhpZjpQaXhlbFlEaW1lbnNpb24+MTYwPC9leGlmOlBpeGVsWURpbWVuc2lvbj4KICAgICAgICAgPGV4aWY6UGl4ZWxYRGltZW5zaW9uPjU1MjwvZXhpZjpQaXhlbFhEaW1lbnNpb24+CiAgICAgICAgIDxleGlmOlVzZXJDb21tZW50PlNjcmVlbnNob3Q8L2V4aWY6VXNlckNvbW1lbnQ+CiAgICAgIDwvcmRmOkRlc2NyaXB0aW9uPgogICA8L3JkZjpSREY+CjwveDp4bXBtZXRhPgqY9QYUAAAAHGlET1QAAAACAAAAAAAAAFAAAAAoAAAAUAAAAFAAABK1+KTy8QAAAtlQTFRFAAAAAQEBAgICBAQEBQUFBgYGBwcHCQkJCgoKCwsLDAwMDg4NDw8PEBAQEREREhISExMTFBQUFRUVFhYWFxcXGBgYGRkZGhoaGxsbHBwcHR0dHh4eHx8fICAgISEhIiIiIyMjJCQkJSUlJiYmJycnKCgoKSkpKSkqKioqKysrLCwsLS0tLi4uLy8vMDAwMTExMjIyMzMzNDQ0NTU1NjY2Nzc3ODg4OTk5Ojo6Ozs7PDw8PT09Pj4+Pz8/QEBAQUFBQkJCQ0NDRERERUVFRkZGR0dHSEhISUlJSkpKS0tLTExMTU1NTk5OT09PUFBQUVFRUlJSU1NTVFRUVVVVVlZWV1dXWFhYWVlZWlpaW1tbXFxcXV1dXl5eX19fYGBgYWFhYmJiY2NjZGRkZWVlZmZmZ2dnaGhoaWlpampqa2trbGxsbW1tbm5ub29vcHBwcXFxcnJyc3NzdHR0dXV1dnZ2d3d3eHh4eXl5enp6e3t7fHx8fX19fn5+f39/gICAgYGBgoKCg4ODhISEhYWFhoaGh4eHiIiIiYmJioqKi4uLjIyMjY2Njo6Oj4+PkJCQkZGRk5OTlJSUlZWVlpaWl5eXmJiYmZmZmpqam5ubnJycnZ2dnp6en5+foKCgoaGhoqKio6OjpKSkpqWmp6enqKioqampqqqqq6urrKysra2trq6ur6+vsLCwsbGxs7OztLS0tbW1tra2t7e3uLi4ubm5urq6u7u7vLy8vb29v7+/wMDAwcHBwsLCw8PDxMTExcXFxsbGx8fHyMjIysrKy8vLzMzMzc3Nzs7Oz8/P0NDQ0dHS09PT1NTU1dXV1tbW19fX2NjY2dnZ2trb3Nzc3d3d3t7e39/f4ODg4eHh4uLi4+Pj5eXl5ubm5+fn6Ojo6enp6urq6+vr7Ozt7u7u7+/v8PDw8fHx8vLy8/P09fX19vb29/f3+Pj4+fn5+vr6/Pz8/f39/v7+////mNnJdwAAECpJREFUeNrt3ftfVNXeB/APeU+itMzLFwYcLUslTaScwTypmORWC/VYSilqiorVkZLUc8qMtDqPJo/XThc1KbU0T+fpoqamqIl6IDPBK3kLFRSYmc9f8PywZ4a5AKFijed8P784e+01a233erP32mvgNaBGU4dAT4FGoWgUikahaBSKRqFoFIpGo1A0CkWjUDQKRaNQNApFo1A0GoWiUSgahaJRKBqFolEoGoWi0SgUjULR3GAo+8caNWTsfj1hCsWbMUaNGRs6B+4s2nPMoeP3R0IxakltTZWUlJRccF1F3+mSec3H/d79IhLTL11H8KaD4hARkej4lwp+ByjrRDqnjrCLRUfwj4Xi+29gec1Q7ImJXUWi3qnmspI2eFt9QukrYyvJAwrl5oSyi2Txa1EyJ3hvgnxWj1CcVtlEhXJTQyE3iSX3BkMpEzmqUG52KBwpqSTJvFlD4oZkXSKLU1I6SmLKO36FZLpknsx4zD5xq/m2ymXj7X2e3WFunH4lKS5pxilz41D6I/axn3p7upLytMiwlBleKD5tksWZj9knbDmR8jJJlmc/0bPvhH06zqE1mXVD2SrWMpIrosVyn8iDZ3kkMlJEIp/yKyTTZVBXsYhYlpPkyYEiXSJF/k6S+zqK3CNi3UGSe6wS00nkOc/TcKnZXIIHim+bzOsuYpGoVLGTLEkQuUckcqEOdChC+UWkgNwlkR9ecHzbSyb43Hr8CtNFhu50nJwqlkKSyTI4jydfFcshkvGSeoR7kyW2gizqallRye+7yUe+t55j3luPX5uuBEnY5zgyU8ROcook7HEWZUpUno50CEKhVb4h/26fTpJLJNYHil9hutgukORQmUaW9E4oIOnoKu+Rx0SOkyy0yF4yWcaR5AKJc1ULxa/N9dL+DEm+IHaScfIxSUe8LNCRDkUosbLBW1woUhY0mTULPZPZz6Vn1a7nZDZ5ub2sIsmyUgedHWUHSZ6IlJPVQvFrc6pMJkmulQSSg82t8tIKHekQnMw6o2UzSZ5fMWvcqGSRUl8oPoUeKIfE4iTJ7+Y/nzKqh8wimSlRf15husgXa1ZWVlZW1n3yfQ1QfNocKtk+UD6zSP+3DugohyiU4yIFJN+xiiW2V7w/FN9CD5RfRYrJon4iHXv2ukdmkuSKXiKRA1eRXC3erKseim+bdlnrA4XbkiJFHn6jXAc6FKH8n3S4TK6UzuvLyeN+UPwKPVAKRcpYZpcJP5OcLLPMVvLnJ4lMJddLz6/dKa4Wil+bhnvK64ZCFq94OloSz+lIhyCUgTKB5OOy2n158YHiV+iBslViyS0S76IvFJLrRQqYL1ZnNQtuVVD82pwor/tDIVnUQZbrSIfeZHaZWPaR7GzeBDZ7oKxnYGG6jCBJTpFh5DKxk6TDkFnkotjRJMl4Wcnye0wIvOCoHopfm0ulp4MksyWBzI19+CJJTpU0HekQg1KZP07kHZJMkqRL5I57zTEdL3ODCtNFslzkFzGyhdws8jlZOklkMpkn8hXJ3ZGym1wsXXaSLOr1ZHm1UPzaLOsiM5zkjvZiJx33y6tO8lKsuYqnCRUocfaHLSIxK0iSX0VK+ye6S6w55p+KZfhfAwrT5SHpkpIYJSkkHYNEHhpkkVgZQHK6SK/0gRZJcZGO4WJ54sWk6Kjl1V9R/DtaFSXxYxKkg9hJ5sRIl4kjOkq8zlFCCopIZOxj8z2rHRviRGLG/dpNskleTBIZFFCYLss+7S5yzywnSZ6bHCUSt/F9uZckP3jEInLfm5dJ0rW0u0jMwPU1zFH8O+KXcSLWjJXSmyR3JVlFLJNP6ECHzmS2mpz8d6X3tasovyyokOQvP3qnqpcP/uKz4/L+k1WT2PMHK+raEVl8yMFFMtLtt+CIrraFOpQ/Ij+Znzgny990cBVKzbkU132rgxWvSYdjOrgKpZZ8FCMdelslZrWObYhOZkMl+2YM6Nj7ucM6tApFExpQavkDsDF6whSKN/trlDJG/6RUoWg0CkWjUDQKRaNQNApFo1A0CkWjUSgahaJRKBqFolEoGoWiUSgajULRKBSNQtEoFI1C0SgUjULRaBSKRqFoFIpGoWgUikahaBSKRqNQNKEF5YjmPyQKRRMKUDR669FoFIpGoWgUikahaBSKRqFoFIpGo1A0CkWjUDT/MVCWZ2TsrWvdjRkZm36jSmZGRsnvc0Jeycj4VVn8flB6A3X+9vI0YMpvVGkCHPUZzKhRrht1QpoBhVf5litDLG/Xf1WFct1QzjcAttX3AZ87c8ZxlVCunDlzgSQ/BcIr662qQqm/K0pH3F7vN6LWwK6rhLII6EeSR5vCVn9VFUr9QancUsoQgsKS75z1V1Wh1B+UG5HrgVKvVf8boCxJskTEjjvtByV3hKW51VhrPgrZbG+QZIHNNoQk+fGAu9sOyPVAKXnpgRYtu71wzmxs9YDWbRK/ybXZFgVBecRm+4UkL80e0O72rmlnSHKNzbak+JmuEQ9OLeXptB63WUf+EnyAi5M7hnd4wvzCO7vNdpYkX7TZPj9mszUBYm2vmlDWJd7dyv4vzzNZvzYRD449SZLTbLaDB4d3iIh93UnOtFmBFjZbMQ/YbMkkyaKxcRHypzVBnVVT9fgL997Wtu+bDpI8aLNNc2XZW7QbkH+tZz5vzpjhL2ab3w2+OXMJt85JGf3K/hCFcjYRAIA7NvlA2dDILEy+SHIGMJokdwFtSHI6AKCx1YTy75Zm1YidJF3pAICGNmBaEBT3Vp7V/Ya9JOcD8a0AAH0OWAAAd54OnK/2N+s3yCbJW4CTJNkPyC4wd2AE2QwYFgYAYe+RJF8399y5iWQfIDXc/O+QQ93vKeR3QBRJrrzdLBngCOgsuGpha7PkgR9Jbgc6PQoAaJZ3baf+X4ZhDDWM4d+SZI4xealhGIYx+LvQhPI4EJE8Mhy4q9gLZUdzoGfaY42BZ4KhfALA+rStKYAppNMCdJ+TEQO0vkiuBnDfc4NuR81QylsAnWeMvwuIqSDnA7g1IbkFgAaIGhEFYELAAfYD2ozP7AA0zQ+AcnrSpHDgyUkfkM0AtH7S1hBoU07ywzA0SR4VAbQoIfsACH90UHMgLJcrJiUAUZMmnfOM/t4GQLeJsQBeCugsqOrZ9kBM6vCWwL0V5HYAsI7sCCDxms587lBjSbGz8K+GcYBkjmEMXp5/dv2zRqozFKF8A7TIJy/1ADI8UCrvBGaR/KoZwjYHQekKDK40MU0h9wB3lZLnmwNf0NUJeMJBFtxdM5QcILKSPHELkEvOB8K3k5UPummlAVb/AzzdEA0KSLYH5gZA8Z+j2MvJH5sCu8mfmgBbyLK+wItkH6DVYbK0FfC6z8TDPfq9gPEuMgdofCWws4CqA4D+l8mj0cAsE0o6yTeA8Gs58xeSjfdI0jnbmOoicwxjDUmuNYxToQjlSfMniR8Bj3ig7AIsTpJMBUYFQtkPNDxBkhOAKeRmoO0VkhsXLTrAfUAjz76aoBRu3XqYJHsCi8n5gEGSC4C7LpPcBjTzX5X7devWPe4b3rBaoRwiyR7AKjIbiHOvf3Qg+wDvkuRI8wLpP/qHgNsukGQHYFtgZ/5VXRFo8DNJrgaiye1Aa5IsAlB8DWd+lzHsIknyZ8PII3OMZ0iSJw3jh1CEEgt8Q5KVu3cf9EB5G5hqTrCALoFQ1gI9fJ56HC2AuKXHzcY+9eyrBQrJsh8++993uwBvV0H51n0luQigLPAYnflfLnt3KPB4rVAKSTIRWEiOAmbm5+fn72uKW8k+wFKaP/pDgkb/M6AXSfLo7t3nAzvzr7ofeMA8niYIK+F2QEiSEcC1TGc/MGa6Xz1rbCRz3N9j7jCMbaEIJQI4HPh4nAy8RZI8BjR2BUCZZ55D7+PxP1sACOv2+jGSb3r21Qbl9OQI9yyxblAc86Lc9esMpROqcsoLJQsYGjT6WUByjZ35V80GksxaFmCzH5SCazjzmcYC96uXjMWhD6U5cCwQSn9gCUnyBHBrIJQ3gBF+6yiFY1oDQPgGn321QCntAkQkpU6MriuUFKBh75SJva4CSgsfKIdqh/Ia8FSNnflXnQsMN2tFA9uuG8rzxjL3q5eNhaEPpRPwfSCUNMC8Kn4PxAXeetYAjwQsuLm2Z8YADQ9zDdD7t6C8DMRfIpkUCKV99VC+Bu76keRbVwGlG/CPo+44aoeyBni0xs78q64D7J6frkaXrxvKPGOu+1Wq8c/Qh5IELCLJE2lpb3mgLPRYmAOkkXOBvlVQdgN3lldB+XrlylMkK6KA/2Eu0PLKb0DpDeTwKqDMdj8wu8fuNmDnb0L5M/BCVQu1QskD2jlJcmlaWkFgZ/5VC4A7SklyJ9CV1w1llZFqTtvPDzWOhD6UxcC9V0g+B/zFA+V4OPAtybPtgFXkGiC83Bz9NmRlO2AeyeIoYAo5FXiaJJOB2axoC2SRvNTFD4rroKsKygPAdJIFrYC36gJlKtCTZGm8OUPoZD65F9xpQokCNgRD+Ri49SBJrksuD4KyHOhWNfqVUcD7JE81Q7OLgZ35V3V1AV4h6UwExl4/lKNDjM0kyRVGsjP0oTjvB7qv+NhojLB93gW3WcCtMzctjAESHWRRI6B79tsDYK6jLADCUlfNtpoLbtuBRn/Ztu/NRsAW8m0gLG3Dggf8FtwcVkRXeLfGAxHPr5veCsBUPygx1UNZA+CpT+Z2hvnMMRqIGLdyWmuYUGzAg8s2BUJhXyA884vlT92CYUFQvgUavPz+ac/iyBqg8fSNr0QDjwd1FlB1C4DRaz/oA0Sdun4ozDaG7ya5YcjgzQx9KNzlXpZu+mHVEv6Vge6ZYI8ykhxjbrQ0oZQnmJvtzDnKvIbuuhNJXullvm7kC2UPgB3erdN3m1VuB/5UFyiu3t76zV1kUVPvwWSb9wigXxCUY53dB2X9OQjK5TYAsMu7Lv+su+rD54M6C6w6u4H7k4FDrAcol142jHGzRhvGJ7wZoPBccgQQbt/s96HgIksYEJ5iftJXPq0x0MQocn/W45gQAdwxL8c9mf3yodsAWJc7SbJyXATQfGaqLxSXLayno+pGdLg/gJZL/gG0rQsUXkxrDDSbdBjmg/zOjgDarJlkQql4GkD/ICisnNkGCGs/6nzwHIXftAWQ6x195lhvAWLSKqrpLLDq1tjGwC39fmB9QKHr42cNwxi7kTcHFJJFexxBZRd35F/xblQeyPP9DS/XgcN+/+F8c63K3DiY7/RMZr2r1QFN7zpS6+H8zefp9geSFQfyfI/v9A7fzw3P7fjJUW0rv35/rob2Hfk7z/sVlOVWfWbt31lQ1Yof9tbnb19d+PHMDfv10BsApd4TAOUqEwhFo1CqnzbNr8oZHWyFolEoCkWh1CUHN2wo0FFSKBqFolEoGoWi0SgUjULRKBSNQtH890HRry/Rr2FRKApFbz0anaNoFIpGoWgUikahaBSKRqNQNApFo1A0CkWjUDQKRaNQNBqFolEoGoWiUSgahaJRKBqFotEoFI1C0SgUjULRKBSNQtEoFI2GJPn/njElYP2oW5gAAAAASUVORK5CYII=) If it isn't enabled, you can add this flag using the "Edit configuration" dialog at the bottom of the Configuration panel. Changing this setting may require a database instance reboot. ### Create a database user Now go back to the Users page of your Cloud SQL instance and add a new user account. In the sidebar, choose "Cloud IAM" authentication type and add the "cloudsql-user" service account that you created in [the second step](#step-29-create-a-service-account-for-a-database-user): ![Add Cloud SQL User Account](/docs/assets/images/add-user-account@2x-bbc95856b689302f8fd7f63dd02147f1.png) Press "Add" and your Users table should look similar to this: ![Cloud SQL User Accounts Table](/docs/assets/images/user-accounts@2x-37c88233b7f4b2efcf7a113aba3ca214.png) See [Creating and managing IAM users](https://cloud.google.com/sql/docs/postgres/create-manage-iam-users) in Google Cloud documentation for more info. ## Step 4/9. Install Teleport 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 ``` ## Step 5/9. Configure the Teleport Database Service ### Create a join token 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 ``` ### (Optional) Download the Cloud SQL CA certificate The Cloud SQL instance's root CA certificate is required so that the Teleport Database Service can validate the certificate presented by the database instance. The Teleport Database Service can automatically download the instance's root CA certificate if it is granted the "cloudsql.instances.get" permission. Alternatively, you can download the instance's CA certificate file from the "Connections" tab under the "Security" section: ![Instance Root Certificate](/docs/assets/images/instance-root-ca@2x-e110df930fce286de4f38e8d2007dc23.png) ### Generate Teleport config **Configure Teleport With Automatic CA Download** Provide the following information and then generate a configuration file for the Teleport Database Service: - example.teleport.sh:443 The host **and port** of your Teleport Proxy Service or Enterprise Cloud site - public-ip The Cloud SQL instance public IP address. The address can be found on the "Connect to this instance" panel on the "Overview" page in the Cloud SQL instance's dashboard. - project-id The GCP project ID. You can normally see it in the organization view at the top of the GCP dashboard. - instance-id The name of your Cloud SQL instance. ``` $ sudo teleport db configure create \ -o file \ --name=cloudsql \ --protocol=postgres \ --labels=env=dev \ --token=/tmp/token \ --proxy=example.teleport.sh:443 \ --uri=public-ip:5432 \ --gcp-project-id=project-id \ --gcp-instance-id=instance-id ``` **Configure Teleport With Manual CA Download** Provide the following information and then generate a configuration file for the Teleport Database Service: - example.teleport.sh:443 The host **and port** of your Teleport Proxy Service or Enterprise Cloud site - public-ip The Cloud SQL instance public IP address. The address can be found on the "Connect to this instance" panel on the "Overview" page in the Cloud SQL instance's dashboard. - project-id The GCP project ID. You can normally see it in the organization view at the top of the GCP dashboard. - instance-id The name of your Cloud SQL instance. - /path/to/cloudsql/instance/server-ca.pem The path to the Cloud SQL instance root CA certificate ``` $ sudo teleport db configure create \ -o file \ --name=cloudsql \ --protocol=postgres \ --labels=env=dev \ --token=/tmp/token \ --proxy=example.teleport.sh:443 \ --uri=public-ip:5432 \ --gcp-project-id=project-id \ --gcp-instance-id=instance-id \ --ca-cert-file=/path/to/cloudsql/instance/server-ca.pem ``` This command will generate a Teleport Database Service configuration file and save it to `/etc/teleport.yaml`. ## Step 6/9. Configure GCP credentials The Teleport Database Service must have credentials for the "teleport-db-service" GCP service account. If the Teleport Database Service is hosted on a GCE instance, you can [change the attached service account](https://cloud.google.com/compute/docs/instances/change-service-account). For non-GCE deployments of Teleport, we recommend using [workload identity](https://cloud.google.com/iam/docs/workload-identity-federation). Using service account keys (insecure) Alternatively, go to that service account's Keys tab and create a new key: ![Service Account Keys](/docs/assets/images/service-account-keys@2x-0a3270370e86e9a93ce51fb7b6174d2d.png) Make sure to choose JSON format: ![Service Account New Key](/docs/assets/images/service-account-new-key@2x-ebf26eda3b9625e0571a1b53378fe640.png) Save the file. Set the `GOOGLE_APPLICATION_CREDENTIALS` environment variable to point to the JSON credentials file you downloaded earlier. For example, if you use `systemd` to start `teleport`, then you should edit the service's `EnvironmentFile` to include the env var: ``` $ echo 'GOOGLE_APPLICATION_CREDENTIALS=/path/to/credentials.json' | sudo tee -a /etc/default/teleport ``` --- WARNING A service account key can be a security risk - we only describe using a key in this guide for simplicity. We do not recommend using service account keys in production. See [authentication](https://cloud.google.com/docs/authentication#service-accounts) in the Google Cloud documentation for more information about service account authentication methods. --- ## Step 7/9. Start the Teleport Database Service Configure the Teleport 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 Teleport Database Service. **Package Manager** On the host where you will run the Teleport Database Service, enable and start Teleport: ``` $ sudo systemctl enable teleport $ sudo systemctl start teleport ``` **TAR Archive** On the host where you will run the Teleport 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 Teleport Database Service with `systemctl status teleport` and view its logs with `journalctl -fu teleport`. ## Step 8/9. 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 9/9. Connect Once the Database Service has joined the cluster, log in to see the available databases: **Self-Hosted** ``` $ tsh login --proxy=teleport.example.com --user=alice $ tsh db ls Name Description Labels -------- ------------------------ -------- cloudsql GCP Cloud SQL PostgreSQL env=dev ``` **Teleport Enterprise (cloud-hosted)** ``` $ tsh login --proxy=mytenant.teleport.sh --user=alice $ tsh db ls Name Description Labels -------- ------------------------ -------- cloudsql GCP Cloud SQL PostgreSQL env=dev ``` --- NOTE You will only be able to see databases that your Teleport role has access to. See our [RBAC](https://goteleport.com/docs/enroll-resources/database-access/rbac.md) guide for more details. --- When connecting to the database, use the name of the database's service account that you added as an IAM database user [above](#step-29-create-a-service-account-for-a-database-user), minus the ".gserviceaccount.com" suffix. The database user name is shown on the Users page of your Cloud SQL instance. Retrieve credentials for the "cloudsql" example database and connect to it, assigning project-id to your Google Cloud project ID: ``` $ tsh db connect --db-user=cloudsql-user@project-id.iam --db-name=postgres cloudsql ``` --- 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: ``` Remove credentials for a particular database instance: $ tsh db logout cloudsql Or remove credentials for all databases: $ tsh db logout ``` ## Troubleshooting ### Could not find default credentials This error can come from either your client application or Teleport. For a client application, ensure that you disable GCP credential loading. Your client should not attempt to load credentials because GCP credentials will be provided by the Teleport Database Service. If you see the credentials error message in the Teleport Database Service logs (at DEBUG log level), then the Teleport Database Service does not have GCP credentials configured correctly. If you are using a service account key, then ensure that the environment variable `GOOGLE_APPLICATION_CREDENTIALS=/path/to/credentials.json` is set and restart your Teleport Database Service to ensure that the env var is available to `teleport`. For example, if your Teleport Database Service runs as a `systemd` service: ``` $ echo 'GOOGLE_APPLICATION_CREDENTIALS=/path/to/credentials.json' | sudo tee -a /etc/default/teleport $ sudo systemctl restart teleport ``` See [authentication](https://cloud.google.com/docs/authentication#service-accounts) in the Google Cloud documentation for more information about service account authentication methods. ### 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,usename,backend_start,query FROM pg_stat_activity WHERE state = 'active'; ``` 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 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). * See the full CLI [reference](https://goteleport.com/docs/enroll-resources/database-access/reference/cli.md). - Learn more about [authenticating as a service account](https://cloud.google.com/docs/authentication#service-accounts) in Google Cloud.