-
Notifications
You must be signed in to change notification settings - Fork 159
Move and fix up lifecycle start/stop/check docs #2569
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.
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
Merged
Merged
Changes from 17 commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
6e26c0c
Move and fix up lifecycle start/stop/check docs
kilfoyle 57f963d
fix title
kilfoyle 09402f7
Add PR URL to redirects page
kilfoyle 252cfd8
Remove 'start & stop ILM' page
kilfoyle 519b230
fixup
kilfoyle 60805b1
Merge branch 'main' into 190/edu-004-start-stop
kilfoyle ded1c10
Merge branch 'main' into 190/edu-004-start-stop
kilfoyle bf4f244
Address review comments
kilfoyle a378c69
one more...
kilfoyle 7c6236e
link fix
kilfoyle 094697c
Merge branch 'main' into 190/edu-004-start-stop
kilfoyle 73d4265
Merge branch 'main' into 190/edu-004-start-stop
kilfoyle a51b68e
Merge branch 'main' into 190/edu-004-start-stop
kilfoyle e4df871
Fix right-side nav
kilfoyle b0119d5
Update manage-data/_snippets/start-stop-ilm.md
kilfoyle 93a8bb5
Merge branch 'main' into 190/edu-004-start-stop
kilfoyle 70a1ca3
Merge branch 'main' into 190/edu-004-start-stop
kilfoyle 6f85729
Split snippet file to fix wonky nav
kilfoyle 4492c33
Merge branch 'main' into 190/edu-004-start-stop
kilfoyle File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,99 @@ | ||
Follow these steps to check the current {{ilm-init}} status, and to stop or restart it as needed. | ||
|
||
### Get {{ilm-init}} status | ||
|
||
To see the current status of the {{ilm-init}} service, use the [{{ilm-init}} status API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-get-status): | ||
|
||
```console | ||
GET _ilm/status | ||
``` | ||
|
||
Under normal operation, the response shows {{ilm-init}} is `RUNNING`: | ||
|
||
```console-result | ||
{ | ||
"operation_mode": "RUNNING" | ||
} | ||
``` | ||
|
||
You can also [](/manage-data/lifecycle/index-lifecycle-management/policy-view-status.md) for further information. | ||
|
||
### Stop {{ilm-init}} | ||
|
||
By default, the {{ilm}} service is in the `RUNNING` state and manages all indices that have lifecycle policies. | ||
|
||
You can stop {{ilm-init}} to suspend management operations for all indices. For example, you might stop {{ilm}} when performing scheduled maintenance or making changes to the cluster that could impact the execution of {{ilm-init}} actions. | ||
|
||
::::{important} | ||
When you stop {{ilm-init}}, [{{slm-init}}](/deploy-manage/tools/snapshot-and-restore/create-snapshots.md#automate-snapshots-slm) operations are also suspended. No snapshots will be taken as scheduled until you restart {{ilm-init}}. In-progress snapshots are not affected. | ||
:::: | ||
|
||
To stop the {{ilm-init}} service and pause execution of all lifecycle policies, use the [{{ilm-init}} stop API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-stop): | ||
|
||
```console | ||
POST _ilm/stop | ||
``` | ||
|
||
The response will look like this: | ||
|
||
```console-result | ||
{ | ||
"acknowledged": true | ||
} | ||
``` | ||
|
||
The {{ilm-init}} service runs all policies to a point where it is safe to stop. | ||
|
||
While the {{ilm-init}} service is shutting down, run the status API to verify that {{ilm-init}} is stopping: | ||
|
||
```console | ||
GET _ilm/status | ||
``` | ||
|
||
The response will look like this: | ||
|
||
```console-result | ||
{ | ||
"operation_mode": "STOPPING" | ||
} | ||
``` | ||
|
||
Once all policies are at a safe stopping point, {{ilm-init}} moves into the `STOPPED` mode: | ||
|
||
```console-result | ||
{ | ||
"operation_mode": "STOPPED" | ||
} | ||
``` | ||
|
||
### Start {{ilm-init}} [start-ilm] | ||
|
||
If the automatic {{ilm}} or {{slm}} service is not working, you might need to restart the service. | ||
|
||
To restart {{ilm-init}} and resume executing policies, use the [{{ilm-init}} start API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-start). This puts the {{ilm-init}} service in the `RUNNING` state and {{ilm-init}} begins executing policies from where it left off. | ||
|
||
```console | ||
POST _ilm/start | ||
``` | ||
|
||
The response will look like this: | ||
|
||
```console-result | ||
{ | ||
"acknowledged": true | ||
} | ||
``` | ||
|
||
Verify that {{ilm}} is now running: | ||
|
||
```console | ||
GET _ilm/status | ||
``` | ||
|
||
The response will look like this: | ||
|
||
```console-result | ||
{ | ||
"operation_mode": "RUNNING" | ||
} | ||
``` |
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.