Skip to content

Commit

Permalink
Move Agent policy settings docs to correct location (#1092)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
kilfoyle authored Jun 24, 2024
1 parent 6974f74 commit 32c5f9c
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 31 deletions.
58 changes: 58 additions & 0 deletions docs/en/ingest-management/agent-policies.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,14 @@ The following table illustrates the {fleet} user actions available to different
|<<agent-policy-log-level>>
|{y}
|{n}

|<<agent-binary-download-settings>>
|{y}
|{n}

|<<fleet-agent-hostname-format-settings>>
|{y}
|{n}
|===

See also the <<agent-policy-scale,recommended scaling options>> for an {agent} policy.
Expand Down Expand Up @@ -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 <<air-gapped>>.

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} <<fleet-agent-binary-download-settings,agent binary download settings>>.

[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 <<host-provider,host.name>> 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
Expand Down
35 changes: 4 additions & 31 deletions docs/en/ingest-management/fleet/fleet-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<host-provider,host.name>> key, in events produced by {agent}.

[cols="2*<a"]
|===
|
[id="ls-hostname"]
**Hostname**

| When this setting is selected, information about the current host is in a non-fully-qualified format (`somehost`, rather than `somehost.example.com`). This is the default reporting format.

// =============================================================================

|
[id="ls-hostname-fqdn"]
**Fully Qualified Domain Name (FQDN)**

| When this setting is selected, 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.

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.

|===
[[proxy-settings]]
== Proxies

You can specify a proxy server to be used in {fleet-server}, {agent} outputs, or for any agent binary download sources.
For full details about proxy configuration refer to <<fleet-agent-proxy-support,Using a proxy server with {agent} and {fleet}>>.

0 comments on commit 32c5f9c

Please sign in to comment.