Skip to content

Conversation

@Pranshu-S
Copy link
Contributor

Description

Adds documentation for enabling Async Batch Fetch on a cluster and setting Batch sizes to the gateway allocators as per the changes/optimisations done on Async Shard Fetch flow

Issues Resolved

Resolves #7055

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Pranshu-S <pranshushukla06@gmail.com>
@hdhalter
Copy link
Contributor

Thanks, @Pranshu-S ! Are these changes being released in 2.14 or should they be backported to 2.13?

@hdhalter hdhalter added the Doc review PR: Doc review in progress label Apr 30, 2024
@Pranshu-S
Copy link
Contributor Author

Thanks, @Pranshu-S ! Are these changes being released in 2.14 or should they be backported to 2.13?

This will be for 2.14.

@hdhalter hdhalter added v2.14.0 release-notes PR: Include this PR in the automated release notes labels May 2, 2024
@Naarcha-AWS Naarcha-AWS self-assigned this May 2, 2024
Signed-off-by: Pranshu-S <pranshushukla06@gmail.com>
@Pranshu-S Pranshu-S requested a review from Naarcha-AWS May 3, 2024 05:25
- `REPLICA_FIRST` – Replica shards are relocated first, before primary shards. This prioritization may help prevent a cluster's health status from going red when carrying out shard relocation in a mixed-version, segment-replication-enabled OpenSearch cluster. In this situation, primary shards relocated to OpenSearch nodes of a newer version could try to copy segment files to replica shards on an older version of OpenSearch, which would result in shard failure. Relocating replica shards first may help to avoid this in multi-version clusters.
- `NO_PREFERENCE` – The default behavior in which the order of shard relocation has no importance.

- `cluster.allocator.gateway.batch_size` (Integer): Limits the number of shards sent in one batch to data nodes for fetching metadata. Default is `2000`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we change it to -> Limits the number of shards sent in one batch to data nodes for fetching unassigned shard metadata

- `NO_PREFERENCE` – The default behavior in which the order of shard relocation has no importance.

- `cluster.allocator.gateway.batch_size` (Integer): Limits the number of shards sent in one batch to data nodes for fetching metadata. Default is `2000`.
- `cluster.allocator.existing_shards_allocator.batch_enabled` (Boolean): Enables batch allocation of unassigned shards already existing on the disk. This allows for sending all `Unassigned`shards to the `ExistingShard` allocator. The allocator decides how to allocate the unassigned shards. Default is `False`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Enables batch allocation of unassigned shards already existing on the disk as opposed to one shard at a time. This reduces the memory and transport overhead by fetching unassigned shard metadata in a batch call. Default is False.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated the wordings.

Signed-off-by: Pranshu-S <pranshushukla06@gmail.com>
Copy link
Contributor

@Naarcha-AWS Naarcha-AWS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple more small tweaks.

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
@Naarcha-AWS Naarcha-AWS added Editorial review PR: Editorial review in progress and removed Doc review PR: Doc review in progress labels May 7, 2024
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Pranshu-S @Naarcha-AWS Just a couple comments/changes. Thanks!

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
@Naarcha-AWS Naarcha-AWS merged commit 047950f into opensearch-project:main May 8, 2024
@hdhalter hdhalter added 3 - Done and removed Editorial review PR: Editorial review in progress labels May 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

release-notes PR: Include this PR in the automated release notes v2.14.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOC] Update documentation for cluster settings to include Async shard batch fetch settings.

5 participants