index.asciidoc 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. [role="xpack"]
  2. [[index-lifecycle-management]]
  3. = {ilm-init}: Manage the index lifecycle
  4. [partintro]
  5. --
  6. You can configure {ilm} ({ilm-init}) policies to automatically manage indices
  7. according to your performance, resiliency, and retention requirements.
  8. For example, you could use {ilm-init} to:
  9. * Spin up a new index when an index reaches a certain size or number of documents
  10. * Create a new index each day, week, or month and archive previous ones
  11. * Delete stale indices to enforce data retention standards
  12. You can create and manage index lifecycle policies through {kib} Management or the {ilm-init} APIs.
  13. When you enable {ilm} for {beats} or the {ls} {es} output plugin,
  14. default policies are configured automatically.
  15. [role="screenshot"]
  16. image:images/ilm/index-lifecycle-policies.png[]
  17. [TIP]
  18. To automatically back up your indices and manage snapshots,
  19. use <<getting-started-snapshot-lifecycle-management,snapshot lifecycle policies>>.
  20. * <<overview-index-lifecycle-management>>
  21. * <<ilm-concepts>>
  22. * <<getting-started-index-lifecycle-management>>
  23. * <<example-using-index-lifecycle-policy>>
  24. * <<set-up-lifecycle-policy>>
  25. * <<migrate-index-allocation-filters>>
  26. * <<index-lifecycle-error-handling>>
  27. * <<start-stop-ilm>>
  28. * <<ilm-with-existing-indices>>
  29. * <<skipping-rollover>>
  30. * <<index-lifecycle-and-snapshots>>
  31. * <<index-lifecycle-management-api>>
  32. * <<ilm-actions>>
  33. --
  34. include::ilm-overview.asciidoc[]
  35. include::ilm-concepts.asciidoc[]
  36. include::ilm-tutorial.asciidoc[]
  37. include::example-index-lifecycle-policy.asciidoc[leveloffset=-1]
  38. include::ilm-actions.asciidoc[]
  39. include::set-up-lifecycle-policy.asciidoc[]
  40. include::../data-management/migrate-index-allocation-filters.asciidoc[]
  41. include::error-handling.asciidoc[]
  42. include::start-stop.asciidoc[]
  43. include::ilm-with-existing-indices.asciidoc[]
  44. include::ilm-skip-rollover.asciidoc[]
  45. include::ilm-and-snapshots.asciidoc[]