Managing backups in Managed Service for Elasticsearch

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 Elasticsearch cluster backups available in the default folder, run the command:

yc managed-elasticsearch backup list

Result:

+----------------------+----------------------+----------------------+----------------------+
|          ID          |      CREATED AT      |  SOURCE CLUSTER ID   |      STARTED AT      |
+----------------------+----------------------+----------------------+----------------------+
| c9qlk4v13uq7******** | 2020-08-10T12:00:00Z | c9qlk4v13uq7******** | 2020-08-10T11:55:17Z |
| c9qpm90p3pcg******** | 2020-08-09T22:01:04Z | c9qpm90p3pcg******** | 2020-08-09T21:30:00Z |
+----------------------+----------------------+----------------------+----------------------+

To get a list of cluster backups, use the listBackups REST API method for the Cluster resource or the ClusterService/ListBackups gRPC API call and provide the cluster ID in the clusterId parameter of your request.

To get a list of backups for all the Managed Service for Elasticsearch clusters in the folder, use the list REST API method for the Backup resource or the BackupService/List gRPC API call and provide the folder ID in the folderId parameter of your request.

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

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 information about a Elasticsearch cluster backup, run the command:

yc managed-elasticsearch backup get <backup_ID>

You can retrieve the backup ID with a list of backups.

To get information about a backup, use the get REST API method for the Backup resource or the BackupService/Get gRPC API call and provide the backup ID in the backupId parameter of your request.

To find out the ID, retrieve a list of backups.

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

1. View a description of the CLI create Elasticsearch backup command:

   yc managed-elasticsearch cluster backup --help
   

2. Request a backup to be created by specifying the cluster name or ID:

   yc managed-elasticsearch cluster backup <cluster_name_or_ID>
   

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

To create a backup, use the backup REST API method for the Cluster resource or the ClusterService/Backup gRPC API call and provide the cluster ID in the clusterId parameter of your request.

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

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

1. View a description of the CLI restore Elasticsearch cluster command:

   yc managed-elasticsearch cluster restore --help
   

2. Getting a list of available Elasticsearch cluster backups:

   yc managed-elasticsearch backup list
   

   Result:

   +--------------------------+----------------------+----------------------+----------------------+
   |            ID            |      CREATED AT      |  SOURCE CLUSTER ID   |      STARTED AT      |
   +--------------------------+----------------------+----------------------+----------------------+
   | c9qlk4v13uq79r9********  | 2020-08-10T12:00:00Z | c9qlk4v13uq7******** | 2020-08-10T11:55:17Z |
   | ...                                                                                           |
   +--------------------------+----------------------+----------------------+----------------------+
   

   The backup completion time is shown in the CREATED AT column of the list of available backups, in yyyy-mm-ddThh:mm:ssZ format (2020-08-10T12:00:00Z in the example above).

3. Request the creation of a cluster from a backup:

   yc managed-elasticsearch cluster restore \
      --backup-id=<backup_ID> \
      --name=<cluster_name> \
      --environment=<environment> \
      --network-name=<network_name> \
      --host zone-id=<availability_zone>,`
            `subnet-id=<subnet_ID>,`
            `assign-public-ip=<public_access>,`
            `type=<host_role> \
      --datanode-resource-preset=<Data_node_host_class> \
      --datanode-disk-size=<Data_node_storage_size_in_GB> \
      --datanode-disk-type=<Data_node_disk_type> \
      --masternode-resource-preset=<Master_node_host_class> \
      --masternode-disk-size=<Master_node_storage_size_in_GB> \
      --masternode-disk-type=<Master_node_disk_type> \
      --admin-password=<admin_user_password>
   

   Where:

   • --backup-id: Backup ID.

   • --name: Cluster name.

   • --environment: Environment:

     • PRESTABLE: For testing purposes. The prestable environment is similar to the production environment and likewise covered by the SLA, but it is the first to get new functionalities, improvements, and bug fixes. In the prestable environment, you can test compatibility of new versions with your application.
     • PRODUCTION: For stable versions of your apps.

   • --network-name: Network name.

   • --host: Host parameters:

     • zone-id: Availability zone.

     • subnet-name: Subnet name. Specify if two or more subnets are created in the selected availability zone.

     • assign-public-ip: Flag indicating that the host requires public access, true or false.

     • type: Host role: datanode or masternode.

   • --datanode-resource-preset: Class of hosts with the Data node role.

   • --datanode-disk-size: Storage size in GB for hosts with the Data node role.

   • --datanode-disk-type: Disk type for hosts with the Data node role:

     • network-hdd
     • network-ssd
     • local-ssd
     • network-ssd-nonreplicated

   • --masternode-resource-preset: Class of hosts with the Master node role.

   • --masternode-disk-size: Storage size in GB for hosts with the Master node role.

   • --masternode-disk-type: Disk type for hosts with the Master node role. Only network-ssd is available.

   • --admin-password: admin user password.

     This is a special user that is required for managing clusters and cannot be deleted. It is assigned the superuser role and can perform any operations on clusters.

     Tip

     To perform routine tasks, we recommend creating individual users. For more information, see Managing users.

To restore a cluster from a backup, use the restore REST API method for the Cluster resource or the ClusterService/Restore gRPC API call and provide the following in the request:

• ID of the backup you need, in the backupId parameter. To find out the ID, get a list of cluster backups.
• Name of the new cluster that will contain the data recovered from the backup, in the name parameter. It must be unique within the folder.
• Cluster environment in the environment parameter.
• Cluster configuration in the configSpec parameter.
• Configuration of the cluster hosts in one or more hostSpecs parameters.
• Network ID in the networkId parameter.