Managing MySQL® cluster hosts

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To get the list of cluster hosts, run this command:

yc managed-mysql host list \
   --cluster-name=<cluster_name>

Result:

+----------------------------+----------------------+---------+--------+---------------+
|            NAME            |      CLUSTER ID      |  ROLE   | HEALTH |    ZONE ID    |
+----------------------------+----------------------+---------+--------+---------------+
| rc1b...mdb.yandexcloud.net | c9q5k4ve7ev4******** | MASTER  | ALIVE  | ru-central1-b |
| rc1a...mdb.yandexcloud.net | c9q5k4ve7ev4******** | REPLICA | ALIVE  | ru-central1-a |
+----------------------------+----------------------+---------+--------+---------------+

You can get the cluster name with the list of clusters in the folder.

1. Get an IAM token for API authentication and set it as an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Cluster.listHosts method, e.g., via the following cURL request:

   curl \
       --request GET \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --url 'https://mdb.api.cloud.yandex.net/managed-mysql/v1/clusters/<cluster_ID>/hosts'
   

   You can get the cluster ID with the list of clusters in the folder.

3. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and set it as an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume the repository contents are stored in the ~/cloudapi/ directory.

3. Call the ClusterService/ListHosts method, e.g., via the following gRPCurl request:

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/mysql/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>"
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.mysql.v1.ClusterService.ListHosts
   

   You can get the cluster ID with the list of clusters in the folder.

4. Check the server response to make sure your request was successful.

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To add a host to a cluster:

1. To choose a subnet for your new host, get the list of all cluster subnets:

   yc vpc subnet list
   

   Result:

   +----------------------+-----------+-----------------------+---------------+------------------+
   |          ID          |   NAME    |       NETWORK ID      |       ZONE    |      RANGE       |
   +----------------------+-----------+-----------------------+---------------+------------------+
   | b0cl69a2b4c6******** | default-d | enp6rq72rndgr******** | ru-central1-d | [172.**.*.*/20]  |
   | e2lkj9qwe762******** | default-b | enp6rq72rndgr******** | ru-central1-b | [10.**.*.*/16]   |
   | e9b0ph42bn96******** | a-2       | enp6rq72rndgr******** | ru-central1-a | [172.**.**.*/20] |
   | e9b9v22r88io******** | default-a | enp6rq72rndgr******** | ru-central1-a | [172.**.**.*/20] |
   +----------------------+-----------+-----------------------+---------------+------------------+
   

   If the required subnet is not on the list, create it.

2. See the description of the CLI command for adding a host:

   yc managed-mysql host add --help
   

3. Run this command (our example does not use all available parameters):

   yc managed-mysql host add \
     --cluster-name=<cluster_name> \
     --host zone-id=<availability_zone_ID>,`
       `subnet-id=<subnet_ID>,`
       `assign-public-ip=<allow_public_access_to_host>,`
       `replication-source=<source_host_name>,`
       `backup-priority=<host_backup_priority>,`
       `priority=<host_priority_for_promotion_to_master>
   

   Where:

   • --cluster-name: Managed Service for MySQL® cluster name.
   • --host: Host settings:
     • zone-id: Availability zone.
     • subnet-id: Subnet ID. Specify it if the selected availability zone has two or more subnets.
     • assign-public-ip: Internet access to the host, true or false..
     • replication-source: Replication source for the host.
     • backup-priority: Host's backup priority, between 0 and 100.
     • priority: Host priority for promotion to master if the primary master fails, between 0 and 100.

   You can get the cluster name with the list of clusters in the folder.

1. Open the current Terraform configuration file describing your infrastructure.

   For more information on how to create this file, see this guide.

2. Add the host section to the Managed Service for MySQL® cluster description:

   resource "yandex_mdb_mysql_cluster" "<cluster_name>" {
     ...
     host {
       zone             = "<availability_zone>"
       subnet_id        = <subnet_ID>
       assign_public_ip = <allow_public_access_to_host>
       priority         = <host_priority_for_promotion_to_master>
       ...
     }
   }
   

   Where:

   • assign_public_ip: Public access to the host, true or false.
   • priority: Host priority for promotion to master, between 0 and 100.

3. Make sure the settings are correct.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

4. Confirm updating the resources.

   1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

For more information, see this Terraform provider article.

resource "yandex_mdb_mysql_cluster" "<cluster_name>" {
  ...
  timeouts {
    create = "1h30m" # 1 hour 30 minutes
    update = "2h"    # 2 hours
    delete = "30m"   # 30 minutes
  }
}

