# 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

<table><thead><tr><th width="219">Item</th><th>Description</th></tr></thead><tbody><tr><td><strong>Apono Connector</strong></td><td>On-prem <a href="../apono-connector-for-gcp">connection</a> serving as a bridge between your Google Cloud SQL MySQL databases and Apono<br><br><strong>Minimum Required Version</strong>: 1.4.1<br><br>Use the following steps to <a href="../apono-connector-for-gcp/updating-a-connector-in-google-cloud">update an existing connector</a>.</td></tr><tr><td><strong>Cloud SQL Admin API</strong></td><td><a href="https://cloud.google.com/sql/docs/mysql/admin-api#enable_the_api">API</a> for managing database instances with resources, such as BackupRuns, Databases, and Instances</td></tr><tr><td><strong>Cloud SQL Admin Role</strong></td><td>(Cloud IAM authentication only) Google Cloud role that the Apono connector's service user must have at the instance's project or organization level</td></tr></tbody></table>

***

### 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](https://cloud.google.com/sql/docs/postgres/create-manage-users#creating) with either **Built-in authentication** or **Cloud IAM** authentication.

{% tabs %}
{% tab title="Built-In Authentication" %}
Use *apono\_connector* for the username.

Be sure to set a strong password for the user.

{% hint style="success" %}
As an alternative, you can run the following common from your MySQL client:

`CREATE USER 'apono_connector'@'%' IDENTIFIED BY 'password';`
{% endhint %}
{% endtab %}

{% tab title="Cloud IAM" %}
Use *apono-connector-iam-sa@\[PROJECT\_ID].iam.gserviceaccount.com* for the **Principal**.

{% hint style="warning" %}
Be sure that the Apono connector GCP service account (*apono-connector-iam-sa@\[PROJECT\_ID].iam.gserviceaccount.com*) has the `Cloud SQL Admin` role.
{% endhint %}
{% endtab %}
{% endtabs %}

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.\
   \
   Click on each tab to reveal the SQL commands.

{% tabs %}
{% tab title="READ\_ONLY" %}
Allows Apono to read data from databases

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

{% endtab %}

{% tab title="READ\_WRITE" %}
Allows Apono to read and modify data

{% code overflow="wrap" %}

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

{% endcode %}
{% endtab %}

{% tab title="ADMIN" %}
Allows Apono administrative-level access, including the ability to execute and drop tables

{% code overflow="wrap" %}

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

