mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-07 13:38:49 +00:00
c8e3128fe4
* [DOCS] Combo version of ILM docs. * [DOCS] Moved tutorial from Kibana. * Adds documentation for index lifecycle policies (#28705) * [DOCS] Adds documentation for index lifecycle policies * [DOCS] Updated image for policy options to show all menu items * Update create-policy.asciidoc * [DOCS] Incorporated review comments on hot and warm phase * [DOCS] Additional changes to warm phase * [DOCS] Removed the word open in the warm phase * Adds X-Pack icon for ILM (#34178) * Add ILM tutorial (#59502) * Add tutorial for ILM with filebeat * Change screenshots and add additional steps * Update screenshots, add numbered steps, and other minor edits * Incorporate feedback: update links, formatting, and minor edits * Move tip inline with list * Apply suggestions from code review Co-Authored-By: James Rodewig <james.rodewig@elastic.co> * Move TIP inline . . . again * Put TIP inline Co-authored-by: James Rodewig <james.rodewig@elastic.co> * Updates for navigation redesign (#68709) * [DOCS] Updates for navigation redesign * Getting started * Set up text * Discover * Dashboard, Graph, ML, Maps, APM, SIEM, Dev tools * Dev Tools, Stack Monitoring, Management * Management * Final changes * [DOCS] Updates for navigation redesign * [DOCS] Updates CCR monitoring screenshots * updates SIEM screenshot and Cases overview text * Added Brandon's APM image * [DOCS] Refines CCR shard screenshot * Removed merge conflict image file Co-authored-by: lcawl <lcawley@elastic.co> Co-authored-by: Ben Skelker <ben.skelker@elastic.co> * [DOCS] Put API examples in collapsible sections like ML does * Fix include * Added tutorial images * Fixed images * Add short title for FB tutorial * Add missing files * Incorporate review feedback * review feedback * Incorporated review feedback Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> Co-authored-by: Lisa Cawley <lcawley@elastic.co> Co-authored-by: Melori Arellano <melori@elastic.co> Co-authored-by: James Rodewig <james.rodewig@elastic.co> Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co> Co-authored-by: Ben Skelker <ben.skelker@elastic.co> Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> Co-authored-by: Lisa Cawley <lcawley@elastic.co> Co-authored-by: Melori Arellano <melori@elastic.co> Co-authored-by: James Rodewig <james.rodewig@elastic.co> Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co> Co-authored-by: Ben Skelker <ben.skelker@elastic.co>
62 lines
1.8 KiB
Plaintext
62 lines
1.8 KiB
Plaintext
[role="xpack"]
|
|
[testenv="basic"]
|
|
[[index-lifecycle-management]]
|
|
= {ilm-init}: Manage the index lifecycle
|
|
|
|
[partintro]
|
|
--
|
|
You can configure {ilm} ({ilm-init}) policies to automatically manage indices
|
|
according to your performance, resiliency, and retention requirements.
|
|
For example, you could use {ilm-init} to:
|
|
|
|
* Spin up a new index when an index reaches a certain size or number of documents
|
|
* Create a new index each day, week, or month and archive previous ones
|
|
* Delete stale indices to enforce data retention standards
|
|
|
|
You can create and manage index lifecycle policies through {kib} Management or the {ilm-init} APIs.
|
|
When you enable {ilm} for {beats} or the {ls} {es} output plugin,
|
|
default policies are configured automatically.
|
|
|
|
[role="screenshot"]
|
|
image:images/ilm/index-lifecycle-policies.png[]
|
|
|
|
[TIP]
|
|
To automatically back up your indices and manage snapshots,
|
|
use <<getting-started-snapshot-lifecycle-management,snapshot lifecycle policies>>.
|
|
|
|
* <<overview-index-lifecycle-management>>
|
|
* <<ilm-concepts>>
|
|
* <<getting-started-index-lifecycle-management>>
|
|
* <<example-using-index-lifecycle-policy>>
|
|
* <<set-up-lifecycle-policy>>
|
|
* <<index-lifecycle-error-handling>>
|
|
* <<start-stop-ilm>>
|
|
* <<ilm-with-existing-indices>>
|
|
* <<skipping-rollover>>
|
|
* <<index-lifecycle-and-snapshots>>
|
|
* <<index-lifecycle-management-api>>
|
|
* <<ilm-actions>>
|
|
|
|
--
|
|
include::ilm-overview.asciidoc[]
|
|
|
|
include::ilm-concepts.asciidoc[]
|
|
|
|
include::ilm-tutorial.asciidoc[]
|
|
|
|
include::example-index-lifecycle-policy.asciidoc[leveloffset=-1]
|
|
|
|
include::ilm-actions.asciidoc[]
|
|
|
|
include::set-up-lifecycle-policy.asciidoc[]
|
|
|
|
include::error-handling.asciidoc[]
|
|
|
|
include::start-stop.asciidoc[]
|
|
|
|
include::ilm-with-existing-indices.asciidoc[]
|
|
|
|
include::ilm-skip-rollover.asciidoc[]
|
|
|
|
include::ilm-and-snapshots.asciidoc[]
|