OpenSearch version upgrade

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

The folder specified when creating the CLI profile is used by default. To change the default folder, use the yc config set folder-id <folder_ID> command. You can specify a different folder using the --folder-name or --folder-id parameter.

1. Get the name and ID of the cluster you need with the list of all OpenSearch clusters:

   yc managed-opensearch cluster list
   

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

   yc managed-opensearch cluster get <cluster_name_or_ID>
   

3. Update the OpenSearch version:

   yc managed-opensearch cluster update <cluster_name_or_ID> \
      --version <OpenSearch_version>
   

1. Open the current Terraform configuration file that defines your infrastructure.

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

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

2. In the cluster description, change the version parameter value under config. If there is no such parameter, add it.

   resource "yandex_mdb_opensearch_cluster" "<cluster_name>" {
     ...
     config {
       version = "<OpenSearch_version>"
       ...
     }
   }
   

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.

   Timeouts

   The Terraform provider sets the following timeouts for Managed Service for OpenSearch cluster operations:

   • Creating a cluster, including restoring 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_opensearch_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.Update method and send the following request, e.g., via cURL:

   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-opensearch/v1/clusters/<cluster_ID>' \
       --data '{
                   "updateMask": "configSpec.version",
                   "configSpec": {
                       "version": "<OpenSearch>_version"
                   }
               }'
   

   Where:

   • updateMask: List of parameters to update as a single string, separated by commas.

     Only one parameter is provided in this case.

   • configSpec.version: New OpenSearch version.

   You can request the cluster ID with the 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.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/opensearch/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
               "cluster_id": "<cluster_ID>",
               "update_mask": {
                   "paths": [
                       "config_spec.version"
                   ]
               },
               "config_spec": {
                   "version": "<OpenSearch>_version"
               }
           }' \
   mdb.api.cloud.yandex.net:443 \
   yandex.cloud.mdb.opensearch.v1.ClusterService.Update
   

   Where:

   • update_mask: List of parameters to update as an array of paths[] strings.

     Only one parameter is provided in this case.

   • config_spec.version: New OpenSearch version.

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

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