{% endcode %}
{% endtab %}
{% endtabs %}

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](https://docs.apono.io/docs/connectors-and-secrets/apono-integration-secret#gcp) with the credentials from step 1 above.

You can now [integrate Google Cloud SQL - MySQL](#integrate-google-cloud-sql-mysql).

***

### Integrate Google Cloud SQL - MySQL

<figure><img src="https://1094436629-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fv6MBfUGvblSdAz31yJXm%2Fuploads%2Fgit-blob-048b68450db98d2382d81dfd55d378b0bc2186a2%2FCloud-sql-mysql-1.png?alt=media" alt="" width="563"><figcaption><p>Google Cloud SQL - MySQL</p></figcaption></figure>

{% hint style="success" %}
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.
{% endhint %}

Follow these steps to complete the integration:

1. On the [**Catalog**](https://app.apono.io/catalog?search=sql+-+mysql) 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.

{% hint style="info" %}
Apono automatically discovers and syncs all the instances in the environment. After syncing, you can manage access flows to these resources.
{% endhint %}

3. Click **Next**. The **Apono connector** section expands.
4. From the dropdown menu, select a connector.

{% hint style="success" %}
If the desired connector is not listed, click **+ Add new connector** and follow the instructions for creating a [GCP](https://docs.apono.io/docs/gcp-environment/apono-connector-for-gcp) connector.
{% endhint %}

5. Click **Next**. The **Integration Config** section expands.
6. Define the **Integration Config** settings.

   <table><thead><tr><th width="204">Setting</th><th>Description</th></tr></thead><tbody><tr><td><strong>Integration Name</strong></td><td>Unique, alphanumeric, user-friendly name used to identify this integration when constructing an access flow</td></tr><tr><td><strong>Auth Type</strong></td><td>Authorization type for the MySQL service account user</td></tr><tr><td>Option</td><td>Description</td></tr><tr><td><strong>IAM Auth</strong></td><td>Cloud IAM authentication</td></tr><tr><td><strong>User / Password</strong></td><td>Built-in authentication</td></tr><tr><td><strong>Project ID</strong></td><td>ID of the project where the MySQL instance is deployed</td></tr><tr><td><strong>Region</strong></td><td>Location where the MySQL instance is deployed</td></tr><tr><td><strong>Instance ID</strong></td><td>ID of the MySQL instance</td></tr><tr><td><strong>Instance ID User Override</strong></td><td>(Optional) Allows overriding the instance ID for the user</td></tr></tbody></table>
7. Click **Next**. The **Secret Store** section expands.
8. (User/Password only) [Associate the secret or credentials](https://docs.apono.io/docs/connectors-and-secrets/apono-integration-secret).

{% hint style="info" %}
A secret is **not needed** or Cloud IAM authentication.
{% endhint %}

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

    <table><thead><tr><th width="205">Setting</th><th>Description</th></tr></thead><tbody><tr><td><strong>Credential Rotation</strong></td><td>(Optional) Number of days after which the database credentials must be rotated<br><br>Learn more about the <a href="../../architecture-and-security/credentials-rotation-policy">Credentials Rotation Policy</a>.</td></tr><tr><td><strong>User cleanup after access is revoked (in days)</strong></td><td><p>(Optional) Defines the number of days after access has been revoked that the user should be deleted</p><p><br>Learn more about <a href="../../architecture-and-security/periodic-user-cleanup-and-deletion">Periodic User Cleanup &#x26; Deletion</a>.</p></td></tr><tr><td><strong>Custom Access Details</strong></td><td>(Optional) Instructions explaining how to access this integration's resources<br><br>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 <strong>400 characters</strong>.<br><br>To view the message as it appears to end users, click <strong>Preview</strong>.</td></tr><tr><td><strong>Integration Owner</strong></td><td><p>(Optional) Fallback approver if no <a href="../../access-flows/dynamic-access-management/resource-and-integration-owners">resource owner</a> is found<br><br>Follow these steps to define one or several integration owners:</p><ol><li>From the <strong>Attribute</strong> dropdown menu, select <strong>User</strong> or <strong>Group</strong> under the relevant identity provider (IdP) platform.</li><li>From the <strong>Value</strong> dropdown menu, select one or multiple users or groups.</li></ol><p><br><strong>NOTE</strong>: When <strong>Resource Owner</strong> is defined, an <strong>Integration Owner</strong> must be defined.</p></td></tr><tr><td><strong>Resource Owner</strong></td><td><p>(Optional) Group or role responsible for managing access approvals or rejections for the resource<br><br>Follow these steps to define one or several <a href="../../access-flows/dynamic-access-management/resource-and-integration-owners">resource owners</a>:</p><ol><li>Enter a <strong>Key name</strong>. This value is the name of the tag created in your cloud environment.</li><li>From the <strong>Attribute</strong> dropdown menu, select an attribute under the IdP platform to which the key name is associated.<br><br>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.</li></ol><p><br><strong>NOTE</strong>: When this setting is defined, an <strong>Integration Owner</strong> must also be defined.</p></td></tr></tbody></table>
11. Click **Confirm**.

<details>

<summary>💡Are you integrating with Apono using Terraform?</summary>

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](https://docs.apono.io/metadata-for-integration-config/integration-metadata/gcp-cloud-sql-mysql) for more details about the schema definition.

</details>

Now that you have completed this integration, you can [create access flow](https://docs.apono.io/docs/access-flows/access-flows) that grant permission to your Google Cloud SQL MySQL database.