1. Get an IAM token for API authentication and set it as an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Cluster.addHosts method, e.g., via the following cURL request:

   curl \
       --request POST \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.cloud.yandex.net/managed-mysql/v1/clusters/<cluster_ID>/hosts:batchCreate' \
       --data '{
                 "hostSpecs": [
                   {
                     "zoneId": "<availability_zone>",
                     "subnetId": "<subnet_ID>",
                     "assignPublicIp": <allow_public_access_to_host>,
                     "replicationSource": "<host_FQDN>",
                     "backupPriority": "<host_backup_priority>",
                     "priority": "<host_priority_for_promotion_to_master>"
                   }
                 ]
               }'
   

   Where hostSpecs is the array of new hosts. Each array element contains the configuration for a single host and has the following structure:

   • zoneId: Availability zone.
   • subnetId: Subnet ID.
   • assignPublicIp: Internet access to the host via a public IP address, true or false.
   • replicationSource: Host’s replication source for manual replication stream management. Specify the FQDN of the host that will be used as the replication source.
   • backupPriority: Host’s backup priority, between 0 and 100.
   • priority: Host priority for promotion to master if the primary master fails, between 0 and 100.

   You can get the cluster ID with the list of clusters in the folder.

3. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and set it as an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume the repository contents are stored in the ~/cloudapi/ directory.

3. Call the ClusterService/AddHosts method, e.g., via the following gRPCurl request:

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/mysql/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "host_specs": [
               {
                 "zone_id": "<availability_zone>",
                 "subnet_id": "<subnet_ID>",
                 "assign_public_ip": <allow_public_access_to_host>,
                 "replication_source": "<host_FQDN>",
                 "backup_priority": "<host_backup_priority>",
                 "priority": "<host_priority_for_promotion_to_master>"
               }
             ]
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.mysql.v1.ClusterService.AddHosts
   

   Where host_specs is the array of new hosts. Each array element contains the configuration for a single host and has the following structure:

   • zone_id: Availability zone.
   • subnet_id: Subnet ID.
   • assign_public_ip: Internet access to the host via a public IP address, true or false.
   • replication_source: Host’s replication source for manual replication stream management. Specify the FQDN of the host that will be used as the replication source.
   • backup_priority: Host’s backup priority, between 0 and 100.
   • priority: Host priority for promotion to master if the primary master fails, between 0 and 100.

   You can get the cluster ID with the list of clusters in the folder.

4. Check the server response to make sure your request was successful.

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To update host settings, run the command below (our example does not use all available settings):

yc managed-mysql host update <host_name> \
  --cluster-name=<cluster_name> \
  --replication-source=<source_host_name> \
  --assign-public-ip=<allow_public_access_to_host> \
  --backup-priority=<host_backup_priority> \
  --priority=<host_priority_for_promotion_to_master>

Where:

• --cluster-name: Managed Service for MySQL® cluster name.
• --replication-source: Replication source for the host.
• --assign-public-ip: Internet access to the host, true or false.
• --backup-priority: Host’s backup priority, between 0 and 100.
• --priority: Host priority for promotion to master if the primary master fails, between 0 and 100.

You can get the host name with the list of cluster hosts, and the cluster name, with the list of clusters in the folder.

To change the cluster host settings:

1. Open the current Terraform configuration file describing your infrastructure.

   For more information on how to create this file, see this guide.

2. In the Managed Service for MySQL® cluster description, change the attributes of the host section referring to the host you want to update.

   resource "yandex_mdb_mysql_cluster" "<cluster_name>" {
     ...
     host {
       replication_source_name = "<replication_source>"
       assign_public_ip        = <allow_public_access_to_host>
       priority                = <host_priority_for_promotion_to_master>
     }
   }
   

   Where:

   • assign_public_ip: Public access to the host, true or false.
   • priority: Host priority for promotion to master, between 0 and 100.

3. Make sure the settings are correct.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

4. Confirm updating the resources.

   1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

For more information, see this Terraform provider article.

resource "yandex_mdb_mysql_cluster" "<cluster_name>" {
  ...
  timeouts {
    create = "1h30m" # 1 hour 30 minutes
    update = "2h"    # 2 hours
    delete = "30m"   # 30 minutes
  }
}

