From e2a6c2dd3d03ce2c23943fa3a39bedc1b6687571 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Mon, 10 Nov 2025 20:19:24 +0000 Subject: [PATCH] =?UTF-8?q?Updating=20the=20Cross=20Cluster=20Replication?= =?UTF-8?q?=20documentation=20for=20the=20index=20le=E2=80=A6=20(#11496)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Updating the Cross Cluster Replication documentation for the index level ops batch size setting Signed-off-by: Sagar Darji * Apply suggestions from code review Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _tuning-your-cluster/replication-plugin/settings.md Signed-off-by: Nathan Bower --------- Signed-off-by: Sagar Darji Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Nathan Bower Co-authored-by: Sagar Darji Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower (cherry picked from commit 48176ac3adbf6250e8015023734b400418b66780) Signed-off-by: github-actions[bot] --- .../replication-plugin/settings.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/_tuning-your-cluster/replication-plugin/settings.md b/_tuning-your-cluster/replication-plugin/settings.md index 1a9162fd2ba..080980f0d97 100644 --- a/_tuning-your-cluster/replication-plugin/settings.md +++ b/_tuning-your-cluster/replication-plugin/settings.md @@ -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 sync 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 sync phase of replication for the specific index. This setting overrides the cluster-level setting.