Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Document Segment Replication Feature. #989

Closed
1 of 4 tasks
mch2 opened this issue Aug 24, 2022 · 0 comments · Fixed by #1163
Closed
1 of 4 tasks

[DOC] Document Segment Replication Feature. #989

mch2 opened this issue Aug 24, 2022 · 0 comments · Fixed by #1163
Assignees
Labels
Closed - Complete Issue: Work is done and associated PRs closed v2.3.0
Milestone

Comments

@mch2
Copy link
Member

mch2 commented Aug 24, 2022

What do you want to do?

  • Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • Other

Tell us about your request. Provide a summary of the request and all versions that are affected.
With 2.3 we are looking to release an experimental version of the segment replication feature.
Design proposal - opensearch-project/OpenSearch#2229
RFC - opensearch-project/OpenSearch#1694 (comment)

As an experimental feature, it will be behind a feature flag that must be enabled on each node of a cluster in addition to setting the replication strategy during index creation.

To enable the feature flag:
For developers to enable with Gradle run:
Update run.gradle with:

testClusters {
  runTask {
    testDistribution = 'archive'
    if (numZones > 1) numberOfZones = numZones
    if (numNodes > 1) numberOfNodes = numNodes
    systemProperty 'opensearch.experimental.feature.replication_type.enabled', 'true'
  }
}

To enable on a node using a tarball:
option 1. Update config/jvm.options with:
-Dopensearch.experimental.feature.replication_type.enabled=true

option 2. include the flag in OPENSEARCH_JAVA_OPTS before ./bin/opensearch

OPENSEARCH_JAVA_OPTS="-Dopensearch.experimental.feature.replication_type.enabled=true" ./opensearch-3.0.0/bin/opensearch

option 3: Specify OPENSEARCH_JAVA_OPTS env var.

export OPENSEARCH_JAVA_OPTS="-Dopensearch.experimental.feature.replication_type.enabled=true"
./bin/opensearch

Setting replication strategy on the index:

curl -X PUT "localhost:9200/<index-name>?pretty" -H 'Content-Type: application/json' -d '{"settings" : { "index" : { "replication.type" : "SEGMENT" }}}'

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.

@mch2 mch2 added the untriaged label Aug 24, 2022
@Naarcha-AWS Naarcha-AWS added 1 - Backlog Issue: The issue is unassigned or assigned but not started v2.3.0 and removed untriaged labels Aug 25, 2022
@Naarcha-AWS Naarcha-AWS added this to the v2.3 milestone Aug 25, 2022
@ariamarble ariamarble added 2 - In progress Issue/PR: The issue or PR is in progress. and removed 1 - Backlog Issue: The issue is unassigned or assigned but not started labels Sep 13, 2022
@ariamarble ariamarble added Closed - Complete Issue: Work is done and associated PRs closed and removed 2 - In progress Issue/PR: The issue or PR is in progress. labels Sep 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Closed - Complete Issue: Work is done and associated PRs closed v2.3.0
Projects
None yet
3 participants