Change remote store documentation to reflect all the config options (o…

…pensearch-project#1245) * Change remote store documentation to reflect all the config options Signed-off-by: Sachin Kale <[email protected]> * Address review comments Signed-off-by: Sachin Kale <[email protected]> * Address review comments Signed-off-by: Sachin Kale <[email protected]> Signed-off-by: Sachin Kale <[email protected]> Co-authored-by: Sachin Kale <[email protected]>
alicejw1 · Sep 20, 2022 · 57417bb · 57417bb
1 parent 981ec77
commit 57417bb
Showing 1 changed file with 33 additions and 19 deletions.
diff --git a/_opensearch/remote.md b/_opensearch/remote.md
@@ -12,30 +12,18 @@ Remote-backed storage is an experimental feature. Therefore, we do not recommend
 Remote-backed storage offers OpenSearch users a new way to protect against data loss by automatically creating backups of all index transactions and sending them to remote storage. In order to expose this feature, segment replication must also be enabled. See [Segment replication]({{site.url}}{{site.baseurl}}/opensearch/segment-replication/) for additional information.
 
 
-## Enable the feature
+## Enable the feature flag
 
-To create new indexes with remote-backed storage enabled, you must first enable these features by adding the correct properties to `run.gradle` before building OpenSearch. See the [developer guide](https://github.com/opensearch-project/OpenSearch/blob/main/DEVELOPER_GUIDE.md) for information about to use how Gradle to build OpenSearch.
-
-Add the following properties to `run.gradle` to enable the feature:
-
-```bash
-testClusters {
-  runTask {
-    testDistribution = 'archive'
-    if (numZones > 1) numberOfZones = numZones
-    if (numNodes > 1) numberOfNodes = numNodes
-    systemProperty 'opensearch.experimental.feature.replication_type.enabled', 'true'
-    systemProperty 'opensearch.experimental.feature.remote_store.enabled', 'true'
-  }
-}
-```
+There are several methods for enabling remote store feature, depending on the install type. You will also need to enable `remote_store` property when creating the index.
 
 Segment replication must also be enabled to use remote-backed storage.
 {: .note}
 
-After building OpenSearch with these properties, you must enable the feature for all nodes in your cluster. This can be done by modifying a `config/jvm.options`, or by defining `OPENSEARCH_JAVA_OPS` from the command line.
+### Enable on a node using a tarball install
+
+The flag is toggled using a new jvm parameter that is set either in `OPENSEARCH_JAVA_OPTS` or in config/jvm.options.
 
-### Option 1: Modify jvm.options
+#### Option 1: Modify jvm.options
 
 Add the following lines to `config/jvm.options` before starting the OpenSearch process to enable the feature and its dependency:
 
@@ -50,7 +38,7 @@ Run OpenSearch
 ./bin/opensearch
 ```
 
-### Option 2: Enable from an environment variable
+#### Option 2: Enable from an environment variable
 
 As an alternative to directly modifying `config/jvm.options`, you can define the properties by using an environment variable. This can be done in a single command when you start OpenSearch or by defining the variable with `export`.
 
@@ -67,6 +55,32 @@ export OPENSEARCH_JAVA_OPTS="-Dopensearch.experimental.feature.replication_type.
 ./bin/opensearch
 ```
 
+### Enable with Docker containers
+
+If you're running Docker, add the following line to docker-compose.yml underneath the `opensearch-node` and `environment` section:
+
+````json
+OPENSEARCH_JAVA_OPTS="-Dopensearch.experimental.feature.replication_type.enabled=true -Dopensearch.experimental.feature.remote_store.enabled=true"
+````
+
+### Enable for OpenSearch development
+
+To create new indexes with remote-backed storage enabled, you must first enable these features by adding the correct properties to `run.gradle` before building OpenSearch. See the [developer guide](https://github.com/opensearch-project/OpenSearch/blob/main/DEVELOPER_GUIDE.md) for information about to use how Gradle to build OpenSearch.
+
+Add the following properties to `run.gradle` to enable the feature:
+
+```bash
+testClusters {
+  runTask {
+    testDistribution = 'archive'
+    if (numZones > 1) numberOfZones = numZones
+    if (numNodes > 1) numberOfNodes = numNodes
+    systemProperty 'opensearch.experimental.feature.replication_type.enabled', 'true'
+    systemProperty 'opensearch.experimental.feature.remote_store.enabled', 'true'
+  }
+}
+```
+
 ## Register a remote repository
 
 Now that your deployment is running with the feature flags enabled, the next step is to register a remote repository where backups will be stored. See [Register repository]({{site.url}}{{site.baseurl}}/opensearch/snapshots/snapshot-restore#register-repository) for more information.