mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-08 14:05:27 +00:00
6ae7327061
* [DOCS] Align with ILM changes. * Apply suggestions from code review Co-authored-by: James Rodewig <james.rodewig@elastic.co> Co-authored-by: Lee Hinman <dakrone@users.noreply.github.com> * Incorporated review comments.
34 lines
1.0 KiB
Plaintext
34 lines
1.0 KiB
Plaintext
[role="xpack"]
|
|
[[slm-settings]]
|
|
=== {slm-cap} settings in {es}
|
|
[subs="attributes"]
|
|
++++
|
|
<titleabbrev>{slm-cap} settings</titleabbrev>
|
|
++++
|
|
|
|
These are the settings available for configuring
|
|
<<snapshot-lifecycle-management, {slm}>> ({slm-init}).
|
|
|
|
==== Cluster-level settings
|
|
|
|
[[slm-history-index-enabled]]
|
|
`slm.history_index_enabled`::
|
|
(boolean)
|
|
Controls whether {slm-init} records the history of actions taken as part of {slm-init} policies
|
|
to the `slm-history-*` indices. Defaults to `true`.
|
|
|
|
[[slm-retention-schedule]]
|
|
`slm.retention_schedule`::
|
|
(<<cluster-update-settings,Dynamic>>, <<schedule-cron,cron scheduler value>>)
|
|
Controls when the <<slm-retention,retention task>> runs.
|
|
Can be a periodic or absolute time schedule.
|
|
Supports all values supported by the <<schedule-cron,cron scheduler>>.
|
|
Defaults to daily at 1:30am UTC: `0 30 1 * * ?`.
|
|
|
|
[[slm-retention-duration]]
|
|
`slm.retention_duration`::
|
|
(<<cluster-update-settings,Dynamic>>, <<time-units,time value>>)
|
|
Limits how long {slm-init} should spend deleting old snapshots.
|
|
Defaults to one hour: `1h`.
|
|
|