This page describes how to configure an instance for high availability.
You can configure an instance for high availability when you create the instance, or you can enable high availability on an existing instance.
For more information about high availability, see Overview of the high availability configuration.
The legacy configuration for high availability used afailover replica
instance. The new configuration does not use a failover replica
.
Instead, it uses Google's regional persistent disks, which synchronously replicate data at the block level between two zones in a
region. If you have an existing MySQL instance that uses the legacy high availability configuration, you
can update your configuration to use the current version.
For other procedures related to the legacy high availability configuration, see Legacy configuration for high availability.
Create a new instance configured for high availability
When you create an instance and configure it for high availability, Cloud SQL creates it as a regional instance.
To create an instance configured for high availability:
Console
-
In the Google Cloud console, go to the Cloud SQL Instances page.
- Select Create instance.
- Select the database engine.
- In the Choose region and zonal availability section, select Multiple zones (Highly available).
- Expand Specify zones.
- Select the primary and secondary zones. The following conditions
apply when the secondary zone is used during instance creation or edit:
- The zones default to
Any
for the primary zone andAny (different from primary)
for the secondary zone.
If both the primary and secondary zones are specified, they must be different zones.
- The zones default to
- Click Save.
You are returned to the instance page for the primary instance while the instance is updated.
gcloud
- Create the regional instance:
gcloud sql instances create REGIONAL_INSTANCE_NAME \ --availability-type=REGIONAL \ --database-version=DATABASE_VERSION \ --tier=MACHINE_TYPE \ --enable-bin-log
For a complete list of available parameters, see the gcloud sql instances create reference page. -
You can specify both the primary and secondary zones, using the
--zone
and--secondary-zone
parameters. The following restrictions apply when the secondary zone is used during instance creation or edit:- The zones must be valid zones.
- If the secondary zone is specified, the primary must also be specified.
- If the primary and secondary zones are specified, they must be different zones.
- If the primary and secondary zones are specified, they must belong to the same region.
- Configure the root user:
gcloud sql users set-password root --host=% \ --instance=PRIMARY_INSTANCE_NAME \ --password=PASSWORD
Terraform
To create an instance with high availability, use a Terraform resource.
Apply the changes
To apply your Terraform configuration in a Google Cloud project, complete the steps in the following sections.
Prepare Cloud Shell
- Launch Cloud Shell.
-
Set the default Google Cloud project where you want to apply your Terraform configurations.
You only need to run this command once per project, and you can run it in any directory.
export GOOGLE_CLOUD_PROJECT=PROJECT_ID
Environment variables are overridden if you set explicit values in the Terraform configuration file.
Prepare the directory
Each Terraform configuration file must have its own directory (also called a root module).
-
In Cloud Shell, create a directory and a new
file within that directory. The filename must have the
.tf
extension—for examplemain.tf
. In this tutorial, the file is referred to asmain.tf
.mkdir DIRECTORY && cd DIRECTORY && touch main.tf
-
If you are following a tutorial, you can copy the sample code in each section or step.
Copy the sample code into the newly created
main.tf
.Optionally, copy the code from GitHub. This is recommended when the Terraform snippet is part of an end-to-end solution.
- Review and modify the sample parameters to apply to your environment.
- Save your changes.
-
Initialize Terraform. You only need to do this once per directory.
terraform init
Optionally, to use the latest Google provider version, include the
-upgrade
option:terraform init -upgrade
Apply the changes
-
Review the configuration and verify that the resources that Terraform is going to create or
update match your expectations:
terraform plan
Make corrections to the configuration as necessary.
-
Apply the Terraform configuration by running the following command and entering
yes
at the prompt:terraform apply
Wait until Terraform displays the "Apply complete!" message.
- Open your Google Cloud project to view the results. In the Google Cloud console, navigate to your resources in the UI to make sure that Terraform has created or updated them.
Delete the changes
To delete your changes, do the following:
- To disable deletion protection, in your Terraform configuration file set the
deletion_protection
argument tofalse
.deletion_protection = "false"
- Apply the updated Terraform configuration by running the following command and
entering
yes
at the prompt:terraform apply
-
Remove resources previously applied with your Terraform configuration by running the following command and entering
yes
at the prompt:terraform destroy
REST v1
For the complete list of parameters for the request, see the instances:insert page.Create the regional instance.
-
Before using any of the request data, make the following replacements:
- project-id: The project ID
- instance-name: The instance name
- database-version: The database version enum string
- region The GCP region
- machine-type The machine type
HTTP method and URL:
POST https://sqladmin.googleapis.com/v1/projects/project-id/instances
Request JSON body:
{ "name": "instance-name", "region": "region", "databaseVersion": "database-version", "settings": { "tier": "machine-type", "backupConfiguration": { "binaryLogEnabled": true, "enabled": true }, "availabilityType": "REGIONAL" } }
To send your request, expand one of these options:
You should receive a JSON response similar to the following:
- When the instance finishes initializing, update the root password on the
instance:
Before using any of the request data, make the following replacements:
- project-id: The project ID
- instance-id: The instance ID
- password: The new root user password
HTTP method and URL:
PATCH https://sqladmin.googleapis.com/v1/projects/project-id/instances/instance-id/users?name=root&host=%25'
Request JSON body:
{ "name": "root", "host": "%", "password": "password"}
To send your request, expand one of these options:
You should receive a successful status code (2xx) and an empty response.
REST v1beta4
For the complete list of parameters for the request, see the instances:insert page.Create the regional instance.
-
Before using any of the request data, make the following replacements:
- project-id: The project ID
- instance-name: The instance name
- database-version: The database version enum string
- region The GCP region
- machine-type The machine type
HTTP method and URL:
POST https://sqladmin.googleapis.com/sql/v1beta4/projects/project-id/instances
Request JSON body:
{ "name": "instance-name", "region": "region", "databaseVersion": "database-version", "settings": { "tier": "machine-type", "backupConfiguration": { "binaryLogEnabled": true, "enabled": true }, "availabilityType": "REGIONAL" } }
To send your request, expand one of these options:
You should receive a JSON response similar to the following:
- When the instance finishes initializing, update the root password on the
instance:
Before using any of the request data, make the following replacements:
- project-id: The project ID
- instance-id: The instance ID
- password: The new root user password
HTTP method and URL:
PATCH https://sqladmin.googleapis.com/sql/v1beta4/projects/project-id/instances/instance-id/users?name=root&host=%25'
Request JSON body:
{ "name": "root", "host": "%", "password": "password"}
To send your request, expand one of these options:
You should receive a successful status code (2xx) and an empty response.
For more details about creating an instance, see Creating Instances.
Configure an existing instance for high availability
You can configure a Cloud SQL instance for high availability by using the Google Cloud console, gcloud CLI, or the API.
Console
To configure an instance for high availability:
-
In the Google Cloud console, go to the Cloud SQL Instances page.
- To open the Overview page of an instance, click the instance name.
- Click Edit.
- In the Choose region and zonal availability section, select Multiple zones (Highly available).
- Expand Specify zones.
- Select the primary and secondary zones. The following
conditions apply when you use the secondary zone while you're creating or
editing an instance:
- The zones default to
Any
for the primary zone andAny (different from primary)
for the secondary zone.
If you specify both the primary and secondary zones, then they must be different zones.
- The zones default to
- Click Save.
gcloud
To configure an instance to be a regional, high availability instance, use the gcloud sql instances patch
command:
gcloud sql instances patch INSTANCE_NAME \ --availability-type REGIONAL \ --enable-bin-log \ --backup-start-time=HH:MM
Make the following replacements:
- INSTANCE_NAME: the name of the Cloud SQL instance that you're configuring for high availability
- HH:MM: the time (in hours and minutes)
REST v1
To configure an instance to be a regional, high availability instance:
Check the instance to see if automatic backups and binary logs are enabled. These are required for high availability instances.
Before using any of the request data, make the following replacements:
- PROJECT_ID: the ID or project number of the Google Cloud project that contains the instance
- INSTANCE_NAME: the name of the instance that you're configuring for high availability
HTTP method and URL:
GET https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_NAME
To send your request, expand one of these options:
You should receive a JSON response similar to the following:
{ "kind": "sql#instance", "state": "RUNNABLE", "databaseVersion": "MYSQL_8_0" }
The output contains a section similar to the following:
"backupConfiguration": { "kind": "sql#backupConfiguration", "startTime": "12:00", "enabled": true, "binaryLogEnabled": true }
If either
enabled
orbinaryLogEnabled
arefalse
, then use theinstances:patch
method to enable them both. To enable backups, setenabled
totrue
andstartTime
to a value which is the start of the backup window. To enable binary logging, setbinaryLogEnabled
totrue
.Before using any of the request data, make the following replacements:
- PROJECT_ID: the ID or project number of the Google Cloud project that contains the instance
- INSTANCE_NAME: the name of the primary or read replica instance that you're configuring for high availability
- START_TIME: the time (in hours and minutes)
HTTP method and URL:
PATCH https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_NAME
Request JSON body:
{ "settings": { "backupConfiguration": { "startTime": "START_TIME", "enabled": true, "binaryLogEnabled": true } } }
To send your request, expand one of these options:
You should receive a JSON response similar to the following:
Configure the instance to be a regional, high availability instance:
Before using any of the request data, make the following replacements:
- PROJECT_ID: the ID or project number of the Google Cloud project that contains the instance
- INSTANCE_NAME: the name of the instance that you're configuring for high availability
HTTP method and URL:
PATCH https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_NAME
Request JSON body:
{ "settings": {"availabilityType": "REGIONAL" } }
To send your request, expand one of these options:
You should receive a successful status code (2xx) and an empty response.
REST v1beta4
To configure an instance to be a regional, high availability instance:
Check the instance to see if automatic backups and binary logs are enabled. These are required for high availability instances.
Before using any of the request data, make the following replacements:
- PROJECT_ID: the ID or project number of the Google Cloud project that contains the instance
- INSTANCE_NAME: the name of the instance that you're configuring for high availability
HTTP method and URL:
GET https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME
To send your request, expand one of these options:
You should receive a JSON response similar to the following:
{ "kind": "sql#instance", "state": "RUNNABLE", "databaseVersion": "MYSQL_8_0" }
The output contains a section similar to the following:
"backupConfiguration": { "kind": "sql#backupConfiguration", "startTime": "12:00", "enabled": true, "binaryLogEnabled": true }
If either
enabled
orbinaryLogEnabled
arefalse
, then use theinstances:patch
method to enable them both. To enable backups, setenabled
totrue
andstartTime
to a value which is the start of the backup window. To enable binary logging, setbinaryLogEnabled
totrue
.Before using any of the request data, make the following replacements:
- PROJECT_ID: the ID or project number of the Google Cloud project that contains the instance
- INSTANCE_NAME: the name of the primary or read replica instance that you're configuring for high availability
- START_TIME: the time (in hours and minutes)
HTTP method and URL:
PATCH https://sqladmin.googleapis.com/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME
Request JSON body:
{ "settings": { "backupConfiguration": { "startTime": "START_TIME", "enabled": true, "binaryLogEnabled": true } } }
To send your request, expand one of these options:
You should receive a JSON response similar to the following:
Configure the instance to be a regional, high availability instance:
Before using any of the request data, make the following replacements:
- PROJECT_ID: the ID or project number of the Google Cloud project that contains the instance
- INSTANCE_NAME: the name of the instance that you're configuring for high availability
HTTP method and URL:
PATCH https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME
Request JSON body:
{ "settings": {"availabilityType": "REGIONAL" } }
To send your request, expand one of these options:
You should receive a successful status code (2xx) and an empty response.
Initiate failover
Testing failover is optional, but is recommended so that you can see how your application responds in the event of a failover.
To learn more about failovers, see the Failover overview.
Console
-
In the Google Cloud console, go to the Cloud SQL Instances page.
- To open the Overview page of an instance, click the instance name.
- Click Failover.
- In the Manually trigger a failover dialog box, enter the ID of your instance in the text field, and then click Trigger Failover.
gcloud
Initiate the failover:
gcloud sql instances failover PRIMARY_INSTANCE_NAME
REST v1
- Describe the primary instance to get the value of the
settingsVersion
field.Before using any of the request data, make the following replacements:
- PROJECT_ID: the ID or project number of the Google Cloud project that contains the instance
- INSTANCE_NAME: the name of the instance that you're configuring for high availability
HTTP method and URL:
GET https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_NAME
To send your request, expand one of these options:
You should receive a JSON response similar to the following:
{ "kind": "sql#instance", "state": "RUNNABLE", "databaseVersion": "MYSQL_8_0" }
- Initiate the failover:
Before using any of the request data, make the following replacements:
- project-id: The project ID
- instance-name: The instance name
- settings-version: The settingsVersion from instanceInfo
HTTP method and URL:
POST https://sqladmin.googleapis.com/v1/projects/project-id/instances/instance-name/failover
Request JSON body:
{ "failoverContext": { "settingsVersion":"settings-version" } }
To send your request, expand one of these options:
You should receive a JSON response similar to the following:
REST v1beta4
- Describe the primary instance to get the value of the
settingsVersion
field.Before using any of the request data, make the following replacements:
- PROJECT_ID: the ID or project number of the Google Cloud project that contains the instance
- INSTANCE_NAME: the name of the instance that you're configuring for high availability
HTTP method and URL:
GET https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME
To send your request, expand one of these options:
You should receive a JSON response similar to the following:
{ "kind": "sql#instance", "state": "RUNNABLE", "databaseVersion": "MYSQL_8_0" }
- Initiate the failover:
Before using any of the request data, make the following replacements:
- project-id: The project ID
- instance-name: The instance name
- settings-version: The settingsVersion from instanceInfo
HTTP method and URL:
POST https://sqladmin.googleapis.com/sql/v1beta4/projects/project-id/instances/instance-name/failover
Request JSON body:
{ "failoverContext": { "settingsVersion":"settings-version" } }
To send your request, expand one of these options:
You should receive a JSON response similar to the following:
The instance fails over and it isn't available to serve data for a few minutes.
Verify an instance's high availability configuration
To verify an instance has high availability and to view the zones in which it is running:
Console
-
In the Google Cloud console, go to the Cloud SQL Instances page.
- To open the Overview page of an instance, click the instance name.
- Confirm the following high availability settings are displayed in the Configuration section:
- Highly available (regional)
- Located in shows the current primary zone of the instance.
gcloud
gcloud sql instances describe INSTANCE_NAME
The output indicates availabilityType
is REGIONAL
.
The gceZone
and secondaryGceZone
fields show the
current primary and secondary zones of the instance.
REST v1
Before using any of the request data, make the following replacements:
- PROJECT_ID: the ID or project number of the Google Cloud project that contains the instance
- INSTANCE_NAME: the name of the instance that you're configuring for high availability
HTTP method and URL:
GET https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_NAME
To send your request, expand one of these options:
You should receive a JSON response similar to the following:
{ "kind": "sql#instance", "state": "RUNNABLE", "databaseVersion": "MYSQL_8_0" }
The output indicates availabilityType
is REGIONAL
.
The gceZone
and secondaryGceZone
fields show the
current primary and secondary zones of the instance.
REST v1beta4
Before using any of the request data, make the following replacements:
- PROJECT_ID: the ID or project number of the Google Cloud project that contains the instance
- INSTANCE_NAME: the name of the instance that you're configuring for high availability
HTTP method and URL:
GET https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME
To send your request, expand one of these options:
You should receive a JSON response similar to the following:
{ "kind": "sql#instance", "state": "RUNNABLE", "databaseVersion": "MYSQL_8_0" }
The output indicates availabilityType
is REGIONAL
.
The gceZone
and secondaryGceZone
fields show the
current primary and secondary zones of the instance.
Change the zones of a high availability instance
Changing one or both zones of an existing high availability instance causes a few minutes of downtime while the instance is reconfigured. To see the current primary and secondary zones that the high availability instance is running in, see Verify an instance's high availability configuration.
To change the zones of a high availability instance:
Console
-
In the Google Cloud console, go to the Cloud SQL Instances page.
- To open the Overview page of an instance, click the instance name.
- Click Edit.
- In the Choose region and zonal availability section, expand
Specify zones and select new zones. The zones default to
Any
for the primary zone andAny (different from primary)
for the secondary zone. The following restrictions apply:- You can specify the primary zone only, or both the primary and secondary zones.
- If both the primary and secondary zones are specified, they must be different zones.
- Click Save.
You are returned to the instance page for the primary instance while the instance is updated.
gcloud
Change the zone in which the instance is running:
gcloud sql instances patch INSTANCE_NAME \ --zone=PRIMARY_ZONE --secondary-zone=SECONDARY_ZONE
The --secondary-zone
parameter is optional. If you omit it,
Cloud SQL will select an available zone that is different from the
primary zone.
The following restrictions apply:
- The zones must be valid zones belonging to the same region as the Cloud SQL instance.
- If the secondary zone is specified, it must be different from the primary zone.
REST v1
Change the zones of the regional instance:
Before using any of the request data, make the following replacements:
- PROJECT_ID: The project ID
- INSTANCE_NAME: The instance name
- PRIMARY_ZONE: The primary zone
- SECONDARY_ZONE: The secondary zone
HTTP method and URL:
PATCH https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_NAME
Request JSON body:
{ "settings": {"locationPreference": {"zone": "PRIMARY_ZONE", "secondaryZone": "SECONDARY_ZONE"}} }
To send your request, expand one of these options:
You should receive a successful status code (2xx) and an empty response.
The
secondaryZone
parameter is optional. If you omit it, Cloud SQL will select an available zone that is different from the primary zone.The following restrictions apply:
- The zones must be valid zones.
- Any zones that you choose must belong to the same region as the Cloud SQL instance.
REST v1beta4
Change the zones of the regional instance:
Before using any of the request data, make the following replacements:
- PROJECT_ID: The project ID
- INSTANCE_NAME: The instance name
- PRIMARY_ZONE: The primary zone
- SECONDARY_ZONE: The secondary zone
HTTP method and URL:
PATCH https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME
Request JSON body:
{ "settings": {"locationPreference": {"zone": "PRIMARY_ZONE", "secondaryZone": "SECONDARY_ZONE"}} }
To send your request, expand one of these options:
You should receive a successful status code (2xx) and an empty response.
The
secondaryZone
parameter is optional. If you omit it, Cloud SQL will select an available zone that is different from the primary zone.The following restrictions apply:
- The zones must be valid zones.
- Any zones that you choose must belong to the same region as the Cloud SQL instance.
Deactivate high availability for an instance
You can deactivate high availability for a Cloud SQL instance by using the Google Cloud console, gcloud CLI, or the API.
Console
To deactivate high availability for an instance:
-
In the Google Cloud console, go to the Cloud SQL Instances page.
- To open the Overview page of an instance, click the instance name.
- Click Edit.
- Open Auto backups.
- In the Availability section, click Single zone.
- Click Save. This edit requires you to restart the instance.
- When the dialog appears, click Save and restart.
gcloud
To deactivate high availability for an instance, use the gcloud sql instances patch
command:
gcloud sql instances patch INSTANCE_NAME \ --availability-type ZONAL
Replace INSTANCE_NAME with the name of the Cloud SQL instance for which you're deactivating high availability.
REST v1
To change the availability type of the instance to ZONAL
, use the instances:patch
method. This method deactivates high availability for the instance.
Before using any of the request data, make the following replacements:
- PROJECT_ID: the ID or project number of the Google Cloud project that contains the instance
- INSTANCE_NAME: the name of the instance for which you're deactivating high availability
HTTP method and URL:
PATCH https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_NAME
Request JSON body:
{ "settings": {"availabilityType": "ZONAL" } }
To send your request, expand one of these options:
You should receive a successful status code (2xx) and an empty response.
REST v1beta4
To change the availability type of the instance to ZONAL
, use the instances:patch
method. This method deactivates high availability for the instance.
Before using any of the request data, make the following replacements:
- PROJECT_ID: the ID or project number of the Google Cloud project that contains the instance
- INSTANCE_NAME: the name of the instance for which you're deactivating high availability
HTTP method and URL:
PATCH https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME
Request JSON body:
{ "settings": {"availabilityType": "ZONAL" } }
To send your request, expand one of these options:
You should receive a successful status code (2xx) and an empty response.
Troubleshoot
Issue | Troubleshooting |
---|---|
You can't find the metrics for a manual failover. | Only automatic failovers go into the metrics. |
Cloud SQL instance resources (CPU and RAM) are near 100% usage, causing the high availability instance to go down. | The instance machine size is too small for the load.
Edit the instance to upgrade to a larger machine size to get more CPUs and memory. |
What's next
- Learn more about how the high availability configuration works.
- Test how your application responds to lost connections by restarting your instance.
- Learn more about managing your database connections.
- Learn more about Google Cloud Observability.
- Learn more about the Legacy configuration for high availability.
- Create read replicas for your instance.