You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
If the automatic {{ilm}} or {{slm}} service is not working, you might need to restart the service.
2
+
3
+
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.
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):
2
+
3
+
```console
4
+
GET _ilm/status
5
+
```
6
+
7
+
Under normal operation, the response shows {{ilm-init}} is `RUNNING`:
8
+
9
+
```console-result
10
+
{
11
+
"operation_mode": "RUNNING"
12
+
}
13
+
```
14
+
15
+
You can also [](/manage-data/lifecycle/index-lifecycle-management/policy-view-status.md) for further information.
By default, the {{ilm}} service is in the `RUNNING` state and manages all indices that have lifecycle policies.
2
+
3
+
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.
4
+
5
+
::::{important}
6
+
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.
7
+
::::
8
+
9
+
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):
10
+
11
+
```console
12
+
POST _ilm/stop
13
+
```
14
+
15
+
The response will look like this:
16
+
17
+
```console-result
18
+
{
19
+
"acknowledged": true
20
+
}
21
+
```
22
+
23
+
The {{ilm-init}} service runs all policies to a point where it is safe to stop.
24
+
25
+
While the {{ilm-init}} service is shutting down, run the status API to verify that {{ilm-init}} is stopping:
26
+
27
+
```console
28
+
GET _ilm/status
29
+
```
30
+
31
+
The response will look like this:
32
+
33
+
```console-result
34
+
{
35
+
"operation_mode": "STOPPING"
36
+
}
37
+
```
38
+
39
+
Once all policies are at a safe stopping point, {{ilm-init}} moves into the `STOPPED` mode:
@@ -89,6 +88,12 @@ Default {{ilm}} policies are created automatically when you install an [Elastic
89
88
To automatically back up your indices and manage snapshots, use [snapshot lifecycle policies](/deploy-manage/tools/snapshot-and-restore/create-snapshots.md#automate-snapshots-slm).
90
89
::::
91
90
91
+
## Pausing and troubleshooting {{ilm-init}}
92
+
93
+
In case you want to temporarily pause the {{ilm-init}} service while you perform maintenance, make other changes to your cluster, or do any troubleshooting, refer to [Start and stop {{ilm-init}}](/manage-data/lifecycle/index-lifecycle-management/start-stop-index-lifecycle-management.md).
94
+
95
+
In the event of any issues running {{ilm-init}}, refer to [Fix index lifecycle management errors](/troubleshoot/elasticsearch/index-lifecycle-management-errors.md) for detailed troubleshooting guidance.
96
+
92
97
## Migrate to {{ilm-init}}
93
98
94
99
For existing hot-warm deployments that are currently using index curation, migrating to ILM gives you more fine-grained control over the lifecycle of each index. Read more in:
# Migrate to {{ilm-init}} on self-managed and {{eck}} deployments[ilm-with-existing-indices]
11
14
12
-
If you’ve been using Curator or some other mechanism to manage periodic indices, you have a couple options when [migrating to {{ilm-init}}](./migrate-index-management.md):
15
+
If you’ve been using Curator or some other mechanism to manage periodic indices, you have a couple of options when [migrating to {{ilm-init}}](./migrate-index-management.md):
13
16
14
17
* Set up your index templates to use an {{ilm-init}} policy to manage your new indices. Once {{ilm-init}} is managing your current write index, you can apply an appropriate policy to your old indices.
You may already be another mechanism to manage the lifecycle of your indices. To help you adapt your existing indices to use {{ilm}}, a few guides are available:
: Describes how to migrate {{es}} indices in an {{ech}} or {{ece}} deployment from using deprecated index curation or another periodic indices management mechanism to use {{ilm}}.
: Describes how to migrate {{es}} indices in a self-managed environment from using deprecated index curation, or any other lifecycle mechanism, to use {{ilm}}.
: Describes how to migrate from using custom node attributes and attribute-based allocation filters to using built-in node roles, enabling {{ilm-init}} to automatically move indices between data tiers.
26
+
27
+
If you are configuring {{ilm-init}} for new indices, refer to [](/manage-data/lifecycle/index-lifecycle-management/configure-lifecycle-policy.md). If you plan to manually apply an {{ilm}} policy to existing indices that are not already using another type of lifecycle management, refer to [](/manage-data/lifecycle/index-lifecycle-management/policy-apply.md).
# Migrate to {{ilm-init}} on {{ech}} or {{ece}} deployments
13
17
14
18
::::{important}
15
19
Index curation is deprecated. Any deployments using index curation are prompted to migrate to ILM.
16
20
::::
17
21
18
22
The index lifecycle management (ILM) feature of the {{stack}} provides an integrated and streamlined way to manage time-based data, making it easier to follow best practices for managing your indices. Compared to index curation, migrating to ILM gives you more fine-grained control over the lifecycle of each index.
19
23
20
-
For existing hot-warm deployments that are currently using index curation, there are a couple of options for migrating to index lifecycle management (ILM). You can:
24
+
For existing {{ecloud}} hot-warm deployments that are currently using index curation, there are a couple of options for migrating to index lifecycle management (ILM). You can:
21
25
22
26
* Use the migration process in the console to change an existing deployment to ILM.
23
27
* Take a snapshot and restore your data to a new Elastic Stack deployment that has ILM enabled.
Copy file name to clipboardExpand all lines: manage-data/lifecycle/index-lifecycle-management/start-stop-index-lifecycle-management.md
+10-54Lines changed: 10 additions & 54 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,63 +10,19 @@ products:
10
10
11
11
# Start and stop index lifecycle management [start-stop-ilm]
12
12
13
-
By default, the {{ilm-init}} service is in the `RUNNING` state and manages all indices that have lifecycle policies.
13
+
Follow these steps to check the current {{ilm-init}} status, and to stop or restart it as needed.
14
14
15
-
You can stop {{ilm}} 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.
15
+
### Get {{ilm-init}} status
16
16
17
-
::::{important}
18
-
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.
19
-
::::
17
+
:::{include} /manage-data/_snippets/ilm-status.md
18
+
:::
20
19
20
+
### Stop {{ilm-init}}
21
21
22
+
:::{include} /manage-data/_snippets/ilm-stop.md
23
+
:::
22
24
23
-
## Get {{ilm-init}} status [get-ilm-status]
24
-
25
-
To see the current status of the {{ilm-init}} service, use the [Get Status API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-get-status):
26
-
27
-
```console
28
-
GET _ilm/status
29
-
```
30
-
31
-
Under normal operation, the response shows {{ilm-init}} is `RUNNING`:
32
-
33
-
```console-result
34
-
{
35
-
"operation_mode": "RUNNING"
36
-
}
37
-
```
38
-
39
-
40
-
## Stop {{ilm-init}} [stop-ilm]
41
-
42
-
To stop the {{ilm-init}} service and pause execution of all lifecycle policies, use the [Stop API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-stop):
43
-
44
-
```console
45
-
POST _ilm/stop
46
-
```
47
-
48
-
{{ilm-init}} service runs all policies to a point where it is safe to stop. While the {{ilm-init}} service is shutting down, the status API shows {{ilm-init}} is in the `STOPPING` mode:
49
-
50
-
```console-result
51
-
{
52
-
"operation_mode": "STOPPING"
53
-
}
54
-
```
55
-
56
-
Once all policies are at a safe stopping point, {{ilm-init}} moves into the `STOPPED` mode:
57
-
58
-
```console-result
59
-
{
60
-
"operation_mode": "STOPPED"
61
-
}
62
-
```
63
-
64
-
65
-
## Start {{ilm-init}} [_start_ilm_init]
66
-
67
-
To restart {{ilm-init}} and resume executing policies, use the [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.
0 commit comments