ilm-actions.asciidoc 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  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-migrate,Migrate>>::
  14. Move the index shards to the <<data-tiers, data tier>> that corresponds
  15. to the current {ilm-init} phase.
  16. <<ilm-readonly,Read only>>::
  17. Block write operations to the index.
  18. <<ilm-rollover,Rollover>>::
  19. Remove the index as the write index for the rollover alias and
  20. start indexing to a new index.
  21. <<ilm-searchable-snapshot, Searchable snapshot>>::
  22. Take a snapshot of the managed index in the configured repository
  23. and mount it as a searchable snapshot.
  24. <<ilm-set-priority,Set priority>>::
  25. Lower the priority of an index as it moves through the lifecycle
  26. to ensure that hot indices are recovered first.
  27. <<ilm-shrink,Shrink>>::
  28. Reduce the number of primary shards by shrinking the index into a new index.
  29. <<ilm-unfollow,Unfollow>>::
  30. Convert a follower index to a regular index.
  31. Performed automatically before a rollover, shrink, or searchable snapshot action.
  32. <<ilm-wait-for-snapshot,Wait for snapshot>>::
  33. Ensure that a snapshot exists before deleting the index.
  34. include::actions/ilm-allocate.asciidoc[]
  35. include::actions/ilm-delete.asciidoc[]
  36. include::actions/ilm-forcemerge.asciidoc[]
  37. include::actions/ilm-migrate.asciidoc[]
  38. include::actions/ilm-readonly.asciidoc[]
  39. include::actions/ilm-rollover.asciidoc[]
  40. include::actions/ilm-searchable-snapshot.asciidoc[]
  41. include::actions/ilm-set-priority.asciidoc[]
  42. include::actions/ilm-shrink.asciidoc[]
  43. include::actions/ilm-unfollow.asciidoc[]
  44. include::actions/ilm-wait-for-snapshot.asciidoc[]