Fix local_dynamic documentation and add providers inline doc. (elasti…

…c#22657)

* Fix local_dynamic documentation and add providers inline doc.

Fix issues with the configuration and usage of the local_dynamic
provider and add inline documentation in the yaml files.

* Update docker yml

* enable should be true in the yaml

x-pack/elastic-agent/_meta/config/common.p2.yml.tmpl

@@ -200,3 +200,5 @@ agent.logging.to_stderr: true
 # information. Recommended to use in combination with `logging.json=true`
 # Defaults to false.
 #agent.logging.ecs: false
+
+{{template "providers.yml.tmpl" .}}

x-pack/elastic-agent/_meta/config/common.reference.p2.yml.tmpl

@@ -200,3 +200,5 @@ agent.logging.to_stderr: true
 # information. Recommended to use in combination with `logging.json=true`
 # Defaults to false.
 #agent.logging.ecs: false
+
+{{template "providers.yml.tmpl" .}}

x-pack/elastic-agent/_meta/config/elastic-agent.docker.yml.tmpl

@@ -200,3 +200,5 @@ agent.logging.to_stderr: true
 # information. Recommended to use in combination with `logging.json=true`
 # Defaults to false.
 #agent.logging.ecs: false
+
+{{template "providers.yml.tmpl" .}}

x-pack/elastic-agent/_meta/config/providers.yml.tmpl

@@ -0,0 +1,42 @@
+# Providers
+
+# Providers supply the key/values pairs that are used for variable substitution
+# and conditionals. Each provider's keys are automatically prefixed with the name
+# of the provider.
+
+#providers:
+
+# Agent provides information about the running agent.
+#  agent:
+#    enabled: true
+
+# Docker provides inventory information from Docker.
+#  docker:
+#    enabled: true
+#    host: "unix:///var/run/docker.sock"
+#    cleanup_timeout: 60
+
+# Env providers information about the running environment.
+#  env:
+#    enabled: true
+
+# Host provides information about the current host.
+#  host:
+#    enabled: true
+
+# Local provides custom keys to use as variable.
+#  local:
+#    enabled: true
+#    vars:
+#      foo: bar
+
+# Local dynamic allows you to define multiple key/values to generate multiple configurations.
+#  local_dynamic:
+#    enabled: true
+#    items:
+#      - vars:
+#          my_var: key1
+#      - vars:
+#          my_var: key2
+#      - vars:
+#          my_var: key3

x-pack/elastic-agent/docs/elastic-agent-providers.asciidoc

@@ -172,13 +172,18 @@ defines 3 values for `item`:
 ----
 inputs:
  - type: logfile
-   paths: "/var/${item}/app.log"
+   streams:
+     - paths: "/var/${local_dynamic.my_var}/app.log"
 
 providers:
-    vars:
-      - item: key1
-      - item: key2
-      - item: key3
+  local_dynamic:
+    items:
+      - vars:
+          my_var: key1
+      - vars:
+          my_var: key2
+      - vars:
+          my_var: key3
 ----
 
 The configuration generated by this policy looks like:
@@ -187,11 +192,14 @@ The configuration generated by this policy looks like:
 ----
 inputs:
  - type: logfile
-   paths: "/var/key1/app.log"
+   streams:
+     - paths: "/var/key1/app.log"
  - type: logfile
-   paths: "/var/key2/app.log"
+   streams:
+     - paths: "/var/key2/app.log"
  - type: logfile
-   paths: "/var/key3/app.log"
+   streams:
+   - paths: "/var/key3/app.log"
 ----
 
 [[docker-provider]]

x-pack/elastic-agent/elastic-agent.docker.yml

@@ -200,3 +200,47 @@ agent.logging.to_stderr: true
 # information. Recommended to use in combination with `logging.json=true`
 # Defaults to false.
 #agent.logging.ecs: false
+
+# Providers
+
+# Providers supply the key/values pairs that are used for variable substitution
+# and conditionals. Each provider's keys are automatically prefixed with the name
+# of the provider.
+
+#providers:
+
+# Agent provides information about the running agent.
+#  agent:
+#    enabled: true
+
+# Docker provides inventory information from Docker.
+#  docker:
+#    enabled: true
+#    host: "unix:///var/run/docker.sock"
+#    cleanup_timeout: 60
+
+# Env providers information about the running environment.
+#  env:
+#    enabled: true
+
+# Host provides information about the current host.
+#  host:
+#    enabled: true
+
+# Local provides custom keys to use as variable.
+#  local:
+#    enabled: true
+#    vars:
+#      foo: bar
+
+# Local dynamic allows you to define multiple key/values to generate multiple configurations.
+#  local_dynamic:
+#    enabled: true
+#    items:
+#      - vars:
+#          my_var: key1
+#      - vars:
+#          my_var: key2
+#      - vars:
+#          my_var: key3
+

x-pack/elastic-agent/elastic-agent.reference.yml

@@ -207,3 +207,47 @@ agent.logging.to_stderr: true
 # Defaults to false.
 #agent.logging.ecs: false
 
+# Providers
+
+# Providers supply the key/values pairs that are used for variable substitution
+# and conditionals. Each provider's keys are automatically prefixed with the name
+# of the provider.
+
+#providers:
+
+# Agent provides information about the running agent.
+#  agent:
+#    enabled: true
+
+# Docker provides inventory information from Docker.
+#  docker:
+#    enabled: true
+#    host: "unix:///var/run/docker.sock"
+#    cleanup_timeout: 60
+
+# Env providers information about the running environment.
+#  env:
+#    enabled: true
+
+# Host provides information about the current host.
+#  host:
+#    enabled: true
+
+# Local provides custom keys to use as variable.
+#  local:
+#    enabled: true
+#    vars:
+#      foo: bar
+
+# Local dynamic allows you to define multiple key/values to generate multiple configurations.
+#  local_dynamic:
+#    enabled: true
+#    items:
+#      - vars:
+#          my_var: key1
+#      - vars:
+#          my_var: key2
+#      - vars:
+#          my_var: key3
+
+

x-pack/elastic-agent/elastic-agent.yml

@@ -207,3 +207,47 @@ agent.logging.to_stderr: true
 # Defaults to false.
 #agent.logging.ecs: false
 
+# Providers
+
+# Providers supply the key/values pairs that are used for variable substitution
+# and conditionals. Each provider's keys are automatically prefixed with the name
+# of the provider.
+
+#providers:
+
+# Agent provides information about the running agent.
+#  agent:
+#    enabled: true
+
+# Docker provides inventory information from Docker.
+#  docker:
+#    enabled: true
+#    host: "unix:///var/run/docker.sock"
+#    cleanup_timeout: 60
+
+# Env providers information about the running environment.
+#  env:
+#    enabled: true
+
+# Host provides information about the current host.
+#  host:
+#    enabled: true
+
+# Local provides custom keys to use as variable.
+#  local:
+#    enabled: true
+#    vars:
+#      foo: bar
+
+# Local dynamic allows you to define multiple key/values to generate multiple configurations.
+#  local_dynamic:
+#    enabled: true
+#    items:
+#      - vars:
+#          my_var: key1
+#      - vars:
+#          my_var: key2
+#      - vars:
+#          my_var: key3
+
+