CloudSQL - PostgreSQL

Overview

Google Cloud SQL PostgreSQL is a fully managed relational database service built for the cloud. It provides a high-performance, scalable, and highly available PostgreSQL database instance without the overhead of managing infrastructure. With Google Cloud SQL, users benefit from Google Cloud's robust infrastructure, which ensures high availability, security, and scalability for their databases.

Through this integration, Apono helps you securely manage access to your Google Cloud SQL PostgreSQL database instances.

To enable Apono to manage Google Cloud SQL PostgreSQL user access, you must create a user and then configure the integration within the Apono UI.

---

Prerequisites

---

Create a PostgreSQL user

You must create a user in your PostgreSQL instance for the Apono connector and grant that user permissions to your databases.

🚧

You must use the admin account and password to connect to your database.

Use the following steps to create a user and grant it permissions:

1. In the Google Cloud console, create a new user with either Built-in authentication or Cloud IAM authentication.

   Built-in Authentication

   
   Use apono_connector for the username.
   
   

   This authentication method grants the user the cloudsqlsuperuser role. Be sure to set a strong password for the user.
   
   

   💡

   As an alternative, you can run the following command from your Postgre client:

   CREATE USER 'apono_connector'@'%' IDENTIFIED BY 'password';

   
   
   Cloud IAM

   
   Use apono-connector-iam-sa@[PROJECT_ID].iam.gserviceaccount.com for the Principal.
   
   This authentication method does not grant the user account database privileges.
   
   

   🚧

   Be sure that the Apono connector GCP service account (apono-connector-iam-sa@[PROJECT_ID].iam.gserviceaccount.com) has the Cloud SQL Admin role.

   
   

2. (Cloud IAM only) In your preferred client tool, grant cloudsqlsuperuser access to the user account.
   
   
   SQL

   ALTER ROLE "<CONNECTOR_USERNAME>" WITH CREATEROLE;
   GRANT cloudsqlsuperuser TO "<CONNECTOR_USERNAME>";
   

3. In your preferred client tool, grant the cloudsqlsuperuser role privileges on all databases except template0 and cloudsqladmin.
   
   This allows Apono to perform tasks that are not restricted to a single schema or object within the database, such as creating, altering, and dropping database objects.
   
   
   SQL

   DO $$
   DECLARE
     database_name text;
   BEGIN
     FOR database_name IN (SELECT datname FROM pg_database WHERE datname != 'template0' AND datname != 'cloudsqladmin') LOOP
       EXECUTE 'GRANT ALL PRIVILEGES ON DATABASE ' || quote_ident(database_name) || ' TO cloudsqlsuperuser WITH GRANT OPTION';
     END LOOP;
   END; $$
   

4. For each database to be managed through Apono, connect to the database and grant cloudsqlsuperuser privileges on all objects in the schemas.
   
   This allows Apono to perform tasks that are restricted to schemas within the database, such as modifying table structures, creating new sequences, or altering functions.
   
   
   SQL

   DO $$
   DECLARE
     schema text;
   BEGIN
     FOR schema IN (SELECT schema_name FROM information_schema.schemata WHERE schema_name NOT LIKE 'pg_%' AND schema_name != 'information_schema' AND schema_name != 'cron') LOOP
       EXECUTE 'GRANT ALL PRIVILEGES ON SCHEMA ' || quote_ident(schema) || ' TO cloudsqlsuperuser WITH GRANT OPTION';
       EXECUTE 'GRANT ALL PRIVILEGES ON ALL TABLES IN SCHEMA ' || quote_ident(schema) || ' TO cloudsqlsuperuser WITH GRANT OPTION';
       EXECUTE 'GRANT ALL PRIVILEGES ON ALL SEQUENCES IN SCHEMA ' || quote_ident(schema) || ' TO cloudsqlsuperuser WITH GRANT OPTION';
       EXECUTE 'GRANT ALL PRIVILEGES ON ALL FUNCTIONS IN SCHEMA ' || quote_ident(schema) || ' TO cloudsqlsuperuser WITH GRANT OPTION';
     END LOOP;
     EXECUTE 'ALTER DEFAULT PRIVILEGES GRANT ALL PRIVILEGES ON TABLES TO cloudsqlsuperuser WITH GRANT OPTION';
     EXECUTE 'ALTER DEFAULT PRIVILEGES GRANT ALL PRIVILEGES ON SEQUENCES TO cloudsqlsuperuser WITH GRANT OPTION';
     EXECUTE 'ALTER DEFAULT PRIVILEGES GRANT ALL PRIVILEGES ON FUNCTIONS TO cloudsqlsuperuser WITH GRANT OPTION';
     EXECUTE 'ALTER DEFAULT PRIVILEGES GRANT ALL PRIVILEGES ON SCHEMAS TO cloudsqlsuperuser WITH GRANT OPTION';
   END; $$
   

