Skip to content

Commit faf0e58

Browse files
authored
Small fixes for API keys docs (#909)
1 parent c29d352 commit faf0e58

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

docs/en/ingest-management/elastic-agent/grant-access-to-elasticsearch.asciidoc

+8-5
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,13 @@ cluster privilege can create API keys.
3232
For security reasons, we recommend using a unique API key per {agent}. You
3333
can create as many API keys per user as necessary.
3434

35+
If you are using link:{serverless-docs}[{serverless-full}], API key authentication is required.
36+
3537
To create an API key for {agent}:
3638

37-
. In {kib}, navigate to *{stack-manage-app} > API keys* and click
38-
*Create API key*.
39+
. In an {ecloud} or premises environment, in {kib} navigate to *{stack-manage-app} > API keys* and click *Create API key*.
40+
+
41+
In a {serverless-short} environment, in {kib} navigate to *Project settings* > *Management* > *API keys* and click *Create API key*.
3942

4043
. Enter a name for your API key and select *Restrict privileges*. In the role
4144
descriptors box, copy and paste the following JSON. This example creates an
@@ -97,7 +100,7 @@ outputs:
97100
api_key: _Nj4oH0aWZVGqM7MGop8:349p_U1ERHyIc4Nm8_AYkw <1>
98101
[...]
99102
----
100-
<1> The format of this key is `<id>.<key>`. Base64 encoded API keys are not
103+
<1> The format of this key is `<id>:<key>`. Base64 encoded API keys are not
101104
currently supported in this configuration.
102105

103106
For more information about creating API keys in {kib}, see
@@ -108,11 +111,11 @@ For more information about creating API keys in {kib}, see
108111
== Create a standalone agent role
109112

110113
Although it's recommended that you use an API key instead of a username and
111-
password to access {es}, you can create a role with the required privileges,
114+
password to access {es} (and an API key is required in a {serverless} environment), you can create a role with the required privileges,
112115
assign it to a user, and specify the user's credentials in the
113116
`elastic-agent.yml` file.
114117

115-
. In {kib}, go to *{stack-manage-app} > Roles*.
118+
. In {kib}, for a go to *{stack-manage-app} > Roles*.
116119

117120
. Click *Create role* and enter a name for the role.
118121

0 commit comments

Comments
 (0)