Skip to content

Commit 41cd72b

Browse files
authored
Add docs for enrollment handling for containerized agents (#729)
This is a forward fit of elastic/ingest-docs#1728 into the 9.0 docs. See: [preview page](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/729/reference/ingestion-tools/fleet/enrollment-handling-containerized-agent)
1 parent b5c5658 commit 41cd72b

4 files changed

+24
-1
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Enrollment handing for containerized agents
2+
3+
For {{fleet}}-managed {{agents}} that run in a containerized environment (including Docker, Kubernetes, and others), enrollment handling is managed as follows:
4+
5+
* **Enrollment Verification:** {{agent}} checks the stored enrollment conditions within its container environment and re-enrolls only when necessary.
6+
* **Unenrollment Handling:** If an {{agent}} is unenrolled via the {{fleet}} UI but still references a valid enrollment token provided through environment variables, it will automatically re-enroll on the next container restart.
7+
8+
In versions lower than 8.18, an unenrolled agent remains unenrolled and does not re-enroll, even if a valid enrollment token is still available.
9+
10+
11+
12+
13+
14+
15+

reference/ingestion-tools/fleet/install-elastic-agents-in-containers.md

+4
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,10 @@ To learn how to run {{agent}}s in a containerized environment, see:
2323
* [Using a custom ingest pipeline with the {{k8s}} Integration](/reference/ingestion-tools/fleet/ingest-pipeline-kubernetes.md)
2424
* [Run {{agent}} on ECK](/deploy-manage/deploy/cloud-on-k8s/standalone-elastic-agent.md) — for {{eck}} users
2525

26+
::::{note}
27+
Enrollment handling for {{agent}} in a containerized environment has some special nuances.
28+
For details refer to [Enrollment handing for containerized agents](./enrollment-handling-containerized-agent.md).
29+
::::
2630

2731

2832

reference/ingestion-tools/fleet/unenroll-elastic-agent.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,7 @@ Unenrolled agents will continue to run, but will not be able to send data. They
2020
If unenrollment hangs, select **Force unenroll** to invalidate all API keys related to the agent and change the status to `inactive` so that the agent no longer appears in {{fleet}}.
2121
::::
2222

23-
23+
::::{note}
24+
Enrollment handling for {{agent}} in a containerized environment has some special nuances.
25+
For details refer to [Enrollment handing for containerized agents](./enrollment-handling-containerized-agent.md).
26+
::::

reference/toc.yml

+1
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,7 @@ toc:
104104
- file: ingestion-tools/fleet/monitor-elastic-agent.md
105105
- file: ingestion-tools/fleet/agent-health-status.md
106106
- file: ingestion-tools/fleet/filter-agent-list-by-tags.md
107+
- file: ingestion-tools/fleet/enrollment-handling-containerized-agent.md
107108
- file: ingestion-tools/fleet/agent-policy.md
108109
children:
109110
- file: ingestion-tools/fleet/create-policy-no-ui.md

0 commit comments

Comments
 (0)