Skip to content

Latest commit

 

History

History
147 lines (107 loc) · 5.58 KB

fleet-settings.asciidoc

File metadata and controls

147 lines (107 loc) · 5.58 KB

{fleet} settings

Note
 The settings described here are configurable through the {fleet} UI. Refer to {kibana-ref}/fleet-settings-kb.html[{fleet} settings in {kib}] for a list of settings that you can configure in the kibana.yml configuration file.

On the Settings tab in Fleet, you can configure global settings available to all {agent}s enrolled in {fleet}. This includes {fleet-server} hosts and output settings.

{fleet-server} host settings

Click Edit hosts and specify the host URLs your {agent}s will use to connect to a {fleet-server}.

Tip
 If the Edit hosts option is grayed out, {fleet-server} hosts are configured outside of {fleet}. For more information, refer to {kibana-ref}/fleet-settings-kb.html[{fleet} settings in {kib}].

Not sure if {fleet-server} is running? Refer to [fleet-server].

On self-managed clusters, you must specify one or more URLs.

On {ecloud}, this field is populated automatically. If you are using Azure Private Link, GCP Private Service Connect, or AWS PrivateLink and enrolling the {agent} with a private link URL, ensure that this setting is configured. Otherwise, {agent} will reset to use a default address instead of the private link URL.

Note
 If a URL is specified without a port, {kib} sets the port to 80 (http) or 443 (https).

By default, {fleet-server} is typically exposed on the following ports:

8220

Default {fleet-server} port for self-managed clusters

443 or 9243

Default {fleet-server} port for {ecloud}. View the {fleet} Settings tab to find the actual port that’s used.

Important
 The exposed ports must be open for ingress and egress in the firewall and networking rules on the host to allow {agent}s to communicate with {fleet-server}.

Specify multiple URLs (click Add row) to scale out your deployment and provide automatic failover. If multiple URLs exist, {fleet} shows the first provided URL for enrollment purposes. Enrolled {agent}s will connect to the URLs in round robin order until they connect successfully.

When a {fleet-server} is added or removed from the list, all agent policies are updated automatically.

Examples:

Output settings

Add or edit output settings to specify where {agent}s send data. {agent}s use the default output if you don’t select an output in the agent policy.

Tip
 If you have an Enterprise {stack} subscription, you can configure {agent} to send data to different outputs for different integration policies.
Note
 The {ecloud} internal output is locked and cannot be edited. This output is used for internal routing to reduce external network charges when using the {ecloud} agent policy. It also provides visibility for troubleshooting on {ece}.

To add or edit an output:

  1. Go to {fleet} → Settings.

  2. Under Outputs, click Add output or Edit.

    {fleet} Add output button

    The Add new output UI opens.

  3. Set the output name and type.

  4. Specify settings for the output type you selected:

  5. Click Save and apply settings.

Tip
 If the options for editing an output are grayed out, outputs are configured outside of {fleet}. For more information, refer to {kibana-ref}/fleet-settings-kb.html[{fleet} settings in {kib}].

Agent binary download settings

{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 add or edit the source of binary downloads:

  1. Go to {fleet} → Settings.

  2. Under Agent Binary Download, click Add agent binary source or Edit.

  3. Set the agent binary source name.

  4. For Host, specify the address where you are hosting the artifacts repository.

  5. (Optional) To make this location the default, select Make this host the default for all agent policies. {agent}s use the default location if you don’t select a different agent binary source in the agent policy.

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 Using a proxy server with {agent} and {fleet}.

Delete unenrolled agents

After an {agent} has been unenrolled in {fleet}, a number of documents about the agent are retained just in case the agent needs to be recovered at some point. You can choose to have all data related to an unenrolled agent deleted automatically.

Note that this option can also be enabled by adding the xpack.fleet.enableDeleteUnenrolledAgents: true setting to the {kibana-ref}/[{kib} settings file].

To enable automatic deletion of unenrolled agents:

  1. Go to {fleet} → Settings.

  2. Under Advanced Settings, enable the Delete unenrolled agents option.