Managing backups in Yandex Managed Service for Valkey™

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 restore a cluster from a backup:

1. See the description of the CLI command for restoring a Valkey™ cluster:

   yc managed-redis cluster restore --help
   

2. Get the list of available Valkey™ cluster backups:

   yc managed-redis backup list
   

   Result:

   +--------------------------+---------------------+----------------------+---------------------+
   |            ID            |     CREATED AT      |  SOURCE CLUSTER ID   |     STARTED AT      |
   +--------------------------+---------------------+----------------------+---------------------+
   | c9qlk4v13uq7********:... | 2020-08-10 12:00:00 | c9qlk4v13uq7******** | 2020-08-10 11:55:17 |
   | ...                                                                                         |
   +--------------------------+---------------------+----------------------+---------------------+
   

3. Send the following request to create a cluster from a backup:

   yc managed-redis cluster restore \
      --backup-id c9q287aqv5rf********:20181113T133617 \
      --name mynewrd \
      --environment=PRODUCTION \
      --network-name default \
      --host zone-id=ru-central1-a,subnet-id=b0rcctk2rvtr********,assign-public-ip=true,replica-priority=50 \
      --password P@ssWord \
      --disk-size 20
   

   This results in a new Valkey™ cluster with the following characteristics:

   • Name: mynewrd.
   • Environment: PRODUCTION.
   • Network: default.
   • Host class: hm1.nano (one host); subnet: b0rcctk2rvtr********; availability zone: ru-central1-a; access: public; replica priority: 50.
   • Password: P@ssWord.
   • Network SSD storage (network-ssd): 20 GB.

   The password must be between 8 and 128 characters long. The password must meet the [a-zA-Z0-9@=+?*.,!&#$^<>_-]* regular expression.

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

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Cluster.Restore 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-redis/v1/clusters:restore' \
       --data '{
                 "backupId": "<backup_ID>",
                 "name": "<cluster_name>",
                 "environment": "<environment>",
                 "configSpec": {
                   "redis": {
                     "password": "<user_password>"
                   }
                 },
                 "hostSpecs": [
                   {
                     "zoneId": "<availability_zone>",
                     "subnetId": "<subnet_ID>",
                     "replicaPriority": "<host_priority>",
                     "assignPublicIp": <public_access_to_cluster_host>
                   },
                   { <similar_settings_for_host_2> },
                   { ... },
                   { <similar_settings_for_host_N> }
                 ],
                 "networkId": "<network_ID>",
                 "tlsEnabled": <encrypted_TLS_connection_support>
               }'
   

   Where:

   • backupId: Backup ID. To find out the ID, get a list of folder backups.

   • name: Cluster name.

   • environment: Environment, PRESTABLE or PRODUCTION.

   • configSpec.redis.password: Password.

   • hostSpecs: Host settings:

     • zoneId: Availability zone.
     • subnetId: Subnet ID. Specify it if the selected availability zone has two or more subnets.
     • replicaPriority: Host priority for assignment as a master if the primary master fails.
     • assignPublicIp: Internet access to the host via a public IP address, true or false. You can enable public access only if the tlsEnabled parameter is set to true.

   • networkId: ID of the network where the cluster will be deployed.

   • tlsEnabled: Support for encrypted TLS connections to the cluster, true or false.

     Warning

     You can only enable connection encryption when creating a new cluster. You cannot disable encryption for a cluster that it is enabled for.

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. Use the Cluster.Restore call and send a request, e.g., via gRPCurl:

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/redis/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "backup_id": "<backup_ID>",
             "name": "<cluster_name>",
             "environment": "<environment>",
             "config_spec": {
               "redis": {
                 "password": "<user_password>"
               }
             },
             "host_specs": [
               {
                 "zone_id": "<availability_zone>",
                 "subnet_id": "<subnet_ID>",
                 "replica_priority": "<host_priority>",
                 "assign_public_ip": <public_access_to_cluster_host>
               },
               { <similar_settings_for_host_2> },
               { ... },
               { <similar_settings_for_host_N> }
             ],
             "network_id": "<network_ID>",
             "tls_enabled": <encrypted_TLS_connection_support>
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.redis.v1.ClusterService.Restore
   

   Where:

   • backup_id: Backup ID. To find out the ID, get a list of folder backups.

   • name: Cluster name.

   • environment: Environment, PRESTABLE or PRODUCTION.

   • config_spec.redis.password: Password.

   • host_specs: Host settings:

     • zone_id: Availability zone.
     • subnet_id: Subnet ID. Specify it if the selected availability zone has two or more subnets.
     • replica_priority: Host priority for assignment as a master if the primary master fails.
     • assign_public_ip: Internet access to the host via a public IP address, true or false. You can enable public access only if the tlsEnabled parameter is set to true.

   • network_id: ID of the network where the cluster will be deployed.

   • tls_enabled: Support for encrypted TLS connections to the cluster, true or false.

     Warning

     You can only enable connection encryption when creating a new cluster. You cannot disable encryption for a cluster that it is enabled for.

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 create a cluster backup:

1. See the description of the CLI command for creating a Valkey™ backup:

   yc managed-redis cluster backup --help
   

2. Send a request to create a cluster backup, specifying the cluster name or ID:

   yc managed-redis cluster backup my-rd-cluster
   

   You can get the cluster name and ID from the list of clusters.

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

   export IAM_TOKEN="<IAM_token>"
   

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

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

   You can request 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 save 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. Use the ClusterService.Backup call and send the following request, e.g., via gRPCurl:

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

   You can request 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 get the list of Valkey™ cluster backups available in the default folder, run this command:

yc managed-redis backup list

Result:

+--------------------------+---------------------+----------------------+---------------------+
|            ID            |     CREATED AT      |  SOURCE CLUSTER ID   |     STARTED AT      |
+--------------------------+---------------------+----------------------+---------------------+
| c9qlk4v13uq7********:... | 2020-08-10 12:00:00 | c9qlk4v13uq7******** | 2020-08-10 11:55:17 |
| c9qpm90p3pcg********:... | 2020-08-09 22:01:04 | c9qpm90p3pcg******** | 2020-08-09 21:30:00 |
+--------------------------+---------------------+----------------------+---------------------+

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

   export IAM_TOKEN="<IAM_token>"
   

2. To get a list of cluster backups:

   1. Call the Cluster.ListBackups method, e.g., via the following cURL request:

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

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

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

3. To get the list of backups for all clusters in the folder:

   1. Call the Backup.List method, e.g., via the following cURL request:

      curl \
          --request GET \
          --header "Authorization: Bearer $IAM_TOKEN" \
          --url 'https://mdb.api.cloud.yandex.net/managed-redis/v1/backups' \
          --url-query folderId=<folder_ID>
      

      You can request the folder ID with the list of folders in the cloud.

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

1. Get an IAM token for API authentication and save 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. To get a list of cluster backups:

   1. Use the ClusterService.ListBackups call and send the following request, e.g., via gRPCurl:

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

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

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

4. To get the list of backups for all clusters in the folder:

   1. Use the BackupService.List call and send the following request, e.g., via gRPCurl:

      grpcurl \
          -format json \
          -import-path ~/cloudapi/ \
          -import-path ~/cloudapi/third_party/googleapis/ \
          -proto ~/cloudapi/yandex/cloud/mdb/redis/v1/backup_service.proto \
          -rpc-header "Authorization: Bearer $IAM_TOKEN" \
          -d '{
                "folder_id": "<folder_ID>"
              }' \
          mdb.api.cloud.yandex.net:443 \
          yandex.cloud.mdb.redis.v1.BackupService.List
      

      You can request the folder ID with the list of folders in the cloud.

   2. 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 get information about a Valkey™ cluster backup, run this command:

