Adding documentation for behavior of indices.recovery.max_bytes_per_sec set to `0mb` or less by AmiStrn · Pull Request #3649 · opensearch-project/documentation-website

AmiStrn · 2023-04-01T21:47:28Z

After a lovely surprise when trying to limit the recovery completely and discovering the opposite was happening I see we need the documentation to include this nice extra info.

Description

missing documentation for setting indices.recovery.max_bytes_per_sec to 0mb or less.

Issues Resolved

Resolves #3648

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.

…and discovering the opposite was happening I see we need the documentation to include this nice extra info. Resolves opensearch-project#3648 Signed-off-by: AmiStrn <123amitai@gmail.com>

AmiStrn · 2023-04-04T06:24:42Z

@hdhalter @Naarcha-AWS @dtaivpp who reviews PRs for this repo?

AmiStrn · 2023-04-04T06:53:44Z

@nknize do you think this can be categorized as a bug in the core project?
The behavior was surprising, if you set this param to 0mb per second then the behavior is basically "as many mb as possible per second"...
I opened this so it is at least documented somewhere.

Naarcha-AWS · 2023-04-04T16:52:10Z

@hdhalter @Naarcha-AWS @dtaivpp who reviews PRs for this repo?

@AmiStrn: That would be anyone on the documentation team listed here. I'm taking a look now.

Naarcha-AWS

Adding additional context based on your issue. Feel free to tweak as needed.

Naarcha-AWS · 2023-04-04T16:55:41Z

_api-reference/cluster-api/cluster-settings.md

 | action.destructive_requires_name | Boolean | When set to `true`, you must specify the index name to delete an index. You cannot delete all indexes or use wildcards. Default is `true`. |
 | cluster.indices.close.enable | Boolean | Enables closing of open indexes in OpenSearch. Default is `true`. |
-| indices.recovery.max_bytes_per_sec | String | Limits the total inbound and outbound recovery traffic for each node. This applies to peer recoveries and snapshot recoveries. Default is `40mb`. |
+| indices.recovery.max_bytes_per_sec | String | Limits the total inbound and outbound recovery traffic for each node. This applies to peer recoveries and snapshot recoveries. Default is `40mb`. Setting to values less than or equal to `0mb` will result in disabling this rate limiting. |


Suggested change

| indices.recovery.max_bytes_per_sec | String | Limits the total inbound and outbound recovery traffic for each node. This applies to peer recoveries and snapshot recoveries. Default is `40mb`. Setting to values less than or equal to `0mb` will result in disabling this rate limiting. |

| indices.recovery.max_bytes_per_sec | String | Limits the total inbound and outbound recovery traffic for each node. This applies to peer recoveries and snapshot recoveries. Default is `40mb`. If you set the recovery traffic value to less than or equal to `0mb`, rate limiting will be disabled, which causes recovery data to be transferred at the highest possible rate. |

I'll make a commit via my fork. If i commit from here it will cause dco issues.
Thanks for the input.

AmiStrn · 2023-04-04T17:26:00Z

@hdhalter @Naarcha-AWS @dtaivpp who reviews PRs for this repo?

@AmiStrn: That would be anyone on the documentation team listed here. I'm taking a look now.

Thanks for taking a look @Naarcha-AWS

Signed-off-by: AmiStrn <123amitai@gmail.com>

carolxob

LGTM.

…ec set to `0mb` or less (#3649) * After a lovely surprise when trying to limit the recovery completely and discovering the opposite was happening I see we need the documentation to include this nice extra info. Resolves #3648 Signed-off-by: AmiStrn <123amitai@gmail.com> * Modifying the proposal based on maintainers input. Signed-off-by: AmiStrn <123amitai@gmail.com> --------- Signed-off-by: AmiStrn <123amitai@gmail.com> (cherry picked from commit b6763b1) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

…ec set to `0mb` or less (#3649) (#3670) * After a lovely surprise when trying to limit the recovery completely and discovering the opposite was happening I see we need the documentation to include this nice extra info. Resolves #3648 * Modifying the proposal based on maintainers input. --------- (cherry picked from commit b6763b1) Signed-off-by: AmiStrn <123amitai@gmail.com> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

…ec set to `0mb` or less (#3649) (#3669) * After a lovely surprise when trying to limit the recovery completely and discovering the opposite was happening I see we need the documentation to include this nice extra info. Resolves #3648 * Modifying the proposal based on maintainers input. --------- (cherry picked from commit b6763b1) Signed-off-by: AmiStrn <123amitai@gmail.com> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

…ec set to `0mb` or less (#3649) (#3668) * After a lovely surprise when trying to limit the recovery completely and discovering the opposite was happening I see we need the documentation to include this nice extra info. Resolves #3648 * Modifying the proposal based on maintainers input. --------- (cherry picked from commit b6763b1) Signed-off-by: AmiStrn <123amitai@gmail.com> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

…ec set to `0mb` or less (#3649) * After a lovely surprise when trying to limit the recovery completely and discovering the opposite was happening I see we need the documentation to include this nice extra info. Resolves #3648 Signed-off-by: AmiStrn <123amitai@gmail.com> * Modifying the proposal based on maintainers input. Signed-off-by: AmiStrn <123amitai@gmail.com> --------- Signed-off-by: AmiStrn <123amitai@gmail.com>

…es_per_sec set to `0mb` or less (#3649)" This reverts commit dd4b0e8.

…ec set to `0mb` or less (#3649) * After a lovely surprise when trying to limit the recovery completely and discovering the opposite was happening I see we need the documentation to include this nice extra info. Resolves #3648 Signed-off-by: AmiStrn <123amitai@gmail.com> * Modifying the proposal based on maintainers input. Signed-off-by: AmiStrn <123amitai@gmail.com> --------- Signed-off-by: AmiStrn <123amitai@gmail.com>

…es_per_sec set to `0mb` or less (#3649)" This reverts commit ed98bdc.

…ec set to `0mb` or less (opensearch-project#3649) * After a lovely surprise when trying to limit the recovery completely and discovering the opposite was happening I see we need the documentation to include this nice extra info. Resolves opensearch-project#3648 Signed-off-by: AmiStrn <123amitai@gmail.com> * Modifying the proposal based on maintainers input. Signed-off-by: AmiStrn <123amitai@gmail.com> --------- Signed-off-by: AmiStrn <123amitai@gmail.com>

After a lovely surprise when trying to limit the recovery completely …

ec5b695

…and discovering the opposite was happening I see we need the documentation to include this nice extra info. Resolves opensearch-project#3648 Signed-off-by: AmiStrn <123amitai@gmail.com>

AmiStrn requested a review from a team as a code owner April 1, 2023 21:47

Naarcha-AWS suggested changes Apr 4, 2023

View reviewed changes

Modifying the proposal based on maintainers input.

f2b7b95

Signed-off-by: AmiStrn <123amitai@gmail.com>

AmiStrn requested a review from Naarcha-AWS April 4, 2023 17:58

Naarcha-AWS approved these changes Apr 4, 2023

View reviewed changes

Naarcha-AWS added backport 1.3 PR: Backport label for v1.3.x backport 2.5 PR: Backport label for 2.5 backport 2.6 PR: Backport label for 2.6 labels Apr 4, 2023

carolxob self-requested a review April 4, 2023 20:10

carolxob approved these changes Apr 4, 2023

View reviewed changes

Naarcha-AWS merged commit b6763b1 into opensearch-project:main Apr 4, 2023

opensearch-trigger-bot bot mentioned this pull request Apr 4, 2023

[Backport 1.3] Adding documentation for behavior of indices.recovery.max_bytes_per_sec set to 0mb or less #3668

Merged

opensearch-trigger-bot bot mentioned this pull request Apr 4, 2023

[Backport 2.5] Adding documentation for behavior of indices.recovery.max_bytes_per_sec set to 0mb or less #3669

Merged

opensearch-trigger-bot bot mentioned this pull request Apr 4, 2023

[Backport 2.6] Adding documentation for behavior of indices.recovery.max_bytes_per_sec set to 0mb or less #3670

Merged

vagimeli added a commit that referenced this pull request Apr 25, 2023

Revert "Adding documentation for behavior of indices.recovery.max_byt…

905a388

…es_per_sec set to `0mb` or less (#3649)" This reverts commit dd4b0e8.

vagimeli added a commit that referenced this pull request May 4, 2023

Revert "Adding documentation for behavior of indices.recovery.max_byt…

ce9d213

…es_per_sec set to `0mb` or less (#3649)" This reverts commit ed98bdc.

prudhvigodithi assigned AmiStrn Oct 3, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding documentation for behavior of indices.recovery.max_bytes_per_sec set to `0mb` or less#3649

Adding documentation for behavior of indices.recovery.max_bytes_per_sec set to `0mb` or less#3649
Naarcha-AWS merged 2 commits intoopensearch-project:mainfrom
AmiStrn:add-documentation-for-max_bytes_per_sec-zero-value

AmiStrn commented Apr 1, 2023

Uh oh!

AmiStrn commented Apr 4, 2023

Uh oh!

AmiStrn commented Apr 4, 2023 •

edited

Loading

Uh oh!

Naarcha-AWS commented Apr 4, 2023

Uh oh!

Naarcha-AWS left a comment

Uh oh!

Naarcha-AWS Apr 4, 2023

Uh oh!

AmiStrn Apr 4, 2023 •

edited

Loading

Uh oh!

AmiStrn commented Apr 4, 2023

Uh oh!

carolxob left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	\| indices.recovery.max_bytes_per_sec \| String \| Limits the total inbound and outbound recovery traffic for each node. This applies to peer recoveries and snapshot recoveries. Default is `40mb`. Setting to values less than or equal to `0mb` will result in disabling this rate limiting. \|
	\| indices.recovery.max_bytes_per_sec \| String \| Limits the total inbound and outbound recovery traffic for each node. This applies to peer recoveries and snapshot recoveries. Default is `40mb`. If you set the recovery traffic value to less than or equal to `0mb`, rate limiting will be disabled, which causes recovery data to be transferred at the highest possible rate. \|

Conversation

AmiStrn commented Apr 1, 2023

Description

Issues Resolved

Checklist

Uh oh!

AmiStrn commented Apr 4, 2023

Uh oh!

AmiStrn commented Apr 4, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Naarcha-AWS commented Apr 4, 2023

Uh oh!

Naarcha-AWS left a comment

Choose a reason for hiding this comment

Uh oh!

Naarcha-AWS Apr 4, 2023

Choose a reason for hiding this comment

Uh oh!

AmiStrn Apr 4, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AmiStrn commented Apr 4, 2023

Uh oh!

carolxob left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

AmiStrn commented Apr 4, 2023 •

edited

Loading

AmiStrn Apr 4, 2023 •

edited

Loading