update docs

elastic · Oct 3, 2023 · d70168c · d70168c
1 parent 247ef03
commit d70168c
Show file tree

Hide file tree

Showing 15 changed files with 45 additions and 45 deletions.
diff --git a/auditbeat/auditbeat.reference.yml b/auditbeat/auditbeat.reference.yml
@@ -1346,9 +1346,9 @@ setup.template.settings:
 # Enable DSL support. Valid values are true, or false.
 #setup.dsl.enabled: true
 
-# Set the lifecycle policy name. The default policy name is
-# 'auditbeat'.
-#setup.dsl.policy_name: "auditbeat"
+# Set the lifecycle policy name or pattern. For DSL, this name must match the data stream that the lifecycle is for.
+# The default data stream pattern is %{[beat.name]}-%{[beat.version]}"
+#setup.dsl.data_stream_pattern: "auditbeat"
 
 # The path to a JSON file that contains a lifecycle policy configuration. Used
 # to load your own lifecycle policy.

diff --git a/filebeat/filebeat.reference.yml b/filebeat/filebeat.reference.yml
@@ -2442,9 +2442,9 @@ setup.template.settings:
 # Enable DSL support. Valid values are true, or false.
 #setup.dsl.enabled: true
 
-# Set the lifecycle policy name. The default policy name is
-# 'filebeat'.
-#setup.dsl.policy_name: "filebeat"
+# Set the lifecycle policy name or pattern. For DSL, this name must match the data stream that the lifecycle is for.
+# The default data stream pattern is %{[beat.name]}-%{[beat.version]}"
+#setup.dsl.data_stream_pattern: "filebeat"
 
 # The path to a JSON file that contains a lifecycle policy configuration. Used
 # to load your own lifecycle policy.

diff --git a/heartbeat/heartbeat.reference.yml b/heartbeat/heartbeat.reference.yml
@@ -1438,9 +1438,9 @@ setup.template.settings:
 # Enable DSL support. Valid values are true, or false.
 #setup.dsl.enabled: true
 
-# Set the lifecycle policy name. The default policy name is
-# 'heartbeat'.
-#setup.dsl.policy_name: "heartbeat"
+# Set the lifecycle policy name or pattern. For DSL, this name must match the data stream that the lifecycle is for.
+# The default data stream pattern is %{[beat.name]}-%{[beat.version]}"
+#setup.dsl.data_stream_pattern: "heartbeat"
 
 # The path to a JSON file that contains a lifecycle policy configuration. Used
 # to load your own lifecycle policy.

diff --git a/libbeat/_meta/config/setup.dsl.reference.yml.tmpl b/libbeat/_meta/config/setup.dsl.reference.yml.tmpl
@@ -6,9 +6,9 @@
 # Enable DSL support. Valid values are true, or false.
 #setup.dsl.enabled: true
 
-# Set the lifecycle policy name. The default policy name is
-# '{{.BeatName}}'.
-#setup.dsl.policy_name: "{{.BeatName}}"
+# Set the lifecycle policy name or pattern. For DSL, this name must match the data stream that the lifecycle is for.
+# The default data stream pattern is %{[beat.name]}-%{[beat.version]}"
+#setup.dsl.data_stream_pattern: "{{.BeatName}}"
 
 # The path to a JSON file that contains a lifecycle policy configuration. Used
 # to load your own lifecycle policy.

diff --git a/metricbeat/metricbeat.reference.yml b/metricbeat/metricbeat.reference.yml
@@ -2181,9 +2181,9 @@ setup.template.settings:
 # Enable DSL support. Valid values are true, or false.
 #setup.dsl.enabled: true
 
-# Set the lifecycle policy name. The default policy name is
-# 'metricbeat'.
-#setup.dsl.policy_name: "metricbeat"
+# Set the lifecycle policy name or pattern. For DSL, this name must match the data stream that the lifecycle is for.
+# The default data stream pattern is %{[beat.name]}-%{[beat.version]}"
+#setup.dsl.data_stream_pattern: "metricbeat"
 
 # The path to a JSON file that contains a lifecycle policy configuration. Used
 # to load your own lifecycle policy.

