ilm-actions.asciidoc 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. [role="xpack"]
  2. [testenv="basic"]
  3. [[ilm-actions]]
  4. == Index lifecycle actions
  5. <<ilm-allocate,Allocate>>::
  6. Move shards to nodes with different performance characteristics
  7. and reduce the number of replicas.
  8. <<ilm-delete,Delete>>::
  9. Permanently remove the index.
  10. <<ilm-forcemerge,Force merge>>::
  11. Reduce the number of index segments and purge deleted documents.
  12. Makes the index read-only.
  13. <<ilm-freeze,Freeze>>::
  14. Freeze the index to minimize its memory footprint.
  15. <<ilm-migrate,Migrate>>::
  16. Move the index shards to the <<data-tiers, data tier>> that corresponds
  17. to the current {ilm-init} phase.
  18. <<ilm-readonly,Read only>>::
  19. Block write operations to the index.
  20. <<ilm-rollover,Rollover>>::
  21. Remove the index as the write index for the rollover alias and
  22. start indexing to a new index.
  23. <<ilm-searchable-snapshot, Searchable snapshot>>::
  24. Take a snapshot of the managed index in the configured repository
  25. and mount it as a searchable snapshot.
  26. <<ilm-set-priority,Set priority>>::
  27. Lower the priority of an index as it moves through the lifecycle
  28. to ensure that hot indices are recovered first.
  29. <<ilm-shrink,Shrink>>::
  30. Reduce the number of primary shards by shrinking the index into a new index.
  31. <<ilm-unfollow,Unfollow>>::
  32. Convert a follower index to a regular index.
  33. Performed automatically before a rollover, shrink, or searchable snapshot action.
  34. <<ilm-wait-for-snapshot,Wait for snapshot>>::
  35. Ensure that a snapshot exists before deleting the index.
  36. include::actions/ilm-allocate.asciidoc[]
  37. include::actions/ilm-delete.asciidoc[]
  38. include::actions/ilm-forcemerge.asciidoc[]
  39. include::actions/ilm-freeze.asciidoc[]
  40. include::actions/ilm-migrate.asciidoc[]
  41. include::actions/ilm-readonly.asciidoc[]
  42. include::actions/ilm-rollover.asciidoc[]
  43. include::actions/ilm-searchable-snapshot.asciidoc[]
  44. include::actions/ilm-set-priority.asciidoc[]
  45. include::actions/ilm-shrink.asciidoc[]
  46. include::actions/ilm-unfollow.asciidoc[]
  47. include::actions/ilm-wait-for-snapshot.asciidoc[]