From ebebb4e956704f2c9ada611c4631b7d2f363bc57 Mon Sep 17 00:00:00 2001 From: "mergify[bot]" <37929162+mergify[bot]@users.noreply.github.com> Date: Wed, 14 Feb 2024 08:16:31 +0100 Subject: [PATCH] Update `setup.ilm.check_exists` documentation (#37430) (#38002) This commit updates the documentation from `setup.ilm.check_exists` in our reference configuration files to better explain how it works and align the wording with our public documentation. --------- Co-authored-by: Shaunak Kashyap (cherry picked from commit 33ca67e17215c1cfe4cc0b81b293fd8cfd5966e8) Co-authored-by: Tiago Queiroz --- auditbeat/auditbeat.reference.yml | 6 +++--- filebeat/filebeat.reference.yml | 6 +++--- heartbeat/heartbeat.reference.yml | 6 +++--- libbeat/_meta/config/setup.ilm.reference.yml.tmpl | 6 +++--- libbeat/idxmgmt/lifecycle/config.go | 6 +++--- metricbeat/metricbeat.reference.yml | 6 +++--- packetbeat/packetbeat.reference.yml | 6 +++--- winlogbeat/winlogbeat.reference.yml | 6 +++--- x-pack/auditbeat/auditbeat.reference.yml | 6 +++--- x-pack/filebeat/filebeat.reference.yml | 6 +++--- x-pack/functionbeat/functionbeat.reference.yml | 6 +++--- x-pack/heartbeat/heartbeat.reference.yml | 6 +++--- x-pack/metricbeat/metricbeat.reference.yml | 6 +++--- x-pack/osquerybeat/osquerybeat.reference.yml | 6 +++--- x-pack/packetbeat/packetbeat.reference.yml | 6 +++--- x-pack/winlogbeat/winlogbeat.reference.yml | 6 +++--- 16 files changed, 48 insertions(+), 48 deletions(-) diff --git a/auditbeat/auditbeat.reference.yml b/auditbeat/auditbeat.reference.yml index 883760ab410b..fd0510931435 100644 --- a/auditbeat/auditbeat.reference.yml +++ b/auditbeat/auditbeat.reference.yml @@ -1351,9 +1351,9 @@ setup.template.settings: # to load your own lifecycle policy. #setup.ilm.policy_file: -# Disable the check for an existing lifecycle policy. The default is true. If -# you disable this check, set setup.ilm.overwrite: true so the lifecycle policy -# can be installed. +# Disable the check for an existing lifecycle policy. The default is true. +# If you set this option to false, lifecycle policy will not be installed, +# even if setup.ilm.overwrite is set to true. #setup.ilm.check_exists: true # Overwrite the lifecycle policy at startup. The default is false. diff --git a/filebeat/filebeat.reference.yml b/filebeat/filebeat.reference.yml index 755db3726e7e..bc5ebdc3d151 100644 --- a/filebeat/filebeat.reference.yml +++ b/filebeat/filebeat.reference.yml @@ -2447,9 +2447,9 @@ setup.template.settings: # to load your own lifecycle policy. #setup.ilm.policy_file: -# Disable the check for an existing lifecycle policy. The default is true. If -# you disable this check, set setup.ilm.overwrite: true so the lifecycle policy -# can be installed. +# Disable the check for an existing lifecycle policy. The default is true. +# If you set this option to false, lifecycle policy will not be installed, +# even if setup.ilm.overwrite is set to true. #setup.ilm.check_exists: true # Overwrite the lifecycle policy at startup. The default is false. diff --git a/heartbeat/heartbeat.reference.yml b/heartbeat/heartbeat.reference.yml index 2b2f28382e91..04df2d4dbcd2 100644 --- a/heartbeat/heartbeat.reference.yml +++ b/heartbeat/heartbeat.reference.yml @@ -1443,9 +1443,9 @@ setup.template.settings: # to load your own lifecycle policy. #setup.ilm.policy_file: -# Disable the check for an existing lifecycle policy. The default is true. If -# you disable this check, set setup.ilm.overwrite: true so the lifecycle policy -# can be installed. +# Disable the check for an existing lifecycle policy. The default is true. +# If you set this option to false, lifecycle policy will not be installed, +# even if setup.ilm.overwrite is set to true. #setup.ilm.check_exists: true # Overwrite the lifecycle policy at startup. The default is false. diff --git a/libbeat/_meta/config/setup.ilm.reference.yml.tmpl b/libbeat/_meta/config/setup.ilm.reference.yml.tmpl index 296bf0872efb..6e2aed0b828e 100644 --- a/libbeat/_meta/config/setup.ilm.reference.yml.tmpl +++ b/libbeat/_meta/config/setup.ilm.reference.yml.tmpl @@ -14,9 +14,9 @@ # to load your own lifecycle policy. #setup.ilm.policy_file: -# Disable the check for an existing lifecycle policy. The default is true. If -# you disable this check, set setup.ilm.overwrite: true so the lifecycle policy -# can be installed. +# Disable the check for an existing lifecycle policy. The default is true. +# If you set this option to false, lifecycle policy will not be installed, +# even if setup.ilm.overwrite is set to true. #setup.ilm.check_exists: true # Overwrite the lifecycle policy at startup. The default is false. diff --git a/libbeat/idxmgmt/lifecycle/config.go b/libbeat/idxmgmt/lifecycle/config.go index b25d5ecff6da..5d1f4e9435ba 100644 --- a/libbeat/idxmgmt/lifecycle/config.go +++ b/libbeat/idxmgmt/lifecycle/config.go @@ -33,9 +33,9 @@ type Config struct { // used only for testing policyRaw *Policy - // CheckExists can disable the check for an existing policy. Check required - // read_ilm privileges. If check is disabled the policy will only be - // installed if Overwrite is enabled. + // CheckExists can disable the check for an existing policy. This check + // requires read_ilm privileges. If CheckExists is set to false, the policy + // will not be installed, even if Overwrite is enabled. CheckExists bool `config:"check_exists"` // Enable always overwrite policy mode. This required manage_ilm privileges. diff --git a/metricbeat/metricbeat.reference.yml b/metricbeat/metricbeat.reference.yml index d6b8b9e9475d..6659ca292769 100644 --- a/metricbeat/metricbeat.reference.yml +++ b/metricbeat/metricbeat.reference.yml @@ -2201,9 +2201,9 @@ setup.template.settings: # to load your own lifecycle policy. #setup.ilm.policy_file: -# Disable the check for an existing lifecycle policy. The default is true. If -# you disable this check, set setup.ilm.overwrite: true so the lifecycle policy -# can be installed. +# Disable the check for an existing lifecycle policy. The default is true. +# If you set this option to false, lifecycle policy will not be installed, +# even if setup.ilm.overwrite is set to true. #setup.ilm.check_exists: true # Overwrite the lifecycle policy at startup. The default is false. diff --git a/packetbeat/packetbeat.reference.yml b/packetbeat/packetbeat.reference.yml index 1e013fb081f5..9a9cccf37a7e 100644 --- a/packetbeat/packetbeat.reference.yml +++ b/packetbeat/packetbeat.reference.yml @@ -1817,9 +1817,9 @@ setup.template.settings: # to load your own lifecycle policy. #setup.ilm.policy_file: -# Disable the check for an existing lifecycle policy. The default is true. If -# you disable this check, set setup.ilm.overwrite: true so the lifecycle policy -# can be installed. +# Disable the check for an existing lifecycle policy. The default is true. +# If you set this option to false, lifecycle policy will not be installed, +# even if setup.ilm.overwrite is set to true. #setup.ilm.check_exists: true # Overwrite the lifecycle policy at startup. The default is false. diff --git a/winlogbeat/winlogbeat.reference.yml b/winlogbeat/winlogbeat.reference.yml index 8b7bad94c232..a6a042f4aba4 100644 --- a/winlogbeat/winlogbeat.reference.yml +++ b/winlogbeat/winlogbeat.reference.yml @@ -1233,9 +1233,9 @@ setup.template.settings: # to load your own lifecycle policy. #setup.ilm.policy_file: -# Disable the check for an existing lifecycle policy. The default is true. If -# you disable this check, set setup.ilm.overwrite: true so the lifecycle policy -# can be installed. +# Disable the check for an existing lifecycle policy. The default is true. +# If you set this option to false, lifecycle policy will not be installed, +# even if setup.ilm.overwrite is set to true. #setup.ilm.check_exists: true # Overwrite the lifecycle policy at startup. The default is false. diff --git a/x-pack/auditbeat/auditbeat.reference.yml b/x-pack/auditbeat/auditbeat.reference.yml index 45d1c4af8510..37339153c94b 100644 --- a/x-pack/auditbeat/auditbeat.reference.yml +++ b/x-pack/auditbeat/auditbeat.reference.yml @@ -1407,9 +1407,9 @@ setup.template.settings: # to load your own lifecycle policy. #setup.ilm.policy_file: -# Disable the check for an existing lifecycle policy. The default is true. If -# you disable this check, set setup.ilm.overwrite: true so the lifecycle policy -# can be installed. +# Disable the check for an existing lifecycle policy. The default is true. +# If you set this option to false, lifecycle policy will not be installed, +# even if setup.ilm.overwrite is set to true. #setup.ilm.check_exists: true # Overwrite the lifecycle policy at startup. The default is false. diff --git a/x-pack/filebeat/filebeat.reference.yml b/x-pack/filebeat/filebeat.reference.yml index 14308c2cce15..12ed53d97f2f 100644 --- a/x-pack/filebeat/filebeat.reference.yml +++ b/x-pack/filebeat/filebeat.reference.yml @@ -4823,9 +4823,9 @@ setup.template.settings: # to load your own lifecycle policy. #setup.ilm.policy_file: -# Disable the check for an existing lifecycle policy. The default is true. If -# you disable this check, set setup.ilm.overwrite: true so the lifecycle policy -# can be installed. +# Disable the check for an existing lifecycle policy. The default is true. +# If you set this option to false, lifecycle policy will not be installed, +# even if setup.ilm.overwrite is set to true. #setup.ilm.check_exists: true # Overwrite the lifecycle policy at startup. The default is false. diff --git a/x-pack/functionbeat/functionbeat.reference.yml b/x-pack/functionbeat/functionbeat.reference.yml index 4e939b686a60..2284fedbcce9 100644 --- a/x-pack/functionbeat/functionbeat.reference.yml +++ b/x-pack/functionbeat/functionbeat.reference.yml @@ -1071,9 +1071,9 @@ setup.template.settings: # to load your own lifecycle policy. #setup.ilm.policy_file: -# Disable the check for an existing lifecycle policy. The default is true. If -# you disable this check, set setup.ilm.overwrite: true so the lifecycle policy -# can be installed. +# Disable the check for an existing lifecycle policy. The default is true. +# If you set this option to false, lifecycle policy will not be installed, +# even if setup.ilm.overwrite is set to true. #setup.ilm.check_exists: true # Overwrite the lifecycle policy at startup. The default is false. diff --git a/x-pack/heartbeat/heartbeat.reference.yml b/x-pack/heartbeat/heartbeat.reference.yml index 2b2f28382e91..04df2d4dbcd2 100644 --- a/x-pack/heartbeat/heartbeat.reference.yml +++ b/x-pack/heartbeat/heartbeat.reference.yml @@ -1443,9 +1443,9 @@ setup.template.settings: # to load your own lifecycle policy. #setup.ilm.policy_file: -# Disable the check for an existing lifecycle policy. The default is true. If -# you disable this check, set setup.ilm.overwrite: true so the lifecycle policy -# can be installed. +# Disable the check for an existing lifecycle policy. The default is true. +# If you set this option to false, lifecycle policy will not be installed, +# even if setup.ilm.overwrite is set to true. #setup.ilm.check_exists: true # Overwrite the lifecycle policy at startup. The default is false. diff --git a/x-pack/metricbeat/metricbeat.reference.yml b/x-pack/metricbeat/metricbeat.reference.yml index a22db4f7f8cf..1e6abf11a604 100644 --- a/x-pack/metricbeat/metricbeat.reference.yml +++ b/x-pack/metricbeat/metricbeat.reference.yml @@ -2762,9 +2762,9 @@ setup.template.settings: # to load your own lifecycle policy. #setup.ilm.policy_file: -# Disable the check for an existing lifecycle policy. The default is true. If -# you disable this check, set setup.ilm.overwrite: true so the lifecycle policy -# can be installed. +# Disable the check for an existing lifecycle policy. The default is true. +# If you set this option to false, lifecycle policy will not be installed, +# even if setup.ilm.overwrite is set to true. #setup.ilm.check_exists: true # Overwrite the lifecycle policy at startup. The default is false. diff --git a/x-pack/osquerybeat/osquerybeat.reference.yml b/x-pack/osquerybeat/osquerybeat.reference.yml index 1de9a267ae5c..0c28af891443 100644 --- a/x-pack/osquerybeat/osquerybeat.reference.yml +++ b/x-pack/osquerybeat/osquerybeat.reference.yml @@ -790,9 +790,9 @@ setup.template.settings: # to load your own lifecycle policy. #setup.ilm.policy_file: -# Disable the check for an existing lifecycle policy. The default is true. If -# you disable this check, set setup.ilm.overwrite: true so the lifecycle policy -# can be installed. +# Disable the check for an existing lifecycle policy. The default is true. +# If you set this option to false, lifecycle policy will not be installed, +# even if setup.ilm.overwrite is set to true. #setup.ilm.check_exists: true # Overwrite the lifecycle policy at startup. The default is false. diff --git a/x-pack/packetbeat/packetbeat.reference.yml b/x-pack/packetbeat/packetbeat.reference.yml index 1e013fb081f5..9a9cccf37a7e 100644 --- a/x-pack/packetbeat/packetbeat.reference.yml +++ b/x-pack/packetbeat/packetbeat.reference.yml @@ -1817,9 +1817,9 @@ setup.template.settings: # to load your own lifecycle policy. #setup.ilm.policy_file: -# Disable the check for an existing lifecycle policy. The default is true. If -# you disable this check, set setup.ilm.overwrite: true so the lifecycle policy -# can be installed. +# Disable the check for an existing lifecycle policy. The default is true. +# If you set this option to false, lifecycle policy will not be installed, +# even if setup.ilm.overwrite is set to true. #setup.ilm.check_exists: true # Overwrite the lifecycle policy at startup. The default is false. diff --git a/x-pack/winlogbeat/winlogbeat.reference.yml b/x-pack/winlogbeat/winlogbeat.reference.yml index 528560748fb4..5bc8f774e03c 100644 --- a/x-pack/winlogbeat/winlogbeat.reference.yml +++ b/x-pack/winlogbeat/winlogbeat.reference.yml @@ -1235,9 +1235,9 @@ setup.template.settings: # to load your own lifecycle policy. #setup.ilm.policy_file: -# Disable the check for an existing lifecycle policy. The default is true. If -# you disable this check, set setup.ilm.overwrite: true so the lifecycle policy -# can be installed. +# Disable the check for an existing lifecycle policy. The default is true. +# If you set this option to false, lifecycle policy will not be installed, +# even if setup.ilm.overwrite is set to true. #setup.ilm.check_exists: true # Overwrite the lifecycle policy at startup. The default is false.