yc managed-redis backup get <backup_ID>

You can get the backup ID with the list of backups.

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

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Backup.Get method, e.g., via the following cURL request:

   curl \
       --request GET \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --url 'https://mdb.api.cloud.yandex.net/managed-redis/v1/backups/<backup_ID>'
   

   You can request the backup ID together with the list of backups.

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

1. Get an IAM token for API authentication and save 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. Use the BackupService.Get call and send the following request, e.g., via gRPCurl:

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/redis/v1/backup_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "backup_id": "<backup_ID>"
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.redis.v1.BackupService.Get
   

   You can request the backup ID together with the list of backups.

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

To set the backup start time, use the --backup-window-start flag. You must specify the time in HH:MM:SS format.

yc managed-redis cluster create \
  --name <cluster_name> \
  --environment <environment> \
  --network-name <network_name> \
  --host zone-id=<availability_zone>,subnet-id=<subnet_ID> \
  --backup-window-start 10:25:00

Where --environment is the environment, either prestable or production.

To change the backup start time for an existing cluster, use the update command:

yc managed-redis cluster update \
   --name <cluster_name> \
   --backup-window-start 11:25:00

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

   export IAM_TOKEN="<IAM_token>"
   

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

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the updateMask parameter as a single comma-separated string.

   curl \
       --request PATCH \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.cloud.yandex.net/managed-redis/v1/clusters/<cluster_ID>' \
       --data '{
                 "updateMask": "configSpec.backupWindowStart",
                 "configSpec": {
                   "backupWindowStart": {
                     "hours": "<hours>",
                     "minutes": "<minutes>",
                     "seconds": "<seconds>",
                     "nanos": "<nanoseconds>"
                   }
                 }
               }'
   

   Where:

   • updateMask: Comma-separated list of settings you want to update.

     Here, we provide only one setting.

   • configSpec.backupWindowStart: Backup window settings.

     Here, specify the backup start time:

     • hours: Between 0 and 23 hours.
     • minutes: Between 0 and 59 minutes.
     • seconds: Between 0 and 59 seconds.
     • nanos: Between 0 and 999999999 nanoseconds.

   You can request 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 save 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. Use the ClusterService.Update call and send the following request, e.g., via gRPCurl:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the update_mask parameter as an array of paths[] strings.

   Format for listing settings

   "update_mask": {
       "paths": [
           "<setting_1>",
           "<setting_2>",
           ...
           "<setting_N>"
       ]
   }
   

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/redis/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "update_mask": {
               "paths": [ "config_spec.backup_window_start" ]
             },
             "config_spec": {
               "backup_window_start": {
                 "hours": "<hours>",
                 "minutes": "<minutes>",
                 "seconds": "<seconds>",
                 "nanos": "<nanoseconds>"
               }
             } 
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.redis.v1.ClusterService.Update
   

   Where:

   • update_mask: List of settings you want to update as an array of strings (paths[]).

     Here, we provide only one setting.

   • config_spec.backup_window_start: Backup window settings.

     Here, specify the backup start time:

     • hours: Between 0 and 23 hours.
     • minutes: Between 0 and 59 minutes.
     • seconds: Between 0 and 59 seconds.
     • nanos: Between 0 and 999999999 nanoseconds.

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

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