Skip to content

Commit fff59ad

Browse files
committed
Add page for enrollment handling in containerized environments
1 parent b0519e0 commit fff59ad

4 files changed

+21
-0
lines changed

docs/en/ingest-management/elastic-agent/install-elastic-agent-in-container.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,5 @@ To learn how to run {agent}s in a containerized environment, see:
3030

3131
* {eck-ref}/k8s-elastic-agent.html[Run {agent} on ECK] -- for {eck} users
3232

33+
NOTE: Enrollment handling for {agent} in a containerized environment has some special nuances.
34+
For details refer to <<containers-agent-enrollment-handling>>.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
[[containers-agent-enrollment-handling]]
2+
= Enrollment handing for containerized {fleet}-managed agents
3+
++++
4+
<titleabbrev>Enrollment handing for containerized agents</titleabbrev>
5+
++++
6+
7+
Beginning with version 8.18, for {fleet}-managed {agents} that run in a containerized environment (including Docker, Kubernetes, and others), enrollment handling is managed as follows:
8+
9+
* **Enrollment Verification:** The agent checks stored enrollment conditions stored in the container environment and re-enrolls only when necessary.
10+
* **Unenrollment Handling:** If an {agent} is unenrolled through the {fleet} UI but still has a valid enrollment token provided via environment variables, the next container restart will cause it to re-enroll automatically.
11+
12+
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.

docs/en/ingest-management/fleet/unenroll-elastic-agent.asciidoc

+5
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
= Unenroll {agent}s
33

44
You can unenroll {agent}s to invalidate the API key used to connect to {es}.
5+
For {agents} installed in a containerized environment, see <<containers-agent-enrollment-handling>>
6+
for details about how enrollment handling is managed.
57

68
. In {fleet}, select *Agents*.
79

@@ -21,3 +23,6 @@ will show this error instead: `invalid api key to authenticate with fleet`.
2123
TIP: If unenrollment hangs, select *Force unenroll* to invalidate all API
2224
keys related to the agent and change the status to `inactive` so that the agent
2325
no longer appears in {fleet}.
26+
27+
NOTE: Enrollment handling for {agent} in a containerized environment has some special nuances.
28+
For details refer to <<containers-agent-enrollment-handling>>.

docs/en/ingest-management/index.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,8 @@ include::fleet/agent-health-status.asciidoc[leveloffset=+3]
143143

144144
include::fleet/filter-agent-list-by-tags.asciidoc[leveloffset=+3]
145145

146+
include::fleet/enrollment-handling-containerized-agent.asciidoc[leveloffset=+3]
147+
146148
include::agent-policies.asciidoc[leveloffset=+2]
147149

148150
include::create-agent-policies-no-UI.asciidoc[leveloffset=+3]

0 commit comments

Comments
 (0)