Skip to content

Commit c28e1a3

Browse files
michel-latermankilfoylekarenzone
authored
Add fleet-server secret file docs (#148)
* Add fleet-server secret file docs * change file suffix to path where applicable, add example * Add k8s secrets guide and env var descriptions * add instructions for ram disks * use k8s agent provider only for apm * windows file permissions acls * change heading name * Add index ref * David's edits * Apply suggestions from code review Co-authored-by: Karen Metts <35154725+karenzone@users.noreply.github.com> * Clarify ram disk description * Update docs/en/ingest-management/fleet/fleet-server-secrets.asciidoc Co-authored-by: Karen Metts <35154725+karenzone@users.noreply.github.com> --------- Co-authored-by: David Kilfoyle <david.kilfoyle@elastic.co> Co-authored-by: Karen Metts <35154725+karenzone@users.noreply.github.com>
1 parent d8bd68e commit c28e1a3

10 files changed

+330
-6
lines changed

.gitignore

+3-1
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,6 @@ html_docs
1212

1313
# IDE configuration files
1414
.vscode/
15-
.idea/
15+
.idea/
16+
17+
*.swp

docs/en/ingest-management/commands.asciidoc

+16-4
Original file line numberDiff line numberDiff line change
@@ -149,11 +149,13 @@ To enroll the {agent} in {fleet} and set up {fleet-server}:
149149
----
150150
elastic-agent enroll --fleet-server-es <string>
151151
--fleet-server-service-token <string>
152+
[--fleet-server-service-token-path <string>]
152153
[--ca-sha256 <string>]
153154
[--certificate-authorities <string>]
154155
[--delay-enroll]
155156
[--fleet-server-cert <string>] <1>
156157
[--fleet-server-cert-key <string>]
158+
[--fleet-server-cert-key-passphrase <string>]
157159
[--fleet-server-es-ca <string>]
158160
[--fleet-server-es-ca-trusted-fingerprint <string>] <2>
159161
[--fleet-server-es-insecure]
@@ -164,7 +166,7 @@ elastic-agent enroll --fleet-server-es <string>
164166
[--force]
165167
[--non-interactive]
166168
[--help]
167-
[--tag <string>]
169+
[--tag <string>]
168170
[--url <string>] <3>
169171
[global-flags]
170172
----
@@ -207,6 +209,9 @@ Certificate to use for exposed {fleet-server} HTTPS endpoint.
207209
`--fleet-server-cert-key <string>`::
208210
Private key to use for exposed {fleet-server} HTTPS endpoint.
209211

212+
`--fleet-server-cert-key-passphrase <string>`::
213+
Path to passphrase file for decrypting {fleet-server}'s private key if an encrypted private key is used.
214+
210215
`--fleet-server-es <string>`::
211216
Start a {fleet-server} process when {agent} is started, and connect to the
212217
specified {es} URL.
@@ -247,6 +252,11 @@ Used when starting a self-managed {fleet-server} to allow a specific policy to b
247252

248253
`--fleet-server-service-token <string>`::
249254
Service token to use for communication with {es}.
255+
Mutually exclusive with `--fleet-server-service-token-path`.
256+
257+
`--fleet-server-service-token-path <string>`::
258+
Service token file to use for communication with {es}.
259+
Mutually exclusive with `--fleet-server-service-token`.
250260

251261
`--force`::
252262
Force overwrite of current configuration without prompting for confirmation.
@@ -256,7 +266,7 @@ NOTE: If the {agent} is already installed on the host, using `--force` may
256266
result in unpredictable behavior with duplicate {agent}s appearing in {fleet}.
257267

258268
`--non-interactive`::
259-
Install {agent} in a non-interactive mode. This flag is helpful when
269+
Install {agent} in a non-interactive mode. This flag is helpful when
260270
using automation software or scripted deployments. If {agent} is
261271
already installed on the host, the installation will terminate.
262272

@@ -473,7 +483,7 @@ elastic-agent install --url <string>
473483
[--non-interactive]
474484
[--help]
475485
[--insecure ]
476-
[--tag <string>]
486+
[--tag <string>]
477487
[global-flags]
478488
----
479489

@@ -485,11 +495,13 @@ a `fleet-server` process alongside the `elastic-agent` service:
485495
486496
elastic-agent install --fleet-server-es <string>
487497
--fleet-server-service-token <string>
498+
[--fleet-server-service-token-path <string>]
488499
[--ca-sha256 <string>]
489500
[--certificate-authorities <string>]
490501
[--delay-enroll]
491502
[--fleet-server-cert <string>] <1>
492503
[--fleet-server-cert-key <string>]
504+
[--fleet-server-cert-key-passphrase <string>]
493505
[--fleet-server-es-ca <string>]
494506
[--fleet-server-es-ca-trusted-fingerprint <string>] <2>
495507
[--fleet-server-host <string>]
@@ -499,7 +511,7 @@ elastic-agent install --fleet-server-es <string>
499511
[--force]
500512
[--non-interactive]
501513
[--help]
502-
[--tag <string>]
514+
[--tag <string>]
503515
[--url <string>] <3>
504516
[--fleet-server-es-insecure]
505517
[global-flags]

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

+4
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,8 @@ include::shared-env.asciidoc[tag=fleet-server-elasticsearch-ca]
9797

9898
include::shared-env.asciidoc[tag=fleet-server-service-token]
9999

100+
include::shared-env.asciidoc[tag=fleet-server-service-token-path]
101+
100102
include::shared-env.asciidoc[tag=fleet-server-policy-name]
101103

102104
include::shared-env.asciidoc[tag=fleet-server-policy-id]
@@ -109,6 +111,8 @@ include::shared-env.asciidoc[tag=fleet-server-cert]
109111

110112
include::shared-env.asciidoc[tag=fleet-server-cert-key]
111113

114+
include::shared-env.asciidoc[tag=fleet-server-cert-key-passphrase]
115+
112116
include::shared-env.asciidoc[tag=fleet-server-insecure-http]
113117

114118
|===

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

+26
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,19 @@ Overrides `FLEET_TOKEN_POLICY_NAME` when set.
180180

181181
// =============================================================================
182182

183+
// tag::fleet-server-service-token-path[]
184+
|
185+
[id="env-{type}-fleet-server-service-token-path"]
186+
`FLEET_SERVER_SERVICE_TOKEN_PATH`
187+
188+
| (string) The path to the service token file to use for communication with {es}.
189+
190+
*Default:* none
191+
192+
// end::fleet-server-service-token-path[]
193+
194+
// =============================================================================
195+
183196
// tag::fleet-server-policy-id[]
184197
|
185198
[id="env-{type}-fleet-server-policy-id"]
@@ -245,6 +258,19 @@ Overrides the port defined in the policy.
245258

246259
// =============================================================================
247260

261+
// tag::fleet-server-cert-key-passphrase[]
262+
|
263+
[id="env-{type}-fleet-server-cert-key-passphrase"]
264+
`FLEET_SERVER_CERT_KEY_PASSPHRASE`
265+
266+
| (string) The path to the private key passphrase for an encrypted private key file.
267+
268+
*Default:* none
269+
270+
// end::fleet-server-cert-key-passphrase[]
271+
272+
// =============================================================================
273+
248274
// tag::fleet-server-insecure-http[]
249275
|
250276
[id="env-{type}-fleet-server-insecure-http"]

0 commit comments

Comments
 (0)