Inline Upgrade for OpenSearch Clusters

Search with OpenSearch supports several concurrent versions of OpenSearch.

When you create a cluster, by default, it's based on the latest supported version of OpenSearch. For existing clusters using older versions, you can upgrade the cluster to use the functionality available in the latest version of OpenSearch.

The upgrade process depends on whether you're doing a major version upgrade or a minor version upgrade. A major version upgrade is indicated by a change in the first number in the build number, for example, 1.2.4 to 2.3.0. A minor version upgrade is indicated by a change in the second number in the build number, for example, 2.3.0 to 2.11. For more information about OpenSearch releases, see Supported Versions.

When you're doing a minor version upgrade, you can use the inline upgrade functionality described in this topic, using the steps covered in Performing a Minor Build Version Upgrade for an OpenSearch Cluster.

For major version upgrades, you need to use the process described in Upgrading an OpenSearch Cluster.

After the inline upgrade process is started, you can't stop or cancel the process, so we recommend that you create a backup of the cluster you're upgrading.

Limitations and Considerations

  • After the inline upgrade process is started, you can't stop or cancel the process, so we recommend that you create a backup of the cluster you're upgrading, see Prerequisites.

  • You can only upgrade a cluster to a newer OpenSearch version, you can't downgrade to an older OpenSearch version.

  • Inline upgrade only works for minor version upgrades. For major version upgrades, see Upgrading an OpenSearch Cluster.

Supported Upgrade Paths for Inline Upgrade

Pre Upgrade Version Post Upgrade Version
2.3 2.11

You can check whether a cluster is upgrade eligible in the Console using the following steps:

  1. Open the navigation menu and click Databases. Under OpenSearch, click Clusters.

  2. Under List scope, select the compartment that contains the cluster.

  3. In the Clusters list, any clusters that are upgrade eligible include the text Upgrade in the Software version column.

Prerequisites

Before you begin the inline upgrade, we recommend that you create a backup of the cluster. You can create a backup by using the Snapshot API or by using the process described in Creating an OpenSearch Cluster Backup.

Next Steps

See Performing a Minor Build Version Upgrade for an OpenSearch Cluster for how to do an inline upgrade using the Console, CLI, or API.