1. Get an IAM token for API authentication and set it as an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Cluster.updateHosts method, e.g., via the following cURL request:

   curl \
       --request POST \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.cloud.yandex.net/managed-mysql/v1/clusters/<cluster_ID>/hosts:batchUpdate' \
       --data '{
                 "updateHostSpecs": [
                   {
                     "updateMask": "assignPublicIp,replicationSource,backupPriority,priority",
                     "hostName": "<host_FQDN>",
                     "assignPublicIp": <allow_public_access_to_host>,
                     "replicationSource": "<host_FQDN>",
                     "backupPriority": "<host_backup_priority>",
                     "priority": "<host_priority_for_promotion_to_master>"
                   }
                 ]
               }'
   

   Where updateHostSpecs is the array of hosts you are updating. Each array element contains the configuration for a single host and has the following structure:

   • updateMask: Comma-separated list of settings you want to update.
   • hostName: FQDN of the host being updated.
   • assignPublicIp: Internet access to the host via a public IP address, true or false.
   • replicationSource: Host’s replication source for manual replication stream management. Specify the FQDN of the host that will be used as the replication source.
   • backupPriority: Host’s backup priority, between 0 and 100.
   • priority: Host priority for promotion to master if the primary master fails, between 0 and 100.

   You can get the cluster ID with the list of clusters in the folder.

3. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and set it as an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume the repository contents are stored in the ~/cloudapi/ directory.

3. Call the ClusterService/UpdateHosts method, e.g., via the following gRPCurl request:

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/mysql/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "update_host_specs": [
               {
                 "update_mask": {
                   "paths": [
                     "assign_public_ip", "replication_source", "backup_priority", "priority"
                   ]
                 },
                 "host_name": "<host_FQDN>",
                 "assign_public_ip": <allow_public_access_to_host>,
                 "replication_source": "<host_FQDN>",
                 "backup_priority": "<host_backup_priority>",
                 "priority": "<host_priority_for_promotion_to_master>"
               }
             ]
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.mysql.v1.ClusterService.UpdateHosts
   

   Where update_host_specs is the array of hosts you are updating. Each array element contains the configuration for a single host and has the following structure:

   • update_mask: List of settings you want to update as an array of strings (paths[]).
   • host_name: FQDN of the host being updated.
   • assign_public_ip: Internet access to the host via a public IP address, true or false.
   • replication_source: Host’s replication source for manual replication stream management. Specify the FQDN of the host that will be used as the replication source.
   • backup_priority: Host’s backup priority, between 0 and 100.
   • priority: Host priority for promotion to master if the primary master fails, between 0 and 100.

   You can get the cluster ID with the list of clusters in the folder.

4. Check the server response to make sure your request was successful.

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To delete a host from the cluster, run this command:

yc managed-mysql host delete <host_name> \
   --cluster-name=<cluster_name>

You can get the host name with the list of cluster hosts, and the cluster name, with the list of clusters in the folder.

1. Open the current Terraform configuration file describing your infrastructure.

   For more information on how to create this file, see this guide.

2. Delete the host section from the Managed Service for MySQL® cluster description.

3. Make sure the settings are correct.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

4. Type yes and press Enter.

   1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

For more information, see this Terraform provider article.

resource "yandex_mdb_mysql_cluster" "<cluster_name>" {
  ...
  timeouts {
    create = "1h30m" # 1 hour 30 minutes
    update = "2h"    # 2 hours
    delete = "30m"   # 30 minutes
  }
}

1. Get an IAM token for API authentication and set it as an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Cluster.deleteHosts method, e.g., via the following cURL request:

   curl \
       --request POST \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.cloud.yandex.net/managed-mysql/v1/clusters/<cluster_ID>/hosts:batchDelete' \
       --data '{
                 "hostNames": [
                   "<host_FQDN>"
                 ]
               }'
   

   Where hostNames is the array containing the host you want to delete.

   You can provide only one host FQDN per request. If you need to delete multiple hosts, send a separate request for each of them.

   You can get the cluster ID with the list of clusters in the folder.

3. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and set it as an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume the repository contents are stored in the ~/cloudapi/ directory.

3. Call the ClusterService/DeleteHosts method, e.g., via the following gRPCurl request:

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/mysql/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "host_names": [
               "<host_FQDN>"
             ]
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.mysql.v1.ClusterService.DeleteHosts
   

   Where host_names is the array containing the host you want to delete.

   You can provide only one host FQDN per request. If you need to delete multiple hosts, send a separate request for each of them.

   You can get the cluster ID with the list of clusters in the folder.

4. Check the server response to make sure your request was successful.