Migrating to remote-backed storage

This is an experimental feature and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, see the associated GitHub issue.

Introduced 2.14

Remote-backed storage offers a new way to protect against data loss by automatically creating backups of all index transactions and sending them to remote storage. To use this feature, segment replication must be enabled.

You can migrate a document-replication-based cluster to remote-backed storage through the rolling upgrade mechanism.

Rolling upgrades, sometimes referred to as node replacement upgrades, can be performed on running clusters with virtually no downtime. Nodes are individually stopped and migrated in place. Alternatively, nodes can be stopped and replaced, one at a time, by remote-backed hosts. During this process you can continue to index and query data in your cluster.

Preparing to migrate

Review Upgrading OpenSearch for recommendations about backing up your configuration files and creating a snapshot of the cluster state and indexes before you make any changes to your OpenSearch cluster.

Before migrating to remote-backed storage, upgrade to OpenSearch 2.14.

As of OpenSearch 2.14, OpenSearch nodes cannot be migrated back to document replication. If you need to revert the migration, then you will need to perform a fresh installation of OpenSearch and restore the cluster from a snapshot. Take a snapshot and store it in a remote repository before beginning the upgrade procedure.

Performing the upgrade

  1. Verify the health of your OpenSearch cluster before you begin using the Cluster Health API. Resolve any index or shard allocation issues prior to upgrading to ensure that your data is preserved. A status of green indicates that all primary and replica shards are allocated. You can query the _cluster/health API endpoint using a command similar to the following:

    1. GET "/_cluster/health?pretty"

    You should receive a response similar to the following:

    1. {
    2.     "cluster_name":"opensearch-dev-cluster",
    3.     "status":"green",
    4.     "timed_out":false,
    5.     "number_of_nodes":4,
    6.     "number_of_data_nodes":4,
    7.     "active_primary_shards":1,
    8.     "active_shards":4,
    9.     "relocating_shards":0,
    10.     "initializing_shards":0,
    11.     "unassigned_shards":0,
    12.     "delayed_unassigned_shards":0,
    13.     "number_of_pending_tasks":0,
    14.     "number_of_in_flight_fetch":0,
    15.     "task_max_waiting_in_queue_millis":0,
    16.     "active_shards_percent_as_number":100.0
    17. }

  2. Disable shard replication to prevent shard replicas from being created while nodes are being taken offline. This stops the movement of Lucene index segments on nodes in your cluster. You can disable shard replication by querying the _cluster/settings API endpoint, as shown in the following example:

    1. PUT "/_cluster/settings?pretty"
    2. {
    3.     "persistent": {
    4.         "cluster.routing.allocation.enable": "primaries"
    5.     }
    6. }

    You should receive a response similar to the following:

    1. {
    2.   "acknowledged" : true,
    3.   "persistent" : {
    4.     "cluster" : {
    5.       "routing" : {
    6.         "allocation" : {
    7.           "enable" : "primaries"
    8.         }
    9.       }
    10.     }
    11.   },
    12.   "transient" : { }
    13. }

  3. Perform the following flush operation on the cluster to commit transaction log entries to the Lucene index:

    1. POST "/_flush?pretty"

    You should receive a response similar to the following:

    1. {
    2.   "_shards" : {
    3.     "total" : 4,
    4.     "successful" : 4,
    5.     "failed" : 0
    6.   }
    7. }

  4. Set the remote_store.compatibility_mode setting to mixed to allow remote-backed storage nodes to join the cluster. Then set migration.direction to remote_store, which allocates new indexes to remote-backed data nodes. The following example updates the aforementioned setting using the Cluster Settings API:

    1. PUT "/_cluster/settings?pretty"
    2. {
    3.     "persistent": {
    4.         "remote_store.compatibility_mode": "mixed",
    5.          "migration.direction" :  "remote_store"
    6.     }
    7. }

    You should receive a response similar to the following:

    1. {
    2.   "acknowledged" : true,
    3.   "persistent" : { 
    4.    "remote_store" : {
    5.    "compatibility_mode" : "mixed",
    6.    "migration.direction" :  "remote_store"
    7.    },
    8.    "transient" : { }
    9. }
    10. }

  5. Review your cluster and identify the first node to be upgraded.

  6. Provide the remote store repository details as node attributes in opensearch.yml, as shown in the following example:

    1. # Repository name
    2. node.attr.remote_store.segment.repository: my-repo-1
    3. node.attr.remote_store.translog.repository: my-repo-2
    4. node.attr.remote_store.state.repository: my-repo-3
    6. # Segment repository settings
    7. node.attr.remote_store.repository.my-repo-1.type: s3
    8. node.attr.remote_store.repository.my-repo-1.settings.bucket: <Bucket Name 1>
    9. node.attr.remote_store.repository.my-repo-1.settings.base_path: <Bucket Base Path 1>
    10. node.attr.remote_store.repository.my-repo-1.settings.region: us-east-1
    12. # Translog repository settings
    13. node.attr.remote_store.repository.my-repo-2.type: s3
    14. node.attr.remote_store.repository.my-repo-2.settings.bucket: <Bucket Name 2>
    15. node.attr.remote_store.repository.my-repo-2.settings.base_path: <Bucket Base Path 2>
    16. node.attr.remote_store.repository.my-repo-2.settings.region: us-east-1
    18. # Enable Remote cluster state cluster setting
    19. cluster.remote_store.state.enabled: true
    21. # Remote cluster state repository settings
    22. node.attr.remote_store.repository.my-remote-state-repo.type: s3
    23. node.attr.remote_store.repository.my-remote-state-repo.settings.bucket: <Bucket Name 3>
    24. node.attr.remote_store.repository.my-remote-state-repo.settings.base_path: <Bucket Base Path 3>
    25. node.attr.remote_store.repository.my-remote-state-repo.settings.region: <Bucket region>

  7. Stop the node you are migrating. Do not delete the volume associated with the container when you delete the container. The new OpenSearch container will use the existing volume. Deleting the volume will result in data loss.

  8. Deploy a new container running the same version of OpenSearch and mapped to the same volume as the container you deleted.

  9. Query the _cat/nodes endpoint after OpenSearch is running on the new node to confirm that it has joined the cluster. Wait for the cluster to become green again.

  10. Repeat steps 2 through 5 for each node in your cluster.

  11. Reenable shard replication, using a command similar to the following:

    1. PUT "/_cluster/settings?pretty"
    2. {
    3.    "persistent": {
    4.        "cluster.routing.allocation.enable": "all"
    5.    }
    6. }

    You should receive a response similar to the following:

    1. {
    2.  "acknowledged" : true,
    3.  "persistent" : {
    4.    "cluster" : {
    5.      "routing" : {
    6.        "allocation" : {
    7.          "enable" : "all"
    8.        }
    9.      }
    10.    }
    11.  },
    12.  "transient" : { }
    13. }

  12. Confirm that the cluster is healthy by using the Cluster Health API, as shown in the following command:

    1. GET "/_cluster/health?pretty"

    You should receive a response similar to the following:

    1. {
    2.  "cluster_name" : "opensearch-dev-cluster",
    3.  "status" : "green",
    4.  "timed_out" : false,
    5.  "number_of_nodes" : 4,
    6.  "number_of_data_nodes" : 4,
    7.  "discovered_master" : true,
    8.  "active_primary_shards" : 1,
    9.  "active_shards" : 4,
    10.  "relocating_shards" : 0,
    11.  "initializing_shards" : 0,
    12.  "unassigned_shards" : 0,
    13.  "delayed_unassigned_shards" : 0,
    14.  "number_of_pending_tasks" : 0,
    15.  "number_of_in_flight_fetch" : 0,
    16.  "task_max_waiting_in_queue_millis" : 0,
    17.  "active_shards_percent_as_number" : 100.0
    18. }

  13. Clear the remote_store.compatibility_mode and migration.direction settings by using the following command so that non-remote nodes are not allowed to join the cluster:

    1. PUT "/_cluster/settings?pretty"
    2. {
    3.    "persistent": {
    4.        "remote_store.compatibility_mode": strict,
    5.         "migration.direction" :  none
    6.    }
    7. }

    You should receive a response similar to the following:

    1. {
    2.  "acknowledged" : true,
    3.  "persistent" : { strict },
    4.   "transient" : { }
    5. }

The migration to the remote store is now complete.

Use the following cluster settings to enable migration to a remote-backed cluster.

FieldData typeDescription
remote_store.compatibility_modeStringWhen set to strict, only allows the creation of either non-remote or remote nodes, depending upon the initial cluster type. When set to mixed, allows both remote and non-remote nodes to join the cluster. Default is strict.
migration.directionStringCreates new shards only on remote-backed storage nodes. Default is None.