ilm-actions.asciidoc 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  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. ifdef::permanently-unreleased-branch[]
  24. <<ilm-rollup,Rollup>>::
  25. Aggregates an index's time series data and stores the results in a new read-only
  26. index. For example, you can roll up hourly data into daily or weekly summaries.
  27. endif::[]
  28. <<ilm-searchable-snapshot, Searchable snapshot>>::
  29. beta:[]
  30. Take a snapshot of the managed index in the configured repository
  31. and mount it as a searchable snapshot.
  32. <<ilm-set-priority,Set priority>>::
  33. Lower the priority of an index as it moves through the lifecycle
  34. to ensure that hot indices are recovered first.
  35. <<ilm-shrink,Shrink>>::
  36. Reduce the number of primary shards by shrinking the index into a new index.
  37. <<ilm-unfollow,Unfollow>>::
  38. Convert a follower index to a regular index.
  39. Performed automatically before a rollover, shrink, or searchable snapshot action.
  40. <<ilm-wait-for-snapshot,Wait for snapshot>>::
  41. Ensure that a snapshot exists before deleting the index.
  42. include::actions/ilm-allocate.asciidoc[]
  43. include::actions/ilm-delete.asciidoc[]
  44. include::actions/ilm-forcemerge.asciidoc[]
  45. include::actions/ilm-freeze.asciidoc[]
  46. include::actions/ilm-migrate.asciidoc[]
  47. include::actions/ilm-readonly.asciidoc[]
  48. include::actions/ilm-rollover.asciidoc[]
  49. ifdef::permanently-unreleased-branch[]
  50. include::actions/ilm-rollup.asciidoc[]
  51. endif::[]
  52. include::actions/ilm-searchable-snapshot.asciidoc[]
  53. include::actions/ilm-set-priority.asciidoc[]
  54. include::actions/ilm-shrink.asciidoc[]
  55. include::actions/ilm-unfollow.asciidoc[]
  56. include::actions/ilm-wait-for-snapshot.asciidoc[]