Allow ILM move-to-step without `action` or `name` #75435

dakrone · 2021-07-16T23:18:05Z

This commit enhances ILM's move-to-step API to allow dropping the name, or dropping both the
action and name. For example:

POST /_ilm/move/foo-1
{
  "current_step": {
    "phase": "hot",
    "action": "rollover",
    "name": "check-rollover-ready"
  },
  "next_step": {
    "phase": "warm",
    "action": "forcemerge"
  }
}

Will move to the first step in the forcemerge action in the warm phase (without having to know
the specific step name).

Another example:

POST /_ilm/move/foo-1
{
  "current_step": {
    "phase": "hot",
    "action": "rollover",
    "name": "check-rollover-ready"
  },
  "next_step": {
    "phase": "warm"
  }
}

Will move to the first step in the warm phase (without having to know the specific action name).

Bear in mind that the execution order is still entirely an implementation detail, so "first" in the
above sentences means the first step that ILM would execute.

Resolves #58128

This commit enhances ILM's move-to-step API to allow dropping the `name`, or dropping both the `action` and `name`. For example: ```json POST /_ilm/move/foo-1 { "current_step": { "phase": "hot", "action": "rollover", "name": "check-rollover-ready" }, "next_step": { "phase": "warm", "action": "forcemerge" } } ``` Will move to the first step in the `forcemerge` action in the `warm` phase (without having to know the specific step name). Another example: ```json POST /_ilm/move/foo-1 { "current_step": { "phase": "hot", "action": "rollover", "name": "check-rollover-ready" }, "next_step": { "phase": "warm" } } ``` Will move to the first step in the `warm` phase (without having to know the specific action name). Bear in mind that the execution order is still entirely an implementation detail, so "first" in the above sentences means the first step that ILM would execute. Resolves elastic#58128

elasticmachine · 2021-07-16T23:18:08Z

Pinging @elastic/es-core-features (Team:Core/Features)

andreidan

Much ❤️ for working on this @dakrone

docs/reference/ilm/apis/move-to-step.asciidoc

andreidan · 2021-07-19T12:37:26Z

...k/plugin/ilm/src/main/java/org/elasticsearch/xpack/ilm/action/TransportMoveToStepAction.java

+            return;
+        }
+
+        clusterService.submitStateUpdateTask("index[" + request.getIndex() + "]-move-to-step-" + targetStr,


should this use concreteTargetStepKey instead of the (potentially) partial targetStr ? (to avoid a human having to parse what the actual target is when inspecting the tasks)

One issue is that we don't know the real concrete target step key until we're in the cluster state update (because there could be changes to the policy between now and when the cluster state update is executed), so I left this as something like hot/null/null so that we can see in logs that the user meant to move to the first action in the hot phase (regardless of what it is), we still have logging for the actual concrete step that it was moved to

...k/plugin/ilm/src/main/java/org/elasticsearch/xpack/ilm/action/TransportMoveToStepAction.java

Co-authored-by: Andrei Dan <[email protected]>

elasticsearchmachine · 2021-07-19T16:12:06Z

💔 Backport failed

Status	Branch	Result
❌	7.x	Commit could not be cherrypicked due to conflicts

To backport manually run:
backport --pr 75435

* Allow ILM move-to-step without `action` or `name` This commit enhances ILM's move-to-step API to allow dropping the `name`, or dropping both the `action` and `name`. For example: ```json POST /_ilm/move/foo-1 { "current_step": { "phase": "hot", "action": "rollover", "name": "check-rollover-ready" }, "next_step": { "phase": "warm", "action": "forcemerge" } } ``` Will move to the first step in the `forcemerge` action in the `warm` phase (without having to know the specific step name). Another example: ```json POST /_ilm/move/foo-1 { "current_step": { "phase": "hot", "action": "rollover", "name": "check-rollover-ready" }, "next_step": { "phase": "warm" } } ``` Will move to the first step in the `warm` phase (without having to know the specific action name). Bear in mind that the execution order is still entirely an implementation detail, so "first" in the above sentences means the first step that ILM would execute. Resolves elastic#58128 * Apply Andrei's wording change (thanks!) Co-authored-by: Andrei Dan <[email protected]> * Log index and policy name when the concrete step key can't be resolved Co-authored-by: Andrei Dan <[email protected]> # Conflicts: # x-pack/plugin/ilm/src/main/java/org/elasticsearch/xpack/ilm/IndexLifecycleService.java

This disables the tests so that the move to step changes in elastic#75435 can be backported Relates to elastic#75480

) * Allow ILM move-to-step without `action` or `name` This commit enhances ILM's move-to-step API to allow dropping the `name`, or dropping both the `action` and `name`. For example: ```json POST /_ilm/move/foo-1 { "current_step": { "phase": "hot", "action": "rollover", "name": "check-rollover-ready" }, "next_step": { "phase": "warm", "action": "forcemerge" } } ``` Will move to the first step in the `forcemerge` action in the `warm` phase (without having to know the specific step name). Another example: ```json POST /_ilm/move/foo-1 { "current_step": { "phase": "hot", "action": "rollover", "name": "check-rollover-ready" }, "next_step": { "phase": "warm" } } ``` Will move to the first step in the `warm` phase (without having to know the specific action name). Bear in mind that the execution order is still entirely an implementation detail, so "first" in the above sentences means the first step that ILM would execute. Resolves #58128 * Apply Andrei's wording change (thanks!) Co-authored-by: Andrei Dan <[email protected]> * Log index and policy name when the concrete step key can't be resolved Co-authored-by: Andrei Dan <[email protected]> # Conflicts: # x-pack/plugin/ilm/src/main/java/org/elasticsearch/xpack/ilm/IndexLifecycleService.java

