CloudSQL - MySQL

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

---

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. You can use either the Built-in authentication or Cloud IAM authentication.

Built-in Authentication

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

1. In the Google Cloud console, create a new user with 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';

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

   SQL

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

3. 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
   SQL

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

4. Grant the user only one of the following sets of permissions. The chosen set defines the highest level of permissions to provision with Apono.
   
   Expand each of the following options to reveal the SQL commands:

   READ_ONLY: Allows Apono to read data from databases

   
   

   SQL

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

   
   
   READ_WRITE: Allows Apono to read and modify data

   
   

   SQL

   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

   
   

   SQL

   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'@'%';
   
   

   
   

5. (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.
   SQL

   GRANT ROLE_ADMIN on *.* to 'apono_connector';
   

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

You can now integrate Google Cloud SQL - MySQL.

Cloud IAM Authentication

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.

⚠️

Be sure that the service account has the Cloud SQL Admin role.

Use the following step to configure Cloud IAM authentication:

1. In the Google Cloud console, create a new user with Cloud IAM authentication. Use apono-connector-iam-sa@[PROJECT_ID].iam.gserviceaccount.com for the Principal.

You can now integrate Google Cloud SQL - MySQL.

---

Integrate Google Cloud SQL - MySQL

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.

3. Click Next. The Apono connector section expands.
4. 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.

5. Click Next. The Integration Config section expands.
6. 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
   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

7. Click Next. The Secret Store section expands.
8. (User/Password only) Associate the secret or credentials:
   • GCP
   • Kubernetes
   • Apono

     ℹ️

     A secret is not needed or Cloud IAM authentication.

9. Click Next. The Get more with Apono section expands.
10. Define the Get more with Apono settings.

    Setting	Description
    Credential Rotation	(Optional) Number of days after which the database credentials must be rotated
    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. NOTE: You can also add the custom_access_details parameter to the apono_integration schema using Terraform. For more information, learn how to integrate with Apono in the Terraform Registry.
    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.

11. Click Confirm.

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