Updating the Elasticsearch version and edition

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.

1. Get a list of your Elasticsearch clusters:

   yc managed-elasticsearch cluster list
   

2. Get information about the cluster you need and check the version in the config.version property:

   yc managed-elasticsearch cluster get <cluster_name_or_ID>
   

3. Update the version:

   yc managed-elasticsearch cluster update <cluster_name_or_ID> --version <Elasticsearch_version>
   

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

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

   For a complete list of available Managed Service for Elasticsearch cluster configuration fields, see the Terraform provider documentation.

2. To the Managed Service for Elasticsearch cluster description, add the config.version field or change its value if it is already there:

   resource "yandex_mdb_elasticsearch_cluster" "<cluster_name>" {
     ...
     config {
       version = "<Elasticsearch_version>"
     }
   }
   

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.

   Time limits

   A Terraform provider sets the timeout for Managed Service for Elasticsearch cluster operations:

   • Creating a cluster, including by restoring one from a backup: 30 minutes.
   • Editing a cluster: 60 minutes.
   • Deleting a cluster: 15 minutes.

   Operations exceeding the set timeout are interrupted.

   How do I change these limits?

   Add the timeouts block to the cluster description, for example:

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

To update a version, use the update REST API method for the Cluster resource or the ClusterService/Update gRPC API call and provide the following in the request:

• Cluster ID in the clusterId parameter.

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

• New Elasticsearch version in the configSpec.version parameter.

• List of updatable cluster configuration fields in the updateMask parameter (in this case, configSpec.version).

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.

1. Get a list of your Elasticsearch clusters:

   yc managed-elasticsearch cluster list
   

2. Get information about the cluster you need and check the edition in the config.edition property:

   yc managed-elasticsearch cluster get <cluster_name_or_ID>
   

3. Update the edition:

   yc managed-elasticsearch cluster update <cluster_name_or_ID> \
      --edition <Elasticsearch_edition>
   

   Where --edition is the Elasticsearch edition, basic or platinum.

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

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

2. Add the config.edition field to the Managed Service for Elasticsearch cluster description or edit it if the field already exists:

   resource "yandex_mdb_elasticsearch_cluster" "<cluster_name>" {
     ...
     config {
       edition = "<Elasticsearch_edition>"
       ...
     }
     ...
   }
   

   Where edition is the Elasticsearch edition, basic or platinum.

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_elasticsearch_cluster" "<cluster_name>" {
  ...
  timeouts {
    create = "1h30m" # 1 hour 30 minutes
    update = "2h"    # 2 hours
    delete = "30m"   # 30 minutes
  }
}

To update the Elasticsearch edition, use the update REST API method for the Cluster resource or the ClusterService/Update gRPC API call and provide the following in the request:

• Cluster ID in the clusterId parameter.

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

• New Elasticsearch edition in the configSpec.edition parameter.

• List of updatable cluster configuration fields in the updateMask parameter (in this case, configSpec.edition).