This disables the tests so that the move to step changes in #75435 can be backported Relates to #75480

This also adjusts the version constants now that elastic#75480 has been merged. Relates to elastic#75480 and elastic#75435

This also adjusts the version constants now that #75480 has been merged. Relates to #75480 and #75435

* Allow ILM move-to-step without `action` or `name` This commit enhances ILM's move-to-step API to allow dropping the `name`, or dropping both the `action` and `name`. For example: ```json POST /_ilm/move/foo-1 { "current_step": { "phase": "hot", "action": "rollover", "name": "check-rollover-ready" }, "next_step": { "phase": "warm", "action": "forcemerge" } } ``` Will move to the first step in the `forcemerge` action in the `warm` phase (without having to know the specific step name). Another example: ```json POST /_ilm/move/foo-1 { "current_step": { "phase": "hot", "action": "rollover", "name": "check-rollover-ready" }, "next_step": { "phase": "warm" } } ``` Will move to the first step in the `warm` phase (without having to know the specific action name). Bear in mind that the execution order is still entirely an implementation detail, so "first" in the above sentences means the first step that ILM would execute. Resolves elastic#58128 * Apply Andrei's wording change (thanks!) Co-authored-by: Andrei Dan <[email protected]> * Log index and policy name when the concrete step key can't be resolved Co-authored-by: Andrei Dan <[email protected]>

This disables the tests so that the move to step changes in elastic#75435 can be backported Relates to elastic#75480

This also adjusts the version constants now that elastic#75480 has been merged. Relates to elastic#75480 and elastic#75435

