Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions manage-data/_snippets/ilm-start.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
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"
}
```
15 changes: 15 additions & 0 deletions manage-data/_snippets/ilm-status.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
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.
45 changes: 45 additions & 0 deletions manage-data/_snippets/ilm-stop.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
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"
}
```
7 changes: 6 additions & 1 deletion manage-data/lifecycle/index-lifecycle-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,6 @@ You can create and manage index lifecycle policies through {{kib}}'s [Index Mana
* [Configure a lifecycle policy](/manage-data/lifecycle/index-lifecycle-management/configure-lifecycle-policy.md)
* [View the lifecycle status of an index or datastream](/manage-data/lifecycle/index-lifecycle-management/policy-view-status.md)
* [Update or switch a lifecycle policy](/manage-data/lifecycle/index-lifecycle-management/policy-updates.md)
* [Start and stop index lifecycle management](/manage-data/lifecycle/index-lifecycle-management/start-stop-index-lifecycle-management.md)
* [Restore a managed data stream or index](/manage-data/lifecycle/index-lifecycle-management/restore-managed-data-stream-index.md)
* [Customize built-in policies](/manage-data/lifecycle/index-lifecycle-management/tutorial-customize-built-in-policies.md)

Expand All @@ -89,6 +88,12 @@ Default {{ilm}} policies are created automatically when you install an [Elastic
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).
::::

## Pausing and troubleshooting {{ilm-init}}

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

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.

## Migrate to {{ilm-init}}

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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,63 +10,19 @@ products:

# Start and stop index lifecycle management [start-stop-ilm]

By default, the {{ilm-init}} service is in the `RUNNING` state and manages all indices that have lifecycle policies.
Follow these steps to check the current {{ilm-init}} status, and to stop or restart it as needed.

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.
### Get {{ilm-init}} status

::::{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.
::::
:::{include} /manage-data/_snippets/ilm-status.md
:::

### Stop {{ilm-init}}

:::{include} /manage-data/_snippets/ilm-stop.md
:::

## Get {{ilm-init}} status [get-ilm-status]

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):

```console
GET _ilm/status
```

Under normal operation, the response shows {{ilm-init}} is `RUNNING`:

```console-result
{
"operation_mode": "RUNNING"
}
```


## Stop {{ilm-init}} [stop-ilm]

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):

```console
POST _ilm/stop
```

{{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:

```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_init]

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.

```console
POST _ilm/start
```
### Start {{ilm-init}}

:::{include} /manage-data/_snippets/ilm-start.md
:::
Loading
Loading