Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Rollover API #7685

Merged
merged 9 commits into from
Jul 22, 2024
Merged

Add Rollover API #7685

merged 9 commits into from
Jul 22, 2024

Conversation

Naarcha-AWS
Copy link
Collaborator

Closes #2100

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.

@Naarcha-AWS
Add Rollover API.
609c7eb 
Signed-off-by: Archer <naarcha@amazon.com>
@Naarcha-AWS Naarcha-AWS added 3 - Tech review PR: Tech review in progress backport 2.15 labels Jul 11, 2024
@Naarcha-AWS Naarcha-AWS added 4 - Doc review PR: Doc review in progress and removed 3 - Tech review PR: Tech review in progress labels Jul 15, 2024
Naarcha-AWS and others added 2 commits July 15, 2024 10:31
@Naarcha-AWS
Apply suggestions from code review
badc4e1 
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
@Naarcha-AWS
Make rollover match template.
bc388f1 
Signed-off-by: Archer <naarcha@amazon.com>
vagimeli
vagimeli reviewed Jul 18, 2024
View reviewed changes
Copy link
Collaborator

@vagimeli vagimeli left a comment

Choose a reason for hiding this comment

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

@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.

_api-reference/index-apis/rollover.md Outdated Show resolved Hide resolved
_api-reference/index-apis/rollover.md Outdated Show resolved Hide resolved
_api-reference/index-apis/rollover.md Outdated Show resolved Hide resolved
_api-reference/index-apis/rollover.md Outdated Show resolved Hide resolved
_api-reference/index-apis/rollover.md Outdated Show resolved Hide resolved
_api-reference/index-apis/rollover.md Outdated Show resolved Hide resolved
_api-reference/index-apis/rollover.md Outdated Show resolved Hide resolved
_api-reference/index-apis/rollover.md Outdated Show resolved Hide resolved
_api-reference/index-apis/rollover.md Outdated Show resolved Hide resolved
_api-reference/index-apis/rollover.md Outdated Show resolved Hide resolved
@Naarcha-AWS @vagimeli
Apply suggestions from code review
424dd22 
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
@Naarcha-AWS Naarcha-AWS added 5 - Editorial review PR: Editorial review in progress and removed 4 - Doc review PR: Doc review in progress labels Jul 19, 2024
Naarcha-AWS and others added 2 commits July 19, 2024 12:51
@Naarcha-AWS @vagimeli
Update _api-reference/index-apis/rollover.md
6e26a47 
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
@Naarcha-AWS @vagimeli
Update _api-reference/index-apis/rollover.md
d0a1297 
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
natebower
natebower requested changes Jul 22, 2024
View reviewed changes
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.

@Naarcha-AWS Please see my comments and changes and let me know if you have any questions. Thanks!

_api-reference/index-apis/rollover.md Outdated

### 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.
Copy link
Collaborator

Choose a reason for hiding this comment

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

"transitions" => "transforms"?

_api-reference/index-apis/rollover.md Outdated Show resolved Hide resolved
_api-reference/index-apis/rollover.md Outdated Show resolved Hide resolved
_api-reference/index-apis/rollover.md Outdated Show resolved Hide resolved
_api-reference/index-apis/rollover.md Outdated Show resolved Hide resolved
_api-reference/index-apis/rollover.md Outdated

The following request creates a date-time index and sets it as the write index for `my-alias`:

```
Copy link
Collaborator

Choose a reason for hiding this comment

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

json?

_api-reference/index-apis/rollover.md Outdated

The next request performs a rollover using the alias:

```
Copy link
Collaborator

Choose a reason for hiding this comment

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

json?

_api-reference/index-apis/rollover.md Outdated

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:

```
Copy link
Collaborator

Choose a reason for hiding this comment

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

json?

_api-reference/index-apis/rollover.md Outdated Show resolved Hide resolved
_api-reference/index-apis/rollover.md Outdated

OpenSearch returns the following response confirming all conditions except `max_primary_shard_size` were met:

```
Copy link
Collaborator

Choose a reason for hiding this comment

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