Updates [doc](https://www.elastic.co/guide/en/elasticsearch/reference/master/ilm-move-to-step.html?edit) to append example similar to #75435 (≥v7.15.0) to show users working example of only using `next_step.phase`.

* [+DOC] ILM Move Step example only phase Updates [doc](https://www.elastic.co/guide/en/elasticsearch/reference/master/ilm-move-to-step.html?edit) to append example similar to #75435 (≥v7.15.0) to show users working example of only using `next_step.phase`. * Move example to the end of the page * Fix failing code snippet tests Co-authored-by: Abdon Pijpelink <[email protected]>

* [+DOC] ILM Move Step example only phase Updates [doc](https://www.elastic.co/guide/en/elasticsearch/reference/master/ilm-move-to-step.html?edit) to append example similar to elastic#75435 (≥v7.15.0) to show users working example of only using `next_step.phase`. * Move example to the end of the page * Fix failing code snippet tests Co-authored-by: Abdon Pijpelink <[email protected]>

* [+DOC] ILM Move Step example only phase Updates [doc](https://www.elastic.co/guide/en/elasticsearch/reference/master/ilm-move-to-step.html?edit) to append example similar to #75435 (≥v7.15.0) to show users working example of only using `next_step.phase`. * Move example to the end of the page * Fix failing code snippet tests * Skip test Co-authored-by: Stef Nestor <[email protected]>

* [+DOC] ILM Move Step example only phase Updates [doc](https://www.elastic.co/guide/en/elasticsearch/reference/master/ilm-move-to-step.html?edit) to append example similar to elastic#75435 (≥v7.15.0) to show users working example of only using `next_step.phase`. * Move example to the end of the page * Fix failing code snippet tests * Skip test Co-authored-by: Stef Nestor <[email protected]>

* [+DOC] ILM Move Step example only phase Updates [doc](https://www.elastic.co/guide/en/elasticsearch/reference/master/ilm-move-to-step.html?edit) to append example similar to #75435 (≥v7.15.0) to show users working example of only using `next_step.phase`. * Move example to the end of the page * Fix failing code snippet tests * Skip test Co-authored-by: Stef Nestor <[email protected]> Co-authored-by: Stef Nestor <[email protected]>

dakrone added >enhancement :Data Management/ILM+SLM Index and Snapshot lifecycle management v8.0.0 v7.15.0 labels Jul 16, 2021

dakrone requested a review from andreidan July 16, 2021 23:18

elasticmachine added the Team:Data Management Meta label for data/management team label Jul 16, 2021

andreidan approved these changes Jul 19, 2021

View reviewed changes

dakrone and others added 3 commits July 19, 2021 09:15

Apply Andrei's wording change (thanks!)

92609ec

Co-authored-by: Andrei Dan <[email protected]>

Merge remote-tracking branch 'origin/master' into move-to-step-optionals

1963bca

Log index and policy name when the concrete step key can't be resolved

27c9786

dakrone added auto-backport Automatically create backport pull requests when merged auto-merge-without-approval Automatically merge pull request when CI checks pass (NB doesn't wait for reviews!) labels Jul 19, 2021

elasticsearchmachine merged commit 3d5843a into elastic:master Jul 19, 2021

dakrone mentioned this pull request Jul 19, 2021

[7.x] Allow ILM move-to-step without action or name (#75435) #75480

Merged

dakrone added a commit to dakrone/elasticsearch that referenced this pull request Jul 19, 2021

Disable BWC tests for ILM move-to-step backport

46a9b23

This disables the tests so that the move to step changes in elastic#75435 can be backported Relates to elastic#75480

dakrone mentioned this pull request Jul 19, 2021

Disable BWC tests for ILM move-to-step backport #75481

Merged

dakrone added a commit that referenced this pull request Jul 19, 2021

Disable BWC tests for ILM move-to-step backport (#75481)

eed35db

This disables the tests so that the move to step changes in #75435 can be backported Relates to #75480

dakrone added a commit to dakrone/elasticsearch that referenced this pull request Jul 19, 2021

Re-enable BWC for ILM move-to-step backport

8648942

This also adjusts the version constants now that elastic#75480 has been merged. Relates to elastic#75480 and elastic#75435

dakrone mentioned this pull request Jul 19, 2021

Re-enable BWC for ILM move-to-step backport #75498

Merged

elasticsearchmachine pushed a commit that referenced this pull request Jul 19, 2021

Re-enable BWC for ILM move-to-step backport (#75498)

b460aad

This also adjusts the version constants now that #75480 has been merged. Relates to #75480 and #75435

andreidan mentioned this pull request Jul 22, 2021

Add the ability to move index between different ILM phases easier #75552

Closed

jakelandis added v8.0.0-alpha1 and removed v8.0.0 labels Jul 26, 2021

ywangd pushed a commit to ywangd/elasticsearch that referenced this pull request Jul 30, 2021

Disable BWC tests for ILM move-to-step backport (elastic#75481)

3a1c1e7

This disables the tests so that the move to step changes in elastic#75435 can be backported Relates to elastic#75480

ywangd pushed a commit to ywangd/elasticsearch that referenced this pull request Jul 30, 2021

Re-enable BWC for ILM move-to-step backport (elastic#75498)

132f333

This also adjusts the version constants now that elastic#75480 has been merged. Relates to elastic#75480 and elastic#75435

stefnestor mentioned this pull request Sep 24, 2022

[+DOC] ILM Move Step example only phase #90329

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Allow ILM move-to-step without `action` or `name` #75435

Allow ILM move-to-step without `action` or `name` #75435

Uh oh!

dakrone commented Jul 16, 2021

Uh oh!

elasticmachine commented Jul 16, 2021

Uh oh!

andreidan left a comment

Uh oh!

Uh oh!

andreidan Jul 19, 2021

Uh oh!

dakrone Jul 19, 2021 •

edited

Loading

Uh oh!

Uh oh!

elasticsearchmachine commented Jul 19, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Allow ILM move-to-step without action or name #75435

Allow ILM move-to-step without action or name #75435

Uh oh!

Conversation

dakrone commented Jul 16, 2021

Uh oh!

elasticmachine commented Jul 16, 2021

Uh oh!

andreidan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

andreidan Jul 19, 2021

Choose a reason for hiding this comment

Uh oh!

dakrone Jul 19, 2021 • 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!

Uh oh!

elasticsearchmachine commented Jul 19, 2021

💔 Backport failed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Allow ILM move-to-step without `action` or `name` #75435

Allow ILM move-to-step without `action` or `name` #75435

dakrone Jul 19, 2021 •

edited

Loading