Upgrading the OpenSearch version
You can update a Managed Service for OpenSearch cluster to a newer OpenSearch version.
To learn more about updates within a single version and host maintenance, see Maintenance.
Viewing a list of available versions
In the management console
Before updating the version
Make sure the update does not affect your applications:
- See the OpenSearch changelog
to check how updates might affect your applications. - Try updating the version on a test cluster. You can deploy it from a backup of the main cluster.
- Create a backup of the main cluster before updating the version.
Updating the version
- In the management console
, go to the folder page and select Managed Service for OpenSearch. - Select a cluster and click Edit.
- In the Version field, select the appropriate OpenSearch version.
- Click Save.
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.
-
Get the name and ID of the cluster you need with the list of all OpenSearch clusters:
yc managed-opensearch cluster list
-
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>
-
Update the OpenSearch version:
yc managed-opensearch cluster update <cluster_name_or_ID> \ --version <OpenSearch_version>
-
Open the current Terraform configuration file with an infrastructure plan.
For more information about how to create this file, see Creating clusters.
For a complete list of available Managed Service for OpenSearch cluster configuration fields, see the Terraform provider documentation
. -
In the cluster description, change the value of the
version
parameter underconfig
. If there is no such parameter, add it.resource "yandex_mdb_opensearch_cluster" "<cluster_name>" { ... config { version = "<OpenSearch_version>" ... } }
-
Make sure the settings are correct.
-
Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.
-
Run the command:
terraform validate
If there are errors in the configuration files, Terraform will point to them.
-
-
Confirm updating the resources.
-
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.
-
If you are happy with the planned changes, apply them:
-
Run the command:
terraform apply
-
Confirm the update of resources.
-
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 } }
-
Use the update API method and include the following in the request:
- Cluster ID in the
clusterId
parameter. To find out the cluster ID, get a list of clusters in the folder. - New OpenSearch version in the
configSpec.version
parameter. - List of cluster configuration fields to update in the
updateMask
parameter (in this case,configSpec.version
).
Warning
This API method overrides all parameters of the object being modified that were not explicitly passed in the request to the default values. To avoid this, list the settings you want to change in the updateMask
parameter (one line separated by commas).