json?

@Naarcha-AWS @natebower @vagimeli
Apply suggestions from code review
58b341b 
Co-authored-by: Nathan Bower <nbower@amazon.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
natebower
natebower approved these changes Jul 22, 2024
View reviewed changes
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.

@Naarcha-AWS Just one period that I may have missed the first time. Otherwise, LGTM!

_api-reference/index-apis/rollover.md Outdated Show resolved Hide resolved
Naarcha-AWS and others added 2 commits July 22, 2024 16:26
@Naarcha-AWS @natebower
Update _api-reference/index-apis/rollover.md
dc5755a 
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
@Naarcha-AWS
Merge branch 'main' into rollover-api
63253f6
@Naarcha-AWS Naarcha-AWS merged commit b2abf25 into main Jul 22, 2024
6 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jul 22, 2024
@github-actions @vagimeli @natebower
Add Rollover API (#7685)
354ed2f 
* Add Rollover API.

Signed-off-by: Archer <naarcha@amazon.com>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Make rollover match template.

Signed-off-by: Archer <naarcha@amazon.com>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Update _api-reference/index-apis/rollover.md

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Update _api-reference/index-apis/rollover.md

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <nbower@amazon.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Update _api-reference/index-apis/rollover.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

---------

Signed-off-by: Archer <naarcha@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
(cherry picked from commit b2abf25)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@opensearch-trigger-bot opensearch-trigger-bot bot mentioned this pull request Jul 22, 2024
Merged
github-actions bot pushed a commit that referenced this pull request Jul 22, 2024
@opensearch-trigger-bot
Add Rollover API (#7685) (#7795)
6bbd91d
leanneeliatra pushed a commit to leanneeliatra/opensearch-documentation-website-forl that referenced this pull request Jul 24, 2024
@Naarcha-AWS @vagimeli
@natebower @leanneeliatra
Add Rollover API (opensearch-project#7685)
4dd12b2 
* Add Rollover API.

Signed-off-by: Archer <naarcha@amazon.com>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Make rollover match template.

Signed-off-by: Archer <naarcha@amazon.com>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Update _api-reference/index-apis/rollover.md

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Update _api-reference/index-apis/rollover.md

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <nbower@amazon.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Update _api-reference/index-apis/rollover.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

---------

Signed-off-by: Archer <naarcha@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com>
sandervandegeijn pushed a commit to sandervandegeijn/documentation-website that referenced this pull request Jul 30, 2024
@Naarcha-AWS @vagimeli
@natebower @sandervandegeijn
Add Rollover API (opensearch-project#7685)
2f7a98d 
* Add Rollover API.

Signed-off-by: Archer <naarcha@amazon.com>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Make rollover match template.

Signed-off-by: Archer <naarcha@amazon.com>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Update _api-reference/index-apis/rollover.md

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Update _api-reference/index-apis/rollover.md

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <nbower@amazon.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Update _api-reference/index-apis/rollover.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

---------

Signed-off-by: Archer <naarcha@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Sander van de Geijn <sandervandegeijn@icloud.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vagimeli vagimeli vagimeli left review comments

@gbbafna gbbafna gbbafna approved these changes

@natebower natebower natebower approved these changes

@hdhalter hdhalter Awaiting requested review from hdhalter

@kolchfa-aws kolchfa-aws Awaiting requested review from kolchfa-aws kolchfa-aws is a code owner

@AMoo-Miki AMoo-Miki Awaiting requested review from AMoo-Miki AMoo-Miki is a code owner

@dlvenable dlvenable Awaiting requested review from dlvenable dlvenable is a code owner

@stephen-crawford stephen-crawford Awaiting requested review from stephen-crawford stephen-crawford is a code owner

@epugh epugh Awaiting requested review from epugh epugh is a code owner

Assignees

@Naarcha-AWS Naarcha-AWS

Labels
5 - Editorial review PR: Editorial review in progress backport 2.15
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[DOC]Create documentation for _rollover API
4 participants
@Naarcha-AWS @gbbafna @natebower @vagimeli