From 32c5f9ca582422f46c629f4c6993e80672442cd3 Mon Sep 17 00:00:00 2001 From: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com> Date: Mon, 24 Jun 2024 09:22:18 -0400 Subject: [PATCH] Move Agent policy settings docs to correct location (#1092) * Move Agent policy settings docs to correct location * Add binary download settings (policy), proxy settings (fleet) * Fix hostname format link ID to resolve docs build --- .../ingest-management/agent-policies.asciidoc | 58 +++++++++++++++++++ .../fleet/fleet-settings.asciidoc | 35 ++--------- 2 files changed, 62 insertions(+), 31 deletions(-) diff --git a/docs/en/ingest-management/agent-policies.asciidoc b/docs/en/ingest-management/agent-policies.asciidoc index 60f705dbb..b8e801c75 100644 --- a/docs/en/ingest-management/agent-policies.asciidoc +++ b/docs/en/ingest-management/agent-policies.asciidoc @@ -119,6 +119,14 @@ The following table illustrates the {fleet} user actions available to different |<> |{y} |{n} + +|<> +|{y} +|{n} + +|<> +|{y} +|{n} |=== See also the <> for an {agent} policy. @@ -400,6 +408,56 @@ Under the **Host** header, select the {agent} you want to edit. . On the **Logs** tab, set the **Agent logging level** and apply your changes. Or, you can choose to reset the agent to use the logging level specified in the agent policy. +[discrete] +[[agent-binary-download-settings]] +== Change the {agent} binary download location + +{agent}s must be able to access the {artifact-registry} to download +binaries during upgrades. By default {agent}s download artifacts from the +artifact registry at `https://artifacts.elastic.co/downloads/`. + +For {agent}s that cannot access the internet, you can specify agent binary +download settings, and then configure agents to download their artifacts from +the alternate location. For more information about running {agent}s in a +restricted environment, refer to <>. + +To change the binary download location: + +. In {fleet}, click **Agent policies**. +Select the name of the policy you want to edit. + +. Click the **Settings** tab and scroll to **Agent binary download**. + +. Specify the address where you are hosting the artifacts repository or select the default to use the location specified in the {fleet} <>. + +[discrete] +[[fleet-agent-hostname-format-settings]] +== Set the {agent} host name format + +The **Host name format** setting controls the format of information provided about the current host through the <> key, in events produced by {agent}. + +. In {fleet}, click **Agent policies**. +Select the name of the policy you want to edit. + +. Click the **Settings** tab and scroll to **Host name format**. + +. Select one of the following: + +** **Hostname**: Information about the current host is in a non-fully-qualified format (`somehost`, rather than `somehost.example.com`). This is the default reporting format. + +** **Fully Qualified Domain Name (FQDN)**: Information about the current host is in FQDN format (`somehost.example.com` rather than `somehost`). This helps you to distinguish between hosts on different domains that have similar names. The fully qualified hostname allows each host to be more easily identified when viewed in {kib}, for example. + +. Save your changes. + +NOTE: FQDN reporting is not currently supported in APM. + +For FQDN reporting to work as expected, the hostname of the current host must either: + +* Have a CNAME entry defined in DNS. +* Have one of its corresponding IP addresses respond successfully to a reverse DNS lookup. + +If neither pre-requisite is satisfied, `host.name` continues to report the hostname of the current host in a non-fully-qualified format. + [discrete] [[agent-policy-scale]] == Policy scaling recommendations diff --git a/docs/en/ingest-management/fleet/fleet-settings.asciidoc b/docs/en/ingest-management/fleet/fleet-settings.asciidoc index 3ca35c328..4e635521a 100644 --- a/docs/en/ingest-management/fleet/fleet-settings.asciidoc +++ b/docs/en/ingest-management/fleet/fleet-settings.asciidoc @@ -124,35 +124,8 @@ use the default location if you don't select a different agent binary source in the agent policy. [discrete] -[[fleet-agent-hostname-format-settings]] -== Host name format settings - -These settings control the format of information provided about the current host through the <> key, in events produced by {agent}. - -[cols="2*>.