Change remote store documentation to reflect all the config options #1245
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Sachin Kale <[email protected]>
Naarcha-AWS
requested changes
Sep 16, 2022
There was a problem hiding this comment.
Thanks @sachinpkale! Just a few suggestions and we'll get this merged in.
_opensearch/remote.md
Outdated
| @@ -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 | |||
| ## Enabling the feature flag | |||
There was a problem hiding this comment.
Let's switch to "Enable the feature flag".
_opensearch/remote.md
Outdated
|
|
||
| ### Option 1: Modify jvm.options | ||
| 1. Option 1: Modify jvm.options |
There was a problem hiding this comment.
Let's keep these as H3 headers, just for consistency with the gradle option.
There was a problem hiding this comment.
These come under H3 header: Enable on a node using a tarball install so changed it to H4 header. Let me know if that is fine.
_opensearch/remote.md
Outdated
| @@ -50,7 +38,7 @@ Run OpenSearch | |||
| ./bin/opensearch | |||
| ``` | |||
|
|
|||
| ### Option 2: Enable from an environment variable | |||
| 1. Option 2: Enable from an environment variable | |||
There was a problem hiding this comment.
Same here, let's keep as an h3 heading.
_opensearch/remote.md
Outdated
| @@ -67,6 +55,32 @@ export OPENSEARCH_JAVA_OPTS="-Dopensearch.experimental.feature.replication_type. | |||
| ./bin/opensearch | |||
| ``` | |||
|
|
|||
| ### For developers using Gradle, enable feature flag by updating run.gradle | |||
There was a problem hiding this comment.
Let's rename this header to "Enable for OpenSearch development".
_opensearch/remote.md
Outdated
| } | ||
| ``` | ||
|
|
||
| ### Enable with Docker containers |
There was a problem hiding this comment.
Let's put this above the gradle section with the other two JVM options.
added 2 commits
September 19, 2022 10:32
Signed-off-by: Sachin Kale <[email protected]>
Signed-off-by: Sachin Kale <[email protected]>
Thanks @Naarcha-AWS for the review. I have addressed your comments. Please take a look again. |
Naarcha-AWS
approved these changes
Sep 19, 2022
ariamarble
approved these changes
Sep 19, 2022
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Sep 20, 2022
…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]> (cherry picked from commit 57417bb)
Naarcha-AWS
pushed a commit
that referenced
this pull request
Sep 20, 2022
…1245) (#1274) * 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]> (cherry picked from commit 57417bb) Co-authored-by: Sachin Kale <[email protected]>
macohen
pushed a commit
to macohen/documentation-website
that referenced
this pull request
Sep 21, 2022
…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]> Signed-off-by: Mark Cohen <[email protected]>
Naarcha-AWS
pushed a commit
that referenced
this pull request
Oct 6, 2022
…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]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Sachin Kale [email protected]
Description
Issues Resolved
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.