Managing MySQL® cluster hosts

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To get a list of cluster hosts, run the 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 request the cluster name with the list of clusters in the folder.

1. Get an IAM token for API authentication and put it into the environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Use the Cluster.listHosts method and make a request, e.g., via cURL:

   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 a list of clusters in the folder.

3. View the server response to make sure the request was successful.

1. Get an IAM token for API authentication and put it into the 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. Use the ClusterService/ListHosts call and make a request, e.g., via gRPCurl:

   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 a list of clusters in the folder.

4. View the server response to make sure the request was successful.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To add a host to a cluster:

1. Request a list of cluster subnets to select one for the new host:

   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 in the list, create it.

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

   yc managed-mysql host add --help
   

3. Run the add host command (the example does not show all the available parameters):

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

   Where:

   • --cluster-name: Managed Service for MySQL® cluster name.
   • --host: Host parameters:
     • zone-id: Availability zone.
     • subnet-id: Subnet ID. Specify if two or more subnets are created in the selected availability zone.
     • assign-public-ip: Host accessibility from the internet, true or false..
     • replication-source: Replication source for the host.
     • backup-priority: Host's backup priority, between 0 and 100.
     • priority: Priority for assigning the host as master if the primary master fails, between 0 and 100.

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

1. Open the current Terraform configuration file with an infrastructure plan.

   For more information about creating this file, see Creating clusters.

2. Add a 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 = <public_access_to_host>
       priority         = <priority_for_assigning_host_as_master>
       ...
     }
   }
   

   Where:

   • assign_public_ip: Public access to the host, true or false.
   • priority: Priority of assigning the host as master, between 0 and 100.

3. Make sure the settings are correct.

   1. Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.

   2. Run the command:

      terraform validate
      

      If there are errors in the configuration files, Terraform will point to them.

4. Confirm updating the resources.

   1. Run the command to view planned changes:

      terraform plan
      

      If the resource configuration descriptions are correct, the terminal will display a list of the resources to modify and their parameters. This is a test step. No resources are updated.

   2. If you are happy with the planned changes, apply them:

      1. Run the command:

         terraform apply
         

      2. Confirm the update of resources.

      3. Wait for the operation to complete.

For more information, see the Terraform provider documentation.

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 put it into the environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Use the Cluster.addHosts method and make a request, e.g., via cURL:

   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": <public_host_address:_true_or_false>,
                     "replicationSource": "<host_FQDN>",
                     "backupPriority": "<host_backup_priority>",
                     "priority": "<priority_for_assigning_host_as_master>"
                   }
                 ]
               }'
   

   Where hostSpecs is an array of new hosts. One array element contains settings 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.
   • replicationSource: Replication source for the host to manually manage replication threads. In the parameter, specify the FQDN of the host to be used as a replication source.
   • backupPriority: Host's backup priority, between 0 and 100.
   • priority: Priority for assigning the host as master if the primary master fails, between 0 and 100.

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

3. View the server response to make sure the request was successful.

1. Get an IAM token for API authentication and put it into the 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. Use the ClusterService/AddHosts call and make a request, e.g., via gRPCurl:

   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": <public_host_address:_true_or_false>,
                 "replication_source": "<host_FQDN>",
                 "backup_priority": "<host_backup_priority>",
                 "priority": "<priority_for_assigning_host_as_master>"
               }
             ]
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.mysql.v1.ClusterService.AddHosts
   

   Where host_specs is an array of new hosts. One array element contains settings 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.
   • replication_source: Replication source for the host to manually manage replication threads. In the parameter, specify the FQDN of the host to be used as a replication source.
   • backup_priority: Host's backup priority, between 0 and 100.
   • priority: Priority for assigning the host as master if the primary master fails, between 0 and 100.

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

4. View the server response to make sure the request was successful.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To modify host parameters, execute the command below (the parameter list in the example is not exhaustive):

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

Where:

• --cluster-name: Managed Service for MySQL® cluster name.
• --replication-source: Replication source for the host.
• --assign-public-ip: Host accessibility from the internet, true or false.
• --backup-priority: Host's backup priority, between 0 and 100.
• --priority: Priority for assigning the host as master if the primary master fails, between 0 and 100.

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

To change the parameters of the cluster host:

1. Open the current Terraform configuration file with an infrastructure plan.

   For more information about creating this file, see Creating clusters.

