Skip to content

Commit

Permalink
Mark docrep to remote migration as GA and modify settings names
Browse files Browse the repository at this point in the history 
Signed-off-by: Gaurav Bafna <gbbafna@amazon.com>
  • Loading branch information
@gbbafna
gbbafna committed Jun 10, 2024
1 parent a7cf8d8 commit d411609
Showing 1 changed file with 22 additions and 20 deletions.
42 changes: 22 additions & 20 deletions _tuning-your-cluster/availability-and-recovery/remote-store/migrating-to-remote.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@ grand_parent: Availability and recovery

# 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](https://github.com/opensearch-project/OpenSearch/issues/7986).
{: .warning}

Introduced 2.14
{: .label .label-purple }

Expand All @@ -24,9 +21,9 @@ Rolling upgrades, sometimes referred to as *node replacement upgrades*, can be p

Review [Upgrading OpenSearch]({{site.url}}{{site.baseurl}}/upgrade-opensearch/index/) 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.
Before migrating to remote-backed storage, upgrade to OpenSearch 2.15.

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.
As of OpenSearch 2.15, 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.
{: .important}

## Performing the upgrade
Expand Down Expand Up @@ -105,14 +102,14 @@ As of OpenSearch 2.14, OpenSearch nodes cannot be migrated back to document repl
}
```

1. 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. Set the `cluster.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:

```json
PUT "/_cluster/settings?pretty"
{
"persistent": {
"remote_store.compatibility_mode": "mixed",
"migration.direction" : "remote_store"
"cluster.remote_store.compatibility_mode": "mixed",
"cluster.migration.direction" : "remote_store"
}
}
```
Expand All @@ -121,13 +118,15 @@ As of OpenSearch 2.14, OpenSearch nodes cannot be migrated back to document repl
```json
{
"acknowledged" : true,
"persistent" : {
"remote_store" : {
"compatibility_mode" : "mixed",
"migration.direction" : "remote_store"
"persistent" : {
"cluster" : {
"remote_store" : {
"compatibility_mode" : "mixed",
"migration.direction" : "remote_store"
}
},
"transient" : { }
}
}
}
```

Expand Down Expand Up @@ -233,8 +232,8 @@ As of OpenSearch 2.14, OpenSearch nodes cannot be migrated back to document repl
PUT "/_cluster/settings?pretty"
{
"persistent": {
"remote_store.compatibility_mode": strict,
"migration.direction" : none
"cluster.remote_store.compatibility_mode": null,
"cluster.migration.direction" : null
}
}
```
Expand All @@ -243,7 +242,10 @@ As of OpenSearch 2.14, OpenSearch nodes cannot be migrated back to document repl
```json
{
"acknowledged" : true,
"persistent" : { strict },
"persistent" : {
"cluster.remote_store.compatibility_mode": null,
"cluster.migration.direction" : null
},
"transient" : { }
}
```
Expand All @@ -255,8 +257,8 @@ The migration to the remote store is now complete.

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

| Field | Data type | Description |
| :--- |:--- |:---|
| `remote_store.compatibility_mode` | String | When 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.direction` | String | Creates new shards only on remote-backed storage nodes. Default is `None`. |
| Field | Data type | Description |
|:------------------------------------------|:--- |:---|
| `cluster.remote_store.compatibility_mode` | String | When 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`. |
| `cluster.migration.direction` | String | Creates new shards only on remote-backed storage nodes. Default is `None`. |

Check failure on line 263 in _tuning-your-cluster/availability-and-recovery/remote-store/migrating-to-remote.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.SpacingPunctuation] There should be no space before and one space after the punctuation mark in 'nodes. Default'.

Raw Output:
{"message": "[OpenSearch.SpacingPunctuation] There should be no space before and one space after the punctuation mark in 'nodes. Default'.", "location": {"path": "_tuning-your-cluster/availability-and-recovery/remote-store/migrating-to-remote.md", "range": {"start": {"line": 263, "column": 106}}}, "severity": "ERROR"}

0 comments on commit d411609

Please sign in to comment.