CloudSQL - MySQL

Create an integration to manage access to Cloud SQL MySQL databases

MySQL is a reliable and secure open-source relational database system. It serves as the main data store for various applications, websites, and products. This includes mission-critical applications and dynamic websites. With 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 Cloud SQL MySQL databases.

---

Prerequisites

Item	Description
Apono Connector	On-prem connection serving as a bridge between your Google Cloud SQL MySQL databases and Apono Minimum Required Version: 1.4.1 Use the following steps to update an existing connector.
Cloud SQL Admin API	API for managing database instances with resources, such as BackupRuns, Databases, and Instances
Cloud SQL Admin Role	(Cloud IAM authentication only) Google Cloud role that the Apono connector's service user must have at the instance's project or organization level

---

Create a MySQL user

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

Follow these 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.

Be sure to set a strong password for the user.

As an alternative, you can run the following common from your MySQL client:

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

Cloud IAM

Use apono-connector-iam-sa@[PROJECT_ID].iam.gserviceaccount.com for the Principal.

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

1. In your preferred client tool, expose databases to the user. This allows Apono to view database names without accessing the contents of each database.

GRANT SHOW DATABASES ON *.* TO 'apono_connector'@'%';

1. Grant the user database permissions. The following commands grant Apono the following permissions:

   • Creating users

   • Updating user information and privileges

   • Monitoring and troubleshooting processes running on the database

   GRANT CREATE USER ON *.* TO 'apono_connector'@'%';
   GRANT UPDATE ON mysql.* TO 'apono_connector'@'%';
   GRANT PROCESS ON *.* TO 'apono_connector'@'%';

2. Grant the user only one of the following sets of permissions. The chosen set defines the highest level of permissions to provision with Apono. Click on each tab to reveal the SQL commands.

READ_ONLY

Allows Apono to read data from databases

GRANT SELECT ON *.* TO 'apono_connector'@'%';
GRANT GRANT OPTION ON *.* TO 'apono_connector'@'%';

READ_WRITE

Allows Apono to read and modify data

GRANT SELECT,ALTER,ALTER ROUTINE,CREATE,CREATE ROUTINE,CREATE TEMPORARY TABLES,CREATE VIEW,DELETE,INDEX,INSERT,TRIGGER,UPDATE,REFERENCES ON *.* TO 'apono_connector'@'%';
GRANT GRANT OPTION ON *.* TO 'apono_connector'@'%';

ADMIN

Allows Apono administrative-level access, including the ability to execute and drop tables

GRANT EXECUTE,DROP,SELECT,ALTER,ALTER ROUTINE,CREATE,CREATE ROUTINE,CREATE TEMPORARY TABLES,CREATE VIEW,DELETE,INDEX,INSERT,TRIGGER,UPDATE,REFERENCES ON *.* TO 'apono_connector'@'%';
GRANT GRANT OPTION ON *.* TO 'apono_connector'@'%';

1. (MySQL 8.0+) Grant the user the authority to manage other roles. This enables Apono to create, alter, and drop roles. However, this role does not inherently grant specific database access permissions.

GRANT ROLE_ADMIN on *.* to 'apono_connector';

1. Create a secret with the credentials from step 1 above.

You can now integrate Google Cloud SQL - MySQL.

---

Integrate Google Cloud SQL - MySQL

Google Cloud SQL - MySQL

You can also use the steps below to integrate with Apono using Terraform.

In step 10, instead of clicking Confirm, follow the Are you integrating with Apono using Terraform? guidance.

Follow these steps to complete the integration:

1. On the Catalog tab, click Google Cloud SQL - MySQL. The Connect Integration page appears.
2. Under Discovery, click one or more resource types and cloud services to sync with Apono.

Apono automatically discovers and syncs all the instances in the environment. After syncing, you can manage access flows to these resources.

1. Click Next. The Apono connector section expands.

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.

1. Click Next. The Integration Config section expands.

2. Define the Integration Config settings.

   Setting	Description
   Integration Name	Unique, alphanumeric, user-friendly name used to identify this integration when constructing an access flow
   Auth Type	Authorization type for the MySQL service account user Option Description IAM Auth Cloud IAM authentication User / Password Built-in authentication
   Option	Description
   IAM Auth	Cloud IAM authentication
   User / Password	Built-in authentication
   Project ID	ID of the project where the MySQL instance is deployed
   Region	Location where the MySQL instance is deployed
   Instance ID	ID of the MySQL instance
   Instance ID User Override	(Optional) Allows overriding the instance ID for the user

3. Click Next. The Secret Store section expands.

4. (User/Password only) Associate the secret or credentials.

A secret is not needed or Cloud IAM authentication.

1. Click Next. The Get more with Apono section expands.

2. Define the Get more with Apono settings.\

   Setting	Description
   Credential Rotation	(Optional) Number of days after which the database credentials must be rotated Learn more about the Credentials Rotation Policy.
   User cleanup after access is revoked (in days)	(Optional) Defines the number of days after access has been revoked that the user should be deleted Learn more about Periodic User Cleanup & Deletion.
   Custom Access Details	(Optional) Instructions explaining how to access this integration's resources Upon accessing an integration, a message with these instructions will be displayed to end users in the User Portal. The message may include up to 400 characters. To view the message as it appears to end users, click Preview.
   Integration Owner	(Optional) Fallback approver if no resource owner is found Follow these steps to define one or several integration owners: From the Attribute dropdown menu, select User or Group under the relevant identity provider (IdP) platform. From the Value dropdown menu, select one or multiple users or groups. NOTE: When Resource Owner is defined, an Integration Owner must be defined.
   Resource Owner	(Optional) Group or role responsible for managing access approvals or rejections for the resource Follow these steps to define one or several resource owners: Enter a Key name. This value is the name of the tag created in your cloud environment. From the Attribute dropdown menu, select an attribute under the IdP platform to which the key name is associated. Apono will use the value associated with the key (tag) to identify the resource owner. When you update the membership of the group or role in your IdP platform, this change is also reflected in Apono. NOTE: When this setting is defined, an Integration Owner must also be defined.

3. Click Confirm.

💡Are you integrating with Apono using Terraform?

If you want to integrate with Apono using Terraform, follow these steps instead of clicking Confirm:

1. At the top of the screen, click View as Code. A modal appears with the completed Terraform configuration code.

2. Click to copy the code.

3. Make any additional edits.

4. Deploy the code in your Terraform.

Refer to Integration Config Metadata for more details about the schema definition.

Now that you have completed this integration, you can create access flow that grant permission to your Google Cloud SQL MySQL database.