2. In the Managed Service for MySQL® cluster description, change the attributes of the host block corresponding to the host you are updating.

   resource "yandex_mdb_mysql_cluster" "<cluster_name>" {
     ...
     host {
       replication_source_name = "<replication_source>"
       assign_public_ip        = <public_access_to_host>
       priority                = <priority_for_assigning_host_as_master>
     }
   }
   

   Where:

   • assign_public_ip: Public access to the host, true or false.
   • priority: Priority of assigning the host as master, between 0 and 100.

3. Make sure the settings are correct.

   1. Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.

   2. Run the command:

      terraform validate
      

      If there are errors in the configuration files, Terraform will point to them.

4. Confirm updating the resources.

   1. Run the command to view planned changes:

      terraform plan
      

      If the resource configuration descriptions are correct, the terminal will display a list of the resources to modify and their parameters. This is a test step. No resources are updated.

   2. If you are happy with the planned changes, apply them:

      1. Run the command:

         terraform apply
         

      2. Confirm the update of resources.

      3. Wait for the operation to complete.

For more information, see the Terraform provider documentation.

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 put it into the environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Use the Cluster.updateHosts method and make a request, e.g., via cURL:

   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": <public_host_address:_true_or_false>,
                     "replicationSource": "<host_FQDN>",
                     "backupPriority": "<host_backup_priority>",
                     "priority": "<priority_for_assigning_host_as_master>"
                   }
                 ]
               }'
   

   Where updateHostSpecs is an array of hosts being changed. One array element contains settings for a single host and has the following structure:

   • updateMask: List of parameters to update as a single string, separated by commas.
   • hostName: FQDN of a host being changed.
   • assignPublicIp: Internet access to the host via a public IP address.
   • replicationSource: Replication source for the host to manually manage replication threads. In the parameter, specify the FQDN of the host to be used as a replication source.
   • backupPriority: Host's backup priority, between 0 and 100.
   • priority: Priority for assigning the host as master if the primary master fails, between 0 and 100.

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

3. View the server response to make sure the request was successful.

1. Get an IAM token for API authentication and put it into the 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. Use the ClusterService/UpdateHosts call and make a request, e.g., via gRPCurl:

   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": <public_host_address:_true_or_false>,
                 "replication_source": "<host_FQDN>",
                 "backup_priority": "<host_backup_priority>",
                 "priority": "<priority_for_assigning_host_as_master>"
               }
             ]
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.mysql.v1.ClusterService.UpdateHosts
   

   Where update_host_specs is an array of hosts being changed. One array element contains settings for a single host and has the following structure:

   • update_mask: List of parameters to update as an array of paths[] strings.
   • host_name: FQDN of a host being changed.
   • assign_public_ip: Internet access to the host via a public IP address.
   • replication_source: Replication source for the host to manually manage replication threads. In the parameter, specify the FQDN of the host to be used as a replication source.
   • backup_priority: Host's backup priority, between 0 and 100.
   • priority: Priority for assigning the host as master if the primary master fails, between 0 and 100.

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

4. View the server response to make sure the request was successful.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To remove a host from the cluster, run:

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

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

1. Open the current Terraform configuration file with an infrastructure plan.

   For more information about creating this file, see Creating clusters.

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

3. Make sure the settings are correct.

   1. Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.

   2. Run the command:

      terraform validate
      

      If there are errors in the configuration files, Terraform will point to them.

4. Type yes and press Enter.

   1. Run the command to view planned changes:

      terraform plan
      

      If the resource configuration descriptions are correct, the terminal will display a list of the resources to modify and their parameters. This is a test step. No resources are updated.

   2. If you are happy with the planned changes, apply them:

      1. Run the command:

         terraform apply
         

      2. Confirm the update of resources.

      3. Wait for the operation to complete.

For more information, see the Terraform provider documentation.

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 put it into the environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Use the Cluster.deleteHosts method and make a request, e.g., via cURL:

   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 an array with the host to delete.

   Only one host FQDN can be provided in a single request. If you need to delete multiple hosts, run the request for each of them.

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

3. View the server response to make sure the request was successful.

1. Get an IAM token for API authentication and put it into the 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. Use the ClusterService/DeleteHosts call and make a request, e.g., via gRPCurl:

   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 an array with the host to delete.

   Only one host FQDN can be provided in a single request. If you need to delete multiple hosts, run the request for each of them.

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

4. View the server response to make sure the request was successful.