Skip to content

Commit bf9714f

Browse files
committed
Enrollment tokens: add details about outputs other than ES
1 parent 62d4ce5 commit bf9714f

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

reference/fleet/fleet-enrollment-tokens.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,27 @@ products:
88

99
# Fleet enrollment tokens [fleet-enrollment-tokens]
1010

11-
A {{fleet}} enrollment token (referred to as an `enrollment API key` in the {{fleet}} API documentation) is an {{es}} API key that you use to enroll one or more {{agent}}s in {{fleet}}. The enrollment token enrolls the {{agent}} in a specific agent policy that defines the data to be collected by the agent. You can use the token as many times as required. It will remain valid until you revoke it.
11+
A {{fleet}} enrollment token (referred to as an `enrollment API key` in the {{fleet}} API documentation) is an {{es}} API key that you use to enroll one or more {{agent}}s in {{fleet}}. The enrollment token enrolls the {{agent}} in a specific agent policy that defines the data to be collected by the agent and the output to use. You can use the token as many times as needed. It will remain valid until you revoke it.
1212

13-
The enrollment token is used for the initial communication between {{agent}} and {{fleet-server}}. After the initial connection request from the {{agent}}, the {{fleet-server}} passes two API keys to the {{agent}}:
14-
15-
* An output API key
13+
The enrollment token is used for the initial communication between {{agent}} and {{fleet-server}}. After the initial connection request from the {{agent}}, the {{fleet-server}} passes a communication API key to the {{agent}}. This API key includes only the necessary permissions to communicate with the {{fleet-server}}. If the API key is invalid, {{fleet-server}} stops communicating with the {{agent}}.
1614

15+
Depending on the output of the agent policy with which the enrollment token is associated, the {{fleet-server}} also passes additional data to the {{agent}}:
16+
17+
* For the {{es}} and remote {{es}} outputs, it passes an output API key.
18+
1719
This API key is used to send data to {{es}}. It has the minimal permissions needed to ingest all the data specified by the agent policy. If the API key is invalid, the {{agent}} stops ingesting data into {{es}}.
1820

19-
* A communication API key
21+
* For the Kafka output, it passes authentication parameters.
22+
23+
The authentication parameters are defined in the authentication settings of the Kafka output and are used by the {{agent}} to connect to Kafka.
2024

21-
This API key is used to communicate with the {{fleet-server}}. It has only the permissions needed to communicate with the {{fleet-server}}. If the API key is invalid, {{fleet-server}} stops communicating with the {{agent}}.
25+
* For the {{ls}} output, it passes SSL/TLS configuration details.
2226

27+
The SSL/TLS configuration details such as the SSL certificate authority, the SSL certificate, and the SSL certificate key are defined during the Logstash output creation and are used by the {{agent}} to connect to Logstash.
2328

29+
:::{note}
30+
Although an API key is generated during the {{ls}} output creation, this key is not passed to the {{agent}} by the {{fleet-server}}.
31+
:::
2432

2533
## Create enrollment tokens [create-fleet-enrollment-tokens]
2634

0 commit comments

Comments
 (0)