From cf7b721cd18db58002b8e9611a269a5b9c143fab Mon Sep 17 00:00:00 2001 From: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com> Date: Thu, 17 Oct 2024 11:29:20 -0400 Subject: [PATCH] Update elastic-agent-kubernetes-autodiscovery.asciidoc (#1391) (#1392) Fixed a typo and use autodiscover instead of autodiscovery, as this is the term used in Filebeat doc (in most places). (cherry picked from commit 5cf3685611d38f827a9cb0f5e3d16bcdb5dbafa1) Co-authored-by: Frederic Dartayre <30438455+fdartayre@users.noreply.github.com> (cherry picked from commit 9446195fa969881fb811739b0ac051862003bfc0) --- ...elastic-agent-kubernetes-autodiscovery.asciidoc | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/en/ingest-management/elastic-agent/configuration/autodiscovery/elastic-agent-kubernetes-autodiscovery.asciidoc b/docs/en/ingest-management/elastic-agent/configuration/autodiscovery/elastic-agent-kubernetes-autodiscovery.asciidoc index 5252cc4f5..d46f81e44 100644 --- a/docs/en/ingest-management/elastic-agent/configuration/autodiscovery/elastic-agent-kubernetes-autodiscovery.asciidoc +++ b/docs/en/ingest-management/elastic-agent/configuration/autodiscovery/elastic-agent-kubernetes-autodiscovery.asciidoc @@ -3,9 +3,9 @@ When you run applications on containers, they become moving targets to the monitoring system. Autodiscover allows you to track them and adapt settings as changes happen. By defining configuration templates, the autodiscover subsystem can monitor services as they start running. -To use autodiscovery, you will need to modify the manifest file of the {agent}. Refer to <> to learn how to retrieve and configure it. +To use autodiscover, you will need to modify the manifest file of the {agent}. Refer to <> to learn how to retrieve and configure it. -There are two different ways to use autodiscovery: +There are two different ways to use autodiscover: * <> @@ -13,13 +13,13 @@ There are two different ways to use autodiscovery: [discrete] -== How to configure autodiscovery +== How to configure autodiscover -`Conditions Based Autodiscovery` is more suitable for scenarios when users know the different group of containers they want to monitor in advance. It is advisable to choose conditions-based configuration when administrators can configure specific conditions that match their needs. Conditions are supported in both Managed and Standalone {agent}. +`Conditions Based Autodiscover` is more suitable for scenarios when users know the different group of containers they want to monitor in advance. It is advisable to choose conditions-based configuration when administrators can configure specific conditions that match their needs. Conditions are supported in both Managed and Standalone {agent}. -`Hints Based Autodiscovry` is suitable for more generic scenarios, especially when users don't know the exact configuration of the system to monitor and can not create in advance conditions. Additionally a big advantage of Hints Autodiscovery is the ability to offer dynamic configuration of inputs based on annotations from Pods/Containers. If dynamic configuration is needed, then Hints should be enabled. Hints are supported only in Standalone {agent} mode. +`Hints Based Autodiscover` is suitable for more generic scenarios, especially when users don't know the exact configuration of the system to monitor and can not create in advance conditions. Additionally a big advantage of Hints Autodiscover is the ability to offer dynamic configuration of inputs based on annotations from Pods/Containers. If dynamic configuration is needed, then Hints should be enabled. Hints are supported only in Standalone {agent} mode. -*Best Practises when you configure autodiscovery:* +*Best Practises when you configure autodiscover:* - Always define alternatives and default values to your variables that are used in conditions or [hint templates](eg. See `auth.basic` set as `auth.basic.user: ${kubernetes.hints.nginx.access.username|kubernetes.hints.nginx.username|''}`` in [nginx.yml](https://github.com/elastic/elastic-agent/blob/main/deploy/kubernetes/elastic-agent-standalone/templates.d/nginx.yml#L8)) @@ -27,4 +27,4 @@ IMPORTANT: When an input uses a variable substitution that is not present in the - To debug configurations that include variable substitution and conditions, use the inspect command of {agent}. (See more information in <> in *Debugging* Section) -- In Condition Based autodiscovery is advisable to define a generic last condition that will act as your default condition and will be validated when all others fail or don't apply. If applicable, such conditions might help to identify processing and troubleshoot possible problems. +- In Condition Based autodiscover is advisable to define a generic last condition that will act as your default condition and will be validated when all others fail or don't apply. If applicable, such conditions might help to identify processing and troubleshoot possible problems.