diff --git a/packetbeat/packetbeat.reference.yml b/packetbeat/packetbeat.reference.yml
@@ -1812,9 +1812,9 @@ setup.template.settings:
 # Enable DSL support. Valid values are true, or false.
 #setup.dsl.enabled: true
 
-# Set the lifecycle policy name. The default policy name is
-# 'packetbeat'.
-#setup.dsl.policy_name: "packetbeat"
+# Set the lifecycle policy name or pattern. For DSL, this name must match the data stream that the lifecycle is for.
+# The default data stream pattern is %{[beat.name]}-%{[beat.version]}"
+#setup.dsl.data_stream_pattern: "packetbeat"
 
 # The path to a JSON file that contains a lifecycle policy configuration. Used
 # to load your own lifecycle policy.

diff --git a/winlogbeat/winlogbeat.reference.yml b/winlogbeat/winlogbeat.reference.yml
@@ -1228,9 +1228,9 @@ setup.template.settings:
 # Enable DSL support. Valid values are true, or false.
 #setup.dsl.enabled: true
 
-# Set the lifecycle policy name. The default policy name is
-# 'winlogbeat'.
-#setup.dsl.policy_name: "winlogbeat"
+# Set the lifecycle policy name or pattern. For DSL, this name must match the data stream that the lifecycle is for.
+# The default data stream pattern is %{[beat.name]}-%{[beat.version]}"
+#setup.dsl.data_stream_pattern: "winlogbeat"
 
 # The path to a JSON file that contains a lifecycle policy configuration. Used
 # to load your own lifecycle policy.

diff --git a/x-pack/auditbeat/auditbeat.reference.yml b/x-pack/auditbeat/auditbeat.reference.yml
@@ -1402,9 +1402,9 @@ setup.template.settings:
 # Enable DSL support. Valid values are true, or false.
 #setup.dsl.enabled: true
 
-# Set the lifecycle policy name. The default policy name is
-# 'auditbeat'.
-#setup.dsl.policy_name: "auditbeat"
+# Set the lifecycle policy name or pattern. For DSL, this name must match the data stream that the lifecycle is for.
+# The default data stream pattern is %{[beat.name]}-%{[beat.version]}"
+#setup.dsl.data_stream_pattern: "auditbeat"
 
 # The path to a JSON file that contains a lifecycle policy configuration. Used
 # to load your own lifecycle policy.

diff --git a/x-pack/filebeat/filebeat.reference.yml b/x-pack/filebeat/filebeat.reference.yml
@@ -4812,9 +4812,9 @@ setup.template.settings:
 # Enable DSL support. Valid values are true, or false.
 #setup.dsl.enabled: true
 
-# Set the lifecycle policy name. The default policy name is
-# 'filebeat'.
-#setup.dsl.policy_name: "filebeat"
+# Set the lifecycle policy name or pattern. For DSL, this name must match the data stream that the lifecycle is for.
+# The default data stream pattern is %{[beat.name]}-%{[beat.version]}"
+#setup.dsl.data_stream_pattern: "filebeat"
 
 # The path to a JSON file that contains a lifecycle policy configuration. Used
 # to load your own lifecycle policy.

diff --git a/x-pack/functionbeat/functionbeat.reference.yml b/x-pack/functionbeat/functionbeat.reference.yml
@@ -1066,9 +1066,9 @@ setup.template.settings:
 # Enable DSL support. Valid values are true, or false.
 #setup.dsl.enabled: true
 
-# Set the lifecycle policy name. The default policy name is
-# 'functionbeat'.
-#setup.dsl.policy_name: "functionbeat"
+# Set the lifecycle policy name or pattern. For DSL, this name must match the data stream that the lifecycle is for.
+# The default data stream pattern is %{[beat.name]}-%{[beat.version]}"
+#setup.dsl.data_stream_pattern: "functionbeat"
 
 # The path to a JSON file that contains a lifecycle policy configuration. Used
 # to load your own lifecycle policy.

