snapshot-settings.asciidoc 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. [[snapshot-settings]]
  2. === Snapshot and restore settings
  3. The following cluster settings configure <<snapshot-restore,snapshot and
  4. restore>>.
  5. [[snapshot-max-concurrent-ops]]
  6. `snapshot.max_concurrent_operations`::
  7. (<<dynamic-cluster-setting,Dynamic>>, integer) Maximum number of concurrent
  8. snapshot operations. Defaults to `1000`.
  9. +
  10. This limit applies in total to all ongoing snapshot creation, cloning, and
  11. deletion operations. {es} will reject any operations that would exceed this
  12. limit.
  13. ==== {slm-init} settings
  14. The following cluster settings configure <<automate-snapshots-slm,{slm}
  15. ({slm-init})>>.
  16. [[slm-history-index-enabled]]
  17. `slm.history_index_enabled`::
  18. (<<dynamic-cluster-setting,Dynamic>>, Boolean)
  19. Controls whether {slm-init} records the history of actions taken as part of {slm-init} policies
  20. to the `slm-history-*` indices. Defaults to `true`.
  21. [[slm-retention-schedule]]
  22. `slm.retention_schedule`::
  23. (<<dynamic-cluster-setting,Dynamic>>, <<schedule-cron,cron scheduler value>>)
  24. Controls when the <<slm-retention-task,retention task>> runs.
  25. Can be a periodic or absolute time schedule.
  26. Supports all values supported by the <<schedule-cron,cron scheduler>>.
  27. Defaults to daily at 1:30am UTC: `0 30 1 * * ?`.
  28. [[slm-retention-duration]]
  29. `slm.retention_duration`::
  30. (<<dynamic-cluster-setting,Dynamic>>, <<time-units,time value>>)
  31. Limits how long {slm-init} should spend deleting old snapshots.
  32. Defaults to one hour: `1h`.
  33. [[slm-health-failed-snapshot-warn-threshold]]
  34. `slm.health.failed_snapshot_warn_threshold`::
  35. (<<dynamic-cluster-setting,Dynamic>>, Long)
  36. The number of failed invocations since last successful snapshot that
  37. indicate a problem with the policy in the health api.
  38. Defaults to a health api warning after five repeated failures: `5L`.
  39. [[repositories-url-allowed]]
  40. // tag::repositories-url-allowed[]
  41. `repositories.url.allowed_urls` {ess-icon}::
  42. (<<static-cluster-setting,Static>>)
  43. Specifies the <<snapshots-read-only-repository,read-only URL repositories>> that snapshots can be restored from.
  44. // end::repositories-url-allowed[]