Skip to content

Commit ca8f9ab

Browse files
darjisagar7Sagar Darjikolchfa-awsnatebower
authored andcommitted
Updating the Cross Cluster Replication documentation for the index le… (opensearch-project#11496)
* Updating the Cross Cluster Replication documentation for the index level ops batch size setting Signed-off-by: Sagar Darji <[email protected]> * Apply suggestions from code review Signed-off-by: kolchfa-aws <[email protected]> * Update _tuning-your-cluster/replication-plugin/settings.md Signed-off-by: Nathan Bower <[email protected]> --------- Signed-off-by: Sagar Darji <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Signed-off-by: Nathan Bower <[email protected]> Co-authored-by: Sagar Darji <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Arya Soni <[email protected]>
1 parent 421b438 commit ca8f9ab

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

_tuning-your-cluster/replication-plugin/settings.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ redirect_from:
99

1010
# Replication settings
1111

12-
The replication plugin adds several settings to the standard OpenSearch cluster settings.
12+
The replication plugin adds several settings to the standard OpenSearch cluster and index settings.
1313
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/).
1414

1515
You can mark settings as `persistent` or `transient`.
@@ -25,17 +25,26 @@ PUT _cluster/settings
2525
}
2626
```
2727

28-
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.
28+
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.
29+
30+
## Cluster-level settings
31+
32+
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.
2933

3034
Setting | Default | Description
3135
:--- | :--- | :---
32-
`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/).
33-
`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.
34-
`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.
3536
`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.
3637
`plugins.replication.autofollow.fetch_poll_interval` | 30s | How often auto-follow tasks poll the leader cluster for new matching indexes.
3738
`plugins.replication.follower.metadata_sync_interval` | 60s | How often the follower cluster polls the leader cluster for updated index metadata.
3839
`plugins.replication.translog.retention_lease.pruning.enabled` | true | If enabled, prunes the translog based on retention leases on the leader index.
3940
`plugins.replication.translog.retention_size` | 512 MB | Controls the size of the translog on the leader index.
4041
`plugins.replication.replicate.delete_index` | false | If enabled, the follower index is automatically deleted whenever the corresponding leader index is deleted.
42+
`plugins.replication.follower.index.ops_batch_size` | 50000 | The number of operations that can be fetched at a time during the sync phase of replication.
43+
44+
## Index-level settings
4145

46+
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.
47+
48+
Setting | Default | Description
49+
:--- |:------| :---
50+
`index.plugins.replication.follower.ops_batch_size` | 50000 | The number of operations that can be fetched at a time during the sync phase of replication for the specific index. This setting overrides the cluster-level setting.

0 commit comments

Comments
 (0)