Add Rollover API #7685
Merged
Add Rollover API #7685
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Archer <[email protected]>
Naarcha-AWS
requested review from
hdhalter,
kolchfa-aws,
vagimeli,
AMoo-Miki,
natebower,
dlvenable,
stephen-crawford and
epugh
as code owners
gbbafna
approved these changes
Jul 15, 2024
Naarcha-AWS
added
4 - Doc review
Naarcha-AWS
commented
Jul 15, 2024
Naarcha-AWS
commented
Jul 15, 2024
Naarcha-AWS
commented
Jul 15, 2024
Naarcha-AWS
commented
Jul 15, 2024
Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: Archer <[email protected]>
vagimeli
reviewed
Jul 18, 2024
There was a problem hiding this comment.
@Naarcha-AWS Doc review complete. My edits are to refine the writing and make it clear and accurate. Please ask @hdhalter to review and approve once my changes are incorporated.
Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>
Naarcha-AWS
added
5 - Editorial review
Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>
natebower
requested changes
Jul 22, 2024
There was a problem hiding this comment.
@Naarcha-AWS Please see my comments and changes and let me know if you have any questions. Thanks!
|
|
||
| ### Data stream | ||
|
|
||
| When you perform a rollover operation on a data stream, the API generates a fresh write index for that stream. Simultaneously, the stream's preceding write index transitions into a regular backing index. Additionally, the rollover process increments the generation count of the data stream. Data stream rollovers do not support specifying index settings in the request body. |
There was a problem hiding this comment.
"transitions" => "transforms"?
|
|
||
| The following request creates a date-time index and sets it as the write index for `my-alias`: | ||
|
|
||
| ``` |
|
|
||
| The next request performs a rollover using the alias: | ||
|
|
||
| ``` |
|
|
||
| In most cases, you can use an index template to automatically configure the indexes created during a rollover operation. However, when rolling over an index alias, you can use the Rollover Index API to introduce additional index settings or override the settings defined in the template by sending the following request: | ||
|
|
||
| ``` |
|
|
||
| OpenSearch returns the following response confirming all conditions except `max_primary_shard_size` were met: | ||
|
|
||
| ``` |
Naarcha-AWS
commented
Jul 22, 2024
Naarcha-AWS
commented
Jul 22, 2024
Naarcha-AWS
commented
Jul 22, 2024
Naarcha-AWS
commented
Jul 22, 2024
Naarcha-AWS
commented
Jul 22, 2024
Naarcha-AWS
commented
Jul 22, 2024
Co-authored-by: Nathan Bower <[email protected]> Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>
natebower
approved these changes
Jul 22, 2024
There was a problem hiding this comment.
@Naarcha-AWS Just one period that I may have missed the first time. Otherwise, LGTM!
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Jul 22, 2024
* Add Rollover API. Signed-off-by: Archer <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Make rollover match template. Signed-off-by: Archer <[email protected]> * Apply suggestions from code review Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _api-reference/index-apis/rollover.md Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _api-reference/index-apis/rollover.md Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _api-reference/index-apis/rollover.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Archer <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Melissa Vagi <[email protected]> Co-authored-by: Nathan Bower <[email protected]> (cherry picked from commit b2abf25) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
leanneeliatra
pushed a commit
to leanneeliatra/opensearch-documentation-website-forl
that referenced
this pull request
Jul 24, 2024
* Add Rollover API. Signed-off-by: Archer <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Make rollover match template. Signed-off-by: Archer <[email protected]> * Apply suggestions from code review Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _api-reference/index-apis/rollover.md Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _api-reference/index-apis/rollover.md Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _api-reference/index-apis/rollover.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Archer <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Melissa Vagi <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: [email protected] <[email protected]>
sandervandegeijn
pushed a commit
to sandervandegeijn/documentation-website
that referenced
this pull request
Jul 30, 2024
* Add Rollover API. Signed-off-by: Archer <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Make rollover match template. Signed-off-by: Archer <[email protected]> * Apply suggestions from code review Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _api-reference/index-apis/rollover.md Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _api-reference/index-apis/rollover.md Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _api-reference/index-apis/rollover.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Archer <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Melissa Vagi <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Sander van de Geijn <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #2100
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.