We are looking for your feedback on our feature flags capabilities and user experience. Register your interest to provide feedback and influence our product design by filling out this form .

Deploy a MySQL instance with App Lifecycle Manager

Learn how to deploy a Cloud SQL instance using App Lifecycle Manager.

Before you begin

If you don't already have one, sign up for a new account .

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

Select a project : Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
Create a project : To create a project, you need the Project Creator role ( roles/resourcemanager.projectCreator ), which contains the resourcemanager.projects.create permission. Learn how to grant roles .

Go to project selector

Verify that billing is enabled for your Google Cloud project .

Enable the App Lifecycle Manager, Artifact Registry, Cloud Build, Cloud Storage, Developer Connect, Infrastructure Manager, Design Center, App Hub, Cloud Resource Manager, Identity and Access Management, Cloud Asset Inventory, Cloud Monitoring, Cloud Logging, and Service Health APIs.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role ( roles/serviceusage.serviceUsageAdmin ), which contains the serviceusage.services.enable permission. Learn how to grant roles .

Enable the APIs

Create a service account:

Ensure that you have the Create Service Accounts IAM role ( roles/iam.serviceAccountCreator ) and the Project IAM Admin role ( roles/resourcemanager.projectIamAdmin ). Learn how to grant roles .
In the Google Cloud console, go to the Create service account page.
Go to Create service account
Select your project.
In the Service account name field, enter a name. The Google Cloud console fills in the Service account ID field based on this name.

In the Service account description field, enter a description. For example, Service account for quickstart .
Click Create and continue .
Grant the Project > Owner role to the service account.

To grant the role, find the Select a role list, then select Project > Owner .

Note : The Role field affects which resources the service account can access in your project. You can revoke these roles or grant additional roles later. In production environments, do not grant the Owner, Editor, or Viewer roles. Instead, grant a predefined role or custom role that meets your needs.
Click Continue .
Click Done to finish creating the service account.

Install the Google Cloud CLI.

Note:If you installed the gcloud CLI previously, make sure you have the latest version by running gcloud components update .

If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity .

To initialize the gcloud CLI, run the following command:

gcloud  
init

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

Select a project : Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
Create a project : To create a project, you need the Project Creator role ( roles/resourcemanager.projectCreator ), which contains the resourcemanager.projects.create permission. Learn how to grant roles .

Go to project selector

Verify that billing is enabled for your Google Cloud project .

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role ( roles/serviceusage.serviceUsageAdmin ), which contains the serviceusage.services.enable permission. Learn how to grant roles .

Enable the APIs

Create a service account:

Ensure that you have the Create Service Accounts IAM role ( roles/iam.serviceAccountCreator ) and the Project IAM Admin role ( roles/resourcemanager.projectIamAdmin ). Learn how to grant roles .
In the Google Cloud console, go to the Create service account page.
Go to Create service account
Select your project.
In the Service account name field, enter a name. The Google Cloud console fills in the Service account ID field based on this name.

In the Service account description field, enter a description. For example, Service account for quickstart .
Click Create and continue .
Grant the Project > Owner role to the service account.

To grant the role, find the Select a role list, then select Project > Owner .

Note : The Role field affects which resources the service account can access in your project. You can revoke these roles or grant additional roles later. In production environments, do not grant the Owner, Editor, or Viewer roles. Instead, grant a predefined role or custom role that meets your needs.
Click Continue .
Click Done to finish creating the service account.

Install the Google Cloud CLI.

Note:If you installed the gcloud CLI previously, make sure you have the latest version by running gcloud components update .

If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity .

To initialize the gcloud CLI, run the following command:

gcloud  
init

Grant the App Lifecycle Manager service account the required permissions:
1. Navigate to App Lifecycle Manager> Overview Get started.
  
  Go to Get started with App Lifecycle Manager
2. In the banner with the message The required permissions for App Lifecycle Manager account haven't been granted, click Grant permissions.

Model your Cloud SQL offering using a composite template

In this section, you'll use App Lifecycle Manager to model a composite template ( sql-quickstart-template ) consisting of a Cloud SQL instance using Application Design Center.

In Google Cloud console, go to App Lifecycle Manager> SaaS Offering.

Go to SaaS Offering
Click Create.
In the Name of the SaaS offeringfield, type: my-sql-quickstart-saas-offering .
In the Regiondrop-down, select the regions:
- us-central1
- us-east1
- us-east5
Click Ok.
Click Create. It may take a few minutes to create my-sql-quickstart-saas-offering .

