Cloud SQL for PostgreSQL

About

Cloud SQL for PostgreSQL is a fully-managed database service that helps you set up, maintain, manage, and administer your PostgreSQL relational databases on Google Cloud Platform.

If you are new to Cloud SQL for PostgreSQL, you can try creating and connecting to a database by following these instructions.

Requirements

IAM Permissions

By default, this source uses the Cloud SQL Go Connector to authorize and establish mTLS connections to your Cloud SQL instance. The Go connector uses your Application Default Credentials (ADC) to authorize your connection to Cloud SQL.

In addition to setting the ADC for your server, you need to ensure the IAM identity has been given the following IAM roles (or corresponding permissions):

• roles/cloudsql.client

Networking

Cloud SQL supports connecting over both from external networks via the internet (public IP), and internal networks (private IP). For more information on choosing between the two options, see the Cloud SQL page Connection overview.

You can configure the ipType parameter in your source configuration to public or private to match your cluster’s configuration. Regardless of which you choose, all connections use IAM-based authorization and are encrypted with mTLS.

Authentication

This source supports both password-based authentication and IAM authentication (using your Application Default Credentials).

Standard Authentication

To connect using user/password, create a PostgreSQL user and input your credentials in the user and password fields.

user: ${USER_NAME}
password: ${PASSWORD}

IAM Authentication

To connect using IAM authentication:

1. Prepare your database instance and user following this guide.

2. You could choose one of the two ways to log in:

   • Specify your IAM email as the user.
   • Leave your user field blank. Toolbox will fetch the ADC automatically and log in using the email associated with it.

3. Leave the password field blank.

Example

sources:
    my-cloud-sql-pg-source:
        kind: cloud-sql-postgres
        project: my-project-id
        region: us-central1
        instance: my-instance
        database: my_db
        user: ${USER_NAME}
        password: ${PASSWORD}
        # ipType: "private"

Reference