All Products
Search
Document Center

OpenSearch:Upgrade or downgrade the configurations of an instance

Last Updated:May 12, 2025

This topic describes how to upgrade or downgrade the configurations of an OpenSearch Vector Search Edition instance and provides the related precautions.

Usage notes

Configuration item

Description

Number of Query Result Searcher (QRS) workers

You can increase or decrease the number of QRS workers.

If you want to decrease the number of QRS workers, make sure that the number of QRS workers after the decrease is greater than or equal to the number of QRS workers that are being used. This will be verified in the console, and related information will be displayed after the verification.

For example, if your instance contains 10 QRS workers and four QRS workers are being used, you can decrease the number of QRS workers by six at most.

Specifications of QRS workers

You can upgrade only specifications for QRS workers. The number of CPU cores and memory capacity of an upgraded QRS worker must be greater than or equal to those of the original QRS worker.

Important
  • During the change of the number of QRS workers from 0 to a value greater than 0, data losses may be inevitable, and the service is unavailable. Proceed with caution.

  • After the change is complete, the status of QRS workers and Searcher workers changes to 100% in the console and the service becomes available.

Number of Searcher workers

You can increase or decrease the number of Searcher workers.

If you want to decrease the number of Searcher workers, make sure that the number of Searcher workers after the decrease is greater than or equal to the number of Searcher workers that are being used. This will be verified in the console, and related information will be displayed after the verification.

For example, if your instance contains 10 Searcher workers and six Searcher workers are being used, you can decrease the number of Searcher workers by four at most.

Specifications of Searcher workers

You can upgrade only specifications for Searcher workers. The number of CPU cores and memory capacity of an upgraded Searcher worker must be greater than or equal to those of the original Searcher worker.

Availability edition

You can switch the availability edition of an instance between Standard Edition and High-availability Edition.

  • Standard Edition: Workers are deployed in a single zone. In this case, cross-zone disaster recovery is not supported.

  • High-availability Edition: Workers are deployed in multiple zones. In this case, cross-zone disaster recovery is supported, which enables higher availability. If a zone fails, traffic can be switched to another zone.

Table storage mode

Data storage and queries in different tables share the resources of Searcher workers, such as CPU, memory, and disk resources.

image.png

The preceding figure shows two vector tables: Table 1 with four shards and Table 2 with only one shard. Data for Table 1 is evenly distributed across its shards based on the index. Table 2, having only one shard, acts as a broadcast table and stores a full index data set on each Searcher worker.

Precautions

  • The upgrade or downgrade takes effect immediately, and you are charged based on new configurations. If the status of QRS workers and Searcher workers changes to 100% on the instance details page, the service becomes available.

  • Each time you change the configurations of an instance, you can only upgrade or downgrade the configurations. You cannot upgrade some configurations and downgrade the other configurations at the same time.

    For example, your instance contains two QRS workers and two Searcher workers.

    You cannot decrease the number of QRS workers to one and increase the number of Searcher workers to three.

    You can decrease the number of QRS workers to one and decrease the number of Searcher workers to one.

    You can decrease the number of QRS workers to one and retain the number of Searcher workers.

    You can increase the number of QRS workers to three and increase the number of Searcher workers to three.

  • After the number of Searcher workers is changed, you must adjust the number of replicas on the instance details page or modify the table to adjust the number of shards for resource allocation.

  • The number of QRS workers in a single cluster is equal to the number of QRS workers per replica multiplied by the number of replicas. The number of Searcher workers in a single cluster is equal to the number of replicas multiplied by the number of shards. When you increase the number of QRS workers or Searcher workers, specify an integer multiple of the number of shards. A shard is the minimum unit for data blocks.

  • When you increase the number of workers for a single-worker instance, the instance is unavailable during the upgrade. Make sure that no query traffic is sent to the instance during the upgrade.

  • After you switch the availability edition of your instance from High-availability Edition to Standard Edition, the second cluster of the instance is deleted by default. If the configurations of the two clusters for the instance are inconsistent, the service may be affected after the switch. Therefore, proceed with caution.

  • After an upgrade or downgrade, the number of Searcher workers in a single zone must be greater than or equal to the number of Searcher workers that are being used in a single zone.

Procedure

  1. Log on to the OpenSearch Vector Search Edition console. On the Instances page, find the instance for which you want to change configurations and click Upgrade/Downgrade in the Actions column.

  2. On the configuration change page, change the availability edition, the number and specifications of QRS workers, and the number and specifications of Searcher workers based on your business requirements. Then, agree to the service terms and click Buy Now.

    image

  3. Wait until the change is complete. This indicates that the status of QRS workers and Searcher workers changes to 100%. In this case, the service becomes available.

    image