The SaaS offering detailspage opens.
On the SaaS offering detailspage, click Create new template.
On the Create a new composite templatepage:
1. In the Template IDbox, enter sql-quickstart-template .
2. Click Create template. App Lifecycle Manager will take a few minutes to create the composite template.
  
  When App Lifecycle Manager has created the template successfully, you'll see its details in the Connected application templatesection of the SaaS offering detailspage.
In the Connected application templatesection, go to Manage template> Configure in canvas.

App Design Center opens in the Google Cloud console window.
In the Componentsarea, find and click the Cloud SQL (My SQL)template.

A Cloud SQL (My SQL)component is added to the canvas.
Click Continue> Deploy at scale with App Lifecycle Manager.

App Lifecycle Manager opens in the Google Cloud console window.
In the Connected application templatesection, click Update template revision.
On the Update template revisionpage, select r-2 in the Revisiondrop-down.
Click Update. The Connected application templatesection displays Importing Application Template.

It may take a few minutes for App Lifecycle Manager to import the template revision. When the revision has finished importing, you'll see the list of unit kinds populated in the Unit kindstab.

Provision a Cloud SQL instance using App Lifecycle Manager

In this section, you'll create and provision a unit ( my-sql-quickstart-unit ) with a Cloud SQL instance in the us-central1 region.

On the SaaS offering detailspage of my-sql-quickstart-saas-offering , click Provision.

A Provisionpage opens.
On the Provisionpage, select us-central1 in the Regiondrop-down.

Click Addto add a unit to your SaaS offering.
On the Add unit to provisionpanel:
1. In the Unit namebox, type my-sql-quickstart-unit-1 .
2. In the Unit kinddrop-down, select the sql-quickstart-template unit kind.
3. In the Releasedrop-down, select ( r-3 ).
4. In the Service accountdrop-down, select the service account you created in the Before you begin section.
Click Add tenant project variables.
1. Select your project to provision your resources.
In the Other input variablessection of the Add unit to provisionpanel:
1. Click the sql-my-sql-1_database_version drop-down.
  - In the Variable valuebox, type MY_SQL_8_0 .
  Click Done.
2. Click the sql-my-sql-1_name drop-down.
  - In the Variable valuebox, type my-sql-db-1 .
  Click Done.
3. Click the sql-my-sql-1_project_id drop-down.
  - In the Variable valuebox, type your project ID.
  Click Done.
4. Click the sql-my-sql-1_region drop-down.
  - In the Variable valuebox, type us-central1 .
  Click Done.
Click Add. You'll see my-sql-quickstart-unit-1 in the Units to be provisionedtable.
Click Provisionto provision the my-sql-quickstart-unit-1 which will create a live Cloud SQL instance in your SaaS offering.

It may take a few minutes for App Lifecycle Manager to provision my-sql-quickstart-unit-1 .

Note: You can repeat this process for each of the regions you selected when creating the SaaS offering to deploy the Cloud SQL instance in multiple regions.

View the deployed Cloud SQL instance

You have now used App Lifecycle Manager to deploy a Cloud SQL instance.

To view the Cloud SQL instance that you deployed in this quickstart:

In Google Cloud console, go to the App Lifecycle Manager> Units> Unit detailspage.

Go to Units
Click the name of your unit: my-sql-quickstart-unit-1 .
On the Unit detailspage:
1. See that the Stateis:
  - Readyif the Cloud SQL instance is provisioned.
  - Provisioningif the operation is still in progress.

Clean up

To avoid incurring charges to your Google Cloud account for the resources used on this page, follow these steps.

Delete the project

If you deployed the Cloud SQL instance in a new Google Cloud project, and if you no longer need the project, then delete it by completing the following steps:

In the Google Cloud console, go to the Manage resources page.
Go to Manage resources
In the project list, select the project that you want to delete, and then click Delete .
At the prompt, type the project ID, and then click Shut down .

What's next

To understand more about App Lifecycle Manager, see App Lifecycle Manager overview .
To get started with App Lifecycle Manager, begin with Create a SaaS offering .
To understand how service accounts are used and how to grant the required permissions for these accounts, see App Lifecycle Manager service accounts .
For the steps to update the release, see Rollout a release .