generated from amazon-archives/__template_Apache-2.0
-
Notifications
You must be signed in to change notification settings - Fork 626
Updating the Cross Cluster Replication documentation for the index le… #11496
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
Open
darjisagar7
wants to merge
1
commit into
opensearch-project:main
Choose a base branch
from
darjisagar7:CrossClusterDocumentation
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -9,7 +9,7 @@ redirect_from: | |||||
|
|
||||||
| # Replication settings | ||||||
|
|
||||||
| The replication plugin adds several settings to the standard OpenSearch cluster settings. | ||||||
| The replication plugin adds several settings to the standard OpenSearch cluster and index settings. | ||||||
| The settings are dynamic, so you can change the default behavior of the plugin without restarting your cluster. To learn more about static and dynamic settings, see [Configuring OpenSearch]({{site.url}}{{site.baseurl}}/install-and-configure/configuring-opensearch/index/). | ||||||
|
|
||||||
| You can mark settings as `persistent` or `transient`. | ||||||
|
|
@@ -25,17 +25,26 @@ PUT _cluster/settings | |||||
| } | ||||||
| ``` | ||||||
|
|
||||||
| These settings manage the resources consumed by remote recoveries. We don’t recommend changing these settings; the defaults should work well for most use cases. | ||||||
| These settings manage the resources consumed by remote recoveries. We don't recommend changing these settings; the defaults should work well for most use cases. | ||||||
|
|
||||||
| ## Cluster-level settings | ||||||
|
|
||||||
| You can specify these settings at the cluster level to control the default behavior of replication across all indexes in the cluster. These settings apply globally unless overridden by index-level settings. | ||||||
|
|
||||||
| Setting | Default | Description | ||||||
| :--- | :--- | :--- | ||||||
| `plugins.replication.follower.index.recovery.chunk_size` | 10 MB | The chunk size requested by the follower cluster during file transfer. Specify the chunk size as a value and unit, for example, 10 MB, 5 KB. See [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/). | ||||||
| `plugins.replication.follower.index.recovery.max_concurrent_file_chunks` | 4 | The number of file chunk requests that can be sent in parallel for each recovery. | ||||||
| `plugins.replication.follower.index.ops_batch_size` | 50000 | The number of operations that can be fetched at a time during the syncing phase of replication. | ||||||
| `plugins.replication.follower.concurrent_readers_per_shard` | 2 | The number of concurrent requests from the follower cluster per shard during the syncing phase of replication. | ||||||
| `plugins.replication.autofollow.fetch_poll_interval` | 30s | How often auto-follow tasks poll the leader cluster for new matching indexes. | ||||||
| `plugins.replication.follower.metadata_sync_interval` | 60s | How often the follower cluster polls the leader cluster for updated index metadata. | ||||||
| `plugins.replication.translog.retention_lease.pruning.enabled` | true | If enabled, prunes the translog based on retention leases on the leader index. | ||||||
| `plugins.replication.translog.retention_size` | 512 MB | Controls the size of the translog on the leader index. | ||||||
| `plugins.replication.replicate.delete_index` | false | If enabled, the follower index is automatically deleted whenever the corresponding leader index is deleted. | ||||||
| `plugins.replication.follower.index.ops_batch_size` | 50000 | The number of operations that can be fetched at a time during the syncing phase of replication. | ||||||
|
|
||||||
| ## Index-level settings | ||||||
|
|
||||||
| You can specify these settings when creating a follower index or update them for existing follower indexes. These settings control the behavior of individual indexes during replication. | ||||||
|
|
||||||
| Setting | Default | Description | ||||||
| :--- |:------| :--- | ||||||
| `index.plugins.replication.follower.ops_batch_size` | 50000 | The number of operations that can be fetched at a time during the syncing phase of replication for the specific index. This setting overrides the cluster level setting. | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.