Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add docs for agent unenrollment timeout setting #1259

Merged
merged 3 commits into from
Aug 20, 2024
Merged

Add docs for agent unenrollment timeout setting #1259

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6613208
Add docs for agent unenrollment timeout setting
kilfoyle Aug 15, 2024
c6fc453
Update docs/en/ingest-management/agent-policies.asciidoc
kilfoyle Aug 20, 2024
5b7249c
Update docs/en/ingest-management/agent-policies.asciidoc
kilfoyle Aug 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions docs/en/ingest-management/agent-policies.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,11 @@ The following table illustrates the {fleet} user actions available to different
|<<fleet-agent-hostname-format-settings>>
|{y}
|{n}

|<<fleet-agent-unenrollment-timeout>>
|{y}
|{n}

|===

See also the <<agent-policy-scale,recommended scaling options>> for an {agent} policy.
Expand Down Expand Up @@ -502,6 +507,29 @@ For FQDN reporting to work as expected, the hostname of the current host must ei

If neither pre-requisite is satisfied, `host.name` continues to report the hostname of the current host in a non-fully-qualified format.


[discrete]
[[fleet-agent-unenrollment-timeout]]
== Set an unenrollment timeout for inactive agents

You can configure a length of time after which any inactive {agent}s are automatically unenrolled and their API keys invalidated.
This setting is useful when you have agents running in an ephemeral environment, such as Docker or {k8s}, and you want to prevent inactive agents from consuming unused API keys.


To configure an unenrollment timeout for inactive agents:

. In {fleet}, click **Agent policies**.
Select the name of the policy you want to edit.

. Click the **Settings** tab and scroll to **Inactive agent unenrollment timeout**.

. Specify an unenrollment timeout period in seconds.

. Save your changes.

After you set an unenrollment timeout, any inactive agents are unenrolled automatically after the specified period of time.
The unenroll task runs every ten minutes, and it unenrolls a maximum of one thousand agents at a time.

[discrete]
[[agent-policy-scale]]
== Policy scaling recommendations
Expand Down