diff --git a/x-pack/heartbeat/heartbeat.reference.yml b/x-pack/heartbeat/heartbeat.reference.yml
@@ -1438,9 +1438,9 @@ setup.template.settings:
 # Enable DSL support. Valid values are true, or false.
 #setup.dsl.enabled: true
 
-# Set the lifecycle policy name. The default policy name is
-# 'heartbeat'.
-#setup.dsl.policy_name: "heartbeat"
+# Set the lifecycle policy name or pattern. For DSL, this name must match the data stream that the lifecycle is for.
+# The default data stream pattern is %{[beat.name]}-%{[beat.version]}"
+#setup.dsl.data_stream_pattern: "heartbeat"
 
 # The path to a JSON file that contains a lifecycle policy configuration. Used
 # to load your own lifecycle policy.

diff --git a/x-pack/metricbeat/metricbeat.reference.yml b/x-pack/metricbeat/metricbeat.reference.yml
@@ -2742,9 +2742,9 @@ setup.template.settings:
 # Enable DSL support. Valid values are true, or false.
 #setup.dsl.enabled: true
 
-# Set the lifecycle policy name. The default policy name is
-# 'metricbeat'.
-#setup.dsl.policy_name: "metricbeat"
+# Set the lifecycle policy name or pattern. For DSL, this name must match the data stream that the lifecycle is for.
+# The default data stream pattern is %{[beat.name]}-%{[beat.version]}"
+#setup.dsl.data_stream_pattern: "metricbeat"
 
 # The path to a JSON file that contains a lifecycle policy configuration. Used
 # to load your own lifecycle policy.

diff --git a/x-pack/osquerybeat/osquerybeat.reference.yml b/x-pack/osquerybeat/osquerybeat.reference.yml
@@ -785,9 +785,9 @@ setup.template.settings:
 # Enable DSL support. Valid values are true, or false.
 #setup.dsl.enabled: true
 
-# Set the lifecycle policy name. The default policy name is
-# 'osquerybeat'.
-#setup.dsl.policy_name: "osquerybeat"
+# Set the lifecycle policy name or pattern. For DSL, this name must match the data stream that the lifecycle is for.
+# The default data stream pattern is %{[beat.name]}-%{[beat.version]}"
+#setup.dsl.data_stream_pattern: "osquerybeat"
 
 # The path to a JSON file that contains a lifecycle policy configuration. Used
 # to load your own lifecycle policy.

diff --git a/x-pack/packetbeat/packetbeat.reference.yml b/x-pack/packetbeat/packetbeat.reference.yml
@@ -1812,9 +1812,9 @@ setup.template.settings:
 # Enable DSL support. Valid values are true, or false.
 #setup.dsl.enabled: true
 
-# Set the lifecycle policy name. The default policy name is
-# 'packetbeat'.
-#setup.dsl.policy_name: "packetbeat"
+# Set the lifecycle policy name or pattern. For DSL, this name must match the data stream that the lifecycle is for.
+# The default data stream pattern is %{[beat.name]}-%{[beat.version]}"
+#setup.dsl.data_stream_pattern: "packetbeat"
 
 # The path to a JSON file that contains a lifecycle policy configuration. Used
 # to load your own lifecycle policy.

diff --git a/x-pack/winlogbeat/winlogbeat.reference.yml b/x-pack/winlogbeat/winlogbeat.reference.yml
@@ -1230,9 +1230,9 @@ setup.template.settings:
 # Enable DSL support. Valid values are true, or false.
 #setup.dsl.enabled: true
 
-# Set the lifecycle policy name. The default policy name is
-# 'winlogbeat'.
-#setup.dsl.policy_name: "winlogbeat"
+# Set the lifecycle policy name or pattern. For DSL, this name must match the data stream that the lifecycle is for.
+# The default data stream pattern is %{[beat.name]}-%{[beat.version]}"
+#setup.dsl.data_stream_pattern: "winlogbeat"
 
 # The path to a JSON file that contains a lifecycle policy configuration. Used
 # to load your own lifecycle policy.