Skip to content

Commit 98d9db9

Browse files
authored
Add missing environment variables for container setup (elastic#1354)
* Add missing environment variables for container setup * Add more missing settings * fixup * fixup * fixup * fixup * Remove FLEET_HEADER & FLEET_KIBANA_HEADER
1 parent 4185605 commit 98d9db9

File tree

2 files changed

+130
-16
lines changed

2 files changed

+130
-16
lines changed

docs/en/ingest-management/elastic-agent/configuration/env/container-envs.asciidoc

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,6 @@ Settings used to prepare the {fleet} plugin in {kib}.
6868
|===
6969
| Settings | Description
7070

71-
include::shared-env.asciidoc[tag=kibana-fleet-setup]
72-
7371
include::shared-env.asciidoc[tag=kibana-fleet-host]
7472

7573
include::shared-env.asciidoc[tag=kibana-fleet-username]
@@ -100,6 +98,12 @@ include::shared-env.asciidoc[tag=fleet-server-elasticsearch-host]
10098

10199
include::shared-env.asciidoc[tag=fleet-server-elasticsearch-ca]
102100

101+
include::shared-env.asciidoc[tag=fleet-server-es-cert]
102+
103+
include::shared-env.asciidoc[tag=fleet-server-es-cert-key]
104+
105+
include::shared-env.asciidoc[tag=fleet-server-insecure-http]
106+
103107
include::shared-env.asciidoc[tag=fleet-server-service-token]
104108

105109
include::shared-env.asciidoc[tag=fleet-server-service-token-path]
@@ -118,8 +122,14 @@ include::shared-env.asciidoc[tag=fleet-server-cert-key]
118122

119123
include::shared-env.asciidoc[tag=fleet-server-cert-key-passphrase]
120124

125+
include::shared-env.asciidoc[tag=fleet-server-client-auth]
126+
121127
include::shared-env.asciidoc[tag=fleet-server-es-ca-trusted-fingerprint]
122128

129+
include::shared-env.asciidoc[tag=fleet-daemon-timeout]
130+
131+
include::shared-env.asciidoc[tag=fleet-server-timeout]
132+
123133
|===
124134

125135
[discrete]
@@ -135,10 +145,16 @@ Settings used to enroll an {agent} into a {fleet-server}.
135145
|===
136146
| Settings | Description
137147

148+
include::shared-env.asciidoc[tag=elastic-agent-cert]
149+
150+
include::shared-env.asciidoc[tag=elastic-agent-cert-key]
151+
138152
include::shared-env.asciidoc[tag=elastic-agent-tag]
139153

140154
include::shared-env.asciidoc[tag=fleet-enroll]
141155

156+
include::shared-env.asciidoc[tag=fleet-force]
157+
142158
include::shared-env.asciidoc[tag=fleet-url]
143159

144160
include::shared-env.asciidoc[tag=fleet-enrollment-token]

docs/en/ingest-management/elastic-agent/configuration/env/shared-env.asciidoc

Lines changed: 112 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -17,30 +17,37 @@ OPTIONAL INFO AND EXAMPLE
1717

1818
// =============================================================================
1919

20-
// tag::elastic-agent-tag[]
20+
// tag::elastic-agent-cert[]
2121
|
22-
[id="env-{type}-elastic-agent-tag"]
23-
`ELASTIC_AGENT_TAGS`
22+
[id="env-{type}-elastic-agent-cert"]
23+
`ELASTIC_AGENT_CERT`
2424

25-
| (string) A comma-separated list of tags to apply to {fleet}-managed {agent}s.
26-
You can use these tags to filter the list of agents in {fleet}.
25+
| (string) The path to the mutual TLS client certificate that {agent} will use to connect to {fleet-server}.
2726

28-
// end::elastic-agent-tag[]
27+
// end::elastic-agent-cert[]
2928

3029
// =============================================================================
3130

32-
// tag::kibana-fleet-setup[]
31+
// tag::elastic-agent-cert-key[]
3332
|
34-
[id="env-{type}-kibana-fleet-setup"]
35-
`KIBANA_FLEET_SETUP`
33+
[id="env-{type}-elastic-agent-cert-key"]
34+
`ELASTIC_AGENT_CERT_KEY`
3635

37-
| (int) Set to `1` to enable {fleet} setup.
38-
Enabling {fleet} is required before {fleet-server} will start.
39-
When this action is not performed, a user must manually log in to {kib} and visit the {fleet} page to enable setup.
36+
| (string) The path to the mutual TLS private key that {agent} will use to connect to {fleet-server}.
4037

41-
*Default:* none
38+
// end::elastic-agent-cert-key[]
39+
40+
// =============================================================================
4241

43-
// end::kibana-fleet-setup[]
42+
// tag::elastic-agent-tag[]
43+
|
44+
[id="env-{type}-elastic-agent-tag"]
45+
`ELASTIC_AGENT_TAGS`
46+
47+
| (string) A comma-separated list of tags to apply to {fleet}-managed {agent}s.
48+
You can use these tags to filter the list of agents in {fleet}.
49+
50+
// end::elastic-agent-tag[]
4451

4552
// =============================================================================
4653

@@ -105,6 +112,20 @@ contains your CA's certificate.
105112

106113
// =============================================================================
107114

115+
// tag::fleet-force[]
116+
|
117+
[id="env-{type}-fleet-force"]
118+
`FLEET_FORCE`
119+
120+
| (bool) Set to `true` to force overwrite of the current {agent} configuration without prompting for confirmation.
121+
This flag is helpful when using automation software or scripted deployments.
122+
123+
*Default:* `false`
124+
125+
// end::fleet-force[]
126+
127+
// =============================================================================
128+
108129
// tag::fleet-server-enable[]
109130
|
110131
[id="env-{type}-fleet-server-enable"]
@@ -273,6 +294,21 @@ Overrides the port defined in the policy.
273294

274295
// =============================================================================
275296

297+
// tag::fleet-server-client-auth[]
298+
|
299+
[id="env-{type}-fleet-server-client-auth"]
300+
`FLEET_SERVER_CLIENT_AUTH`
301+
302+
| (string) One of `none`, `optional`, or `required`.
303+
{fleet-server}'s client authentication option for client mTLS connections.
304+
If `optional` or `required` is specified, client certificates are verified using CAs.
305+
306+
*Default:* `none`
307+
308+
// end::fleet-server-client-auth[]
309+
310+
// =============================================================================
311+
276312
// tag::fleet-server-es-ca-trusted-fingerprint[]
277313
|
278314
[id="env-{type}-fleet-server-es-ca-trusted-fingerprint"]
@@ -288,6 +324,68 @@ by {agent} for communication. This flag is required when using self-signed certi
288324
289325
// =============================================================================
290326
327+
// tag::fleet-server-es-cert[]
328+
|
329+
[id="env-{type}-fleet-server-es-cert"]
330+
`FLEET_SERVER_ES_CERT`
331+
332+
| (string) The path to the mutual TLS client certificate that {fleet-server} will use to connect to {es}.
333+
334+
*Default:* `""`
335+
336+
// end::fleet-server-es-cert[]
337+
338+
// =============================================================================
339+
340+
// tag::fleet-server-es-cert-key[]
341+
|
342+
[id="env-{type}-fleet-server-es-cert-key"]
343+
`FLEET_SERVER_ES_CERT_KEY`
344+
345+
| (string) The path to the mutual TLS private key that {fleet-server} will use to connect to {es}.
346+
347+
*Default:* `""`
348+
349+
// end::fleet-server-es-cert-key[]
350+
351+
// =============================================================================
352+
353+
// tag::fleet-server-insecure-http[]
354+
|
355+
[id="env-{type}-fleet-server-insecure-http"]
356+
`FLEET_SERVER_INSECURE_HTTP`
357+
358+
| (bool) When `true`, {fleet-server} is exposed over insecure or unverified HTTP.
359+
Setting this to `true` is not recommended.
360+
361+
*Default:* `false`
362+
363+
// end::fleet-server-insecure-http[]
364+
365+
// =============================================================================
366+
367+
// tag::fleet-daemon-timeout[]
368+
|
369+
[id="env-{type}-fleet-daemon-timeout"]
370+
`FLEET_DAEMON_TIMEOUT`
371+
372+
| (duration) Set to indicate how long {fleet-server} will wait during the bootstrap process for {elastic-agent}.
373+
374+
// end::fleet-daemon-timeout[]
375+
376+
// =============================================================================
377+
378+
// tag::fleet-server-timeout[]
379+
|
380+
[id="env-{type}-fleet-server-timeout"]
381+
`FLEET_SERVER_TIMEOUT`
382+
383+
| (duration) Set to indicate how long {agent} will wait for {fleet-server} to check in as healthy.
384+
385+
// end::fleet-server-timeout[]
386+
387+
// =============================================================================
388+
291389
// tag::fleet-enroll[]
292390
|
293391
[id="env-{type}-fleet-enroll"]

0 commit comments

Comments
 (0)