Oracle Cloud Infrastructure Documentation

OpenSearch Cluster Software Upgrades

Upgrade a cluster's software version with an inline software upgrade.

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 using the inline software upgrade feature.

Note the following limitations and considerations regarding inline upgrades:

  • After the inline upgrade process is started, you can't stop or cancel the process. 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.

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

  • OpenSearch nodes and indexes are backward compatible with the previous major version.

  • To move from Elastic search 6.8 to 2.x, first upgrade to OpenSearch 1.x. Next, re-create your indexes using the Reindex API. Finally, upgrade to 2.x.

Supported Upgrade Paths for Inline Upgrade

Pre Upgrade Version Post Upgrade Version
2.3 2.11
2.11 2.15

Access the Clusters list in the Console to check whether a cluster is eligible for a software upgrade. Any clusters that are upgrade eligible include the text Upgrade in the Software version column. For instructions on accessing the Clusters list, see Listing OpenSearch Clusters.

    1. On the Clusters list page, find the cluster that you want to work with. If you need help finding the list page or the cluster, see Listing OpenSearch Clusters.
    2. From the Actions menu for the cluster, select Upgrade.
    3. On the Upgrade panel, select one of the following options:

      Upgrade current cluster: Upgrades the version of this cluster. Major version upgrades might have downtime.

      Create a clone and apply upgrade to clone: Use this feature to apply the upgrade to a clone so you can run tests.

    4. Select the software version from the Available software versions list. The current version is initially displayed.
    5. Select Upgrade.

  • Use the oci opensearch cluster upgrade command and required parameters to perform an inline (minor build version) upgrade for a cluster. Configure the is-clone parameter as false or true to specify whether you're upgrading the current cluster or are creating a clone of the cluster and am applying the upgrade to the clone.

    Run the following command to upgrade the current cluster:

    oci opensearch cluster upgrade --opensearch-cluster-id cluster_ocid --desired-software-version desired_OpenSearch_version 
--original_cluster_display_name original_cluster_display_name --upgrade-type MINOR --is-clone false [OPTIONS]

    Run the following command to create a clone and apply the upgrade to the clone:

    oci opensearch cluster upgrade --opensearch-cluster-id cluster_ocid --desired-software-version desired_OpenSearch_version 
--original_cluster_display_name original_cluster_display_name --upgrade-type MINOR --is-clone true [OPTIONS]

    The original_cluster_display_name parameter is required to validate that the cluster ID has the same display name.

    The value for upgrade-type must be MINOR.

    For a complete list of flags and variable options for CLI commands, see the Command Line Reference.

  • Run the UpgradeOpenSearchCluster operation to perform an inline software upgrade for a cluster. Configure the upgradeType as Minor.