PostgreSQL Cloud SQL

curl https://api.humanitec.io/orgs/${HUMANITEC_ORG}/resources/defs \
  -X POST \
  -H "Authorization: Bearer ${HUMANITEC_TOKEN}" \
  -H "Content-Type: application/json" \
  --data-binary '
{
  "id": "dev-postgres-cloudsql",
  "name": "Dev PostgreSQL CloudSQL",
  "type": "postgres",
  "criteria": [
    {
      "env_type": "development"
    }
  ],
  "driver_account": "example-gcp-account",
  "driver_type": "humanitec/postgres-cloudsql",
  "driver_inputs": {
    "values": {
      "instance": "example-project:europe-west-1:postgres-db",
      "name": "postgres"
    },
    "secrets": {
      "dbcredentials": {
        "username": "postgres",
        "password": "53cr3t-P455w0rd"
      }
    }
  }
}'

Google CloudSQL uses a slightly different Humanitec Driver to other Postgres providers, but this is transparent outside the resource definitions.

Prerequisites #

• You must have a CloudSQL instance running.
• You must have a Service Account with the Cloud SQL Client role.
• You must create a key for this service account in JSON format. See Google’s account keys documentation for more information. The access key must use the GCP Console/gcloud format (i.e., the first example in the linked documentation).
• You must have the CloudSQL Admin API enabled for your project.
• You must have a user defined on the instance for Workloads to use when connecting to the database.

Add a GCP Account #

To integrate a CloudSQL account you need to add a Cloud Account (if you haven’t already).

1. From the Cloud Accounts screen, click Google Cloud Platform in the Add accounts section.
2. In the modal dialog provide a unique name for the account in the Account name field.
3. In the Service account access key(JSON) field paste the account key for the service account that you wish to use.
4. Click Authorize.

Add a Resource Definition #

1. From the Resource Management screen, click Add resource definition.
2. In the modal dialog click Postgres.
3. Next, select the postgres-cloudsql Driver.
4. Finally, provide the following information, then click Add Postgress.
   1. In the ID field provide a unique ID for the resource.
   2. In the Credentials field select the Cloud Account you created earlier.
   3. In the Fully qualified CloudSQL instance name provide the instance name in the format <project-id>:<region>:<id>.
   4. If the maintenance database name is not postgres provide that in the Database name field.
   5. In the User / Role and Password fields provide the credentials that Workloads should use when connecting to the database.

Resource Matching #

Now that the resource is defined you will need to add matching criteria.

1. Click on the relevant row in the Resource Definition table.
2. Then switch to the Matching Criteria tab.
3. Click + Add new Criteria.
4. Configure the matching rules as needed:
   • Environment Type: development.
5. Click Save.