Add documentation

elastic · Mar 10, 2020 · 54d0b5c · 54d0b5c
1 parent c377c01
commit 54d0b5c
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 0 deletions.
diff --git a/filebeat/docs/autodiscover-hints.asciidoc b/filebeat/docs/autodiscover-hints.asciidoc
@@ -155,6 +155,24 @@ annotations:
   co.elastic.logs.sidecar/exclude_lines: '^DBG'
 -----
 
+[float]
+===== Configuring Namespace Defaults
+
+Hints can be configured on the Namespace's annotations as defaults to use when Pod level annotations are missing.
+The resultant hints are a combination of Pod annotations and Namespace annotations with the Pod's taking precedence. To
+enable Namespace defaults configure the `add_resource_metadata` for Namespace objects as follows:
+
+["source","yaml",subs="attributes"]
+-------------------------------------------------------------------------------------
+filebeat.autodiscover:
+  providers:
+    - type: kubernetes
+      hints.enabled: true
+      add_resource_metadata:
+        namespace:
+          enabled: true
+-------------------------------------------------------------------------------------
+
 
 
 [float]

diff --git a/metricbeat/docs/autodiscover-hints.asciidoc b/metricbeat/docs/autodiscover-hints.asciidoc
@@ -126,6 +126,25 @@ annotations:
   co.elastic.metrics.sidecar/hosts: '${data.host}:8080'
 -------------------------------------------------------------------------------------
 
+[float]
+===== Configuring Namespace Defaults
+
+Hints can be configured on the Namespace's annotations as defaults to use when Pod level annotations are missing.
+The resultant hints are a combination of Pod annotations and Namespace annotations with the Pod's taking precedence. To
+enable Namespace defaults configure the `add_resource_metadata` for Namespace objects as follows:
+
+["source","yaml",subs="attributes"]
+-------------------------------------------------------------------------------------
+metricbeat.autodiscover:
+  providers:
+    - type: kubernetes
+      hints.enabled: true
+      add_resource_metadata:
+        namespace:
+          enabled: true
+-------------------------------------------------------------------------------------
+
+
 [float]
 === Docker