5. Connect to the template1 database and grant cloudsqlsuperuser privileges on all objects in the schemas.
   
   For any new databases created in the future, this allows Apono to perform tasks that are restricted to schemas within the database, such as modifying table structures, creating new sequences, or altering functions.
   
   
   SQL

   DO $$
   DECLARE
     schema text;
   BEGIN
     FOR schema IN (SELECT schema_name FROM information_schema.schemata WHERE schema_name NOT LIKE 'pg_%' AND schema_name != 'information_schema' AND schema_name != 'cron') LOOP
       EXECUTE 'GRANT ALL PRIVILEGES ON SCHEMA ' || quote_ident(schema) || ' TO cloudsqlsuperuser WITH GRANT OPTION';
       EXECUTE 'GRANT ALL PRIVILEGES ON ALL TABLES IN SCHEMA ' || quote_ident(schema) || ' TO cloudsqlsuperuser WITH GRANT OPTION';
       EXECUTE 'GRANT ALL PRIVILEGES ON ALL SEQUENCES IN SCHEMA ' || quote_ident(schema) || ' TO cloudsqlsuperuser WITH GRANT OPTION';
       EXECUTE 'GRANT ALL PRIVILEGES ON ALL FUNCTIONS IN SCHEMA ' || quote_ident(schema) || ' TO cloudsqlsuperuser WITH GRANT OPTION';
     END LOOP;
     EXECUTE 'ALTER DEFAULT PRIVILEGES GRANT ALL PRIVILEGES ON TABLES TO cloudsqlsuperuser WITH GRANT OPTION';
     EXECUTE 'ALTER DEFAULT PRIVILEGES GRANT ALL PRIVILEGES ON SEQUENCES TO cloudsqlsuperuser WITH GRANT OPTION';
     EXECUTE 'ALTER DEFAULT PRIVILEGES GRANT ALL PRIVILEGES ON FUNCTIONS TO cloudsqlsuperuser WITH GRANT OPTION';
     EXECUTE 'ALTER DEFAULT PRIVILEGES GRANT ALL PRIVILEGES ON SCHEMAS TO cloudsqlsuperuser WITH GRANT OPTION';
   END; $$
   

6. (Built-in authentication only) Create a secret with the credentials from step 1.
   
   

   📘

   When using Cloud IAM authentication, the service account and its permissions are managed through Google Cloud IAM roles and policies. The service account is used to authenticate to the Cloud SQL instance.

   A secret does not need to be created.

---

Integrate Google Cloud SQL - PostgreSQL

Use the following steps to complete the integration:

1. On the Catalog tab, click Google Cloud SQL - PostgreSQL. The Connect Google Cloud SQL - PostgreSQL page appears.

2. From the dropdown menu, select a connector.

   💡

   If the desired connector is not listed, click + Add new connector and follow the instructions for creating a GCP connector.

3. Click Next. The Complete setup page appears.

4. Enter a unique, alphanumeric, user-friendly Integration Name. This name is used to identify this integration when constructing an access flow.

5. Select the Auth Type for the PostgreSQL service account or user.

   Option	Description
   IAM Auth	Cloud IAM authentication
   User / Password	Built-in authentication

   
   

6. Enter the Project ID where PostgreSQL is deployed.

7. Enter only one Region where the PostgreSQL instance is deployed.

8. Enter the Instance ID for the PostgreSQL instance.

9. Enter the Database Name.

10. From the SSL Mode dropdown menu, select the mode of Secure Sockets Layer (SSL) encryption used to secure the connection with the SQL database server.

    Option	Description
    require	An SSL-encrypted connection must be used.
    allow	An SSL-encrypted or unencrypted connection is used. If an SSL encrypted connection is unavailable, the unencrypted connection is used.
    disable	An unencrypted connection is used.
    prefer	An SSL encrypted connection is attempted. If the encrypted connection is unavailable, the unencrypted connection is used.
    verify-ca	An SSL-encrypted connection must be used and a server certification verification against the provided CA certificates must pass.
    verify-full	An SSL-encrypted connection must be used and a server certification verification against the provided CA certificates must pass. Additionally, the server hostname is checked against the certificate's names.

11. (User/Password only) Under Secret Store, associate the Google Secret Store secret.

    📘

    A secret is not needed for Cloud IAM authentication.

12. Click Connect.

Now that you have completed this integration, you can create access flows that grant permission to your Google Cloud SQL PostgreSQL instance.