[DOC] Add max_shard_size parameter to shrink API page #2352
Conversation
) Signed-off-by: gaobinlong <[email protected]>
gaobinlong
changed the title
Naarcha-AWS
added
backport 2.0
| The new parameter to be called max_shard_size. | ||
| max_primary_shard_size | Bytes | Sets the maximum size of a primary shard in the target index. For example, if this field is set to 100 GB, and the source index's primary shards total to 300 GB, then the target index has 3 primary shards of 100 GB each. | ||
| {% endcomment %} | ||
| max_shard_size | Bytes | Sets the maximum size of a primary shard in the target index. `max_shard_size` calculates the target index's primary shard count and the primary shards' storage in the source index. The primary shard count of the target index is the lowest factor of the source index's primary shard count which satisfies this field's requirement. For example, if `max_shard_size` is set to `100 GB`, and the source index's primary shards total to `300 GB` and the count is `6`, then the target index has **3 primary shards of 100 GB each**. If the source index's primary shards total to `600GB` and count is `5`, then the target index will have **5 primary shards**. Because `max_shard_size` conflicts with `index.number_of_shards` in `settings` you can not set both of them at the same time. |
There was a problem hiding this comment.
@gaobinlong After looking at the code, I think we might want to break this parameter out in a separate section with more explanations and a non-trivial example. We might also want to mention the max and min for the number of primary shards in the target index. Do you mind if I take over this PR and try to do this, and you can review for technical accuracy?
There was a problem hiding this comment.
@kolchfa-aws sure, you can do it, and feel free to ping me if you need some help.
There was a problem hiding this comment.
@gaobinlong Could you please review the new PR for technical accuracy? #2519
There was a problem hiding this comment.
Sure，I've added some comments for the new PR, you can take a look.
There was a problem hiding this comment.
@gaobinlong Somehow I don't see any comments on #2519. I don't know if it's a problem on my end. Would you mind confirming that they are there?
|
Closing this PR in favor of #2519 |
Signed-off-by: gaobinlong [email protected]
Description
Relates to #2044.
The main change of this PR is adding a new parameter named
max_shard_sizeto shrink API page, the parameter was added to OpenSearch core in this PR: 5229, so we need to add the parameter to the documentation.Issues Resolved
Closes #2044
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.