Document Agent/Fleet Server environment variables (elastic#671)

Co-authored-by: DeDe Morton <[email protected]>
Co-authored-by: Chris Mark <[email protected]>

elastic-agent/configuration/env/container-envs.asciidoc

@@ -0,0 +1,155 @@
+[[agent-environment-variables]]
+= {agent} environment variables
+
+++++
+<titleabbrev>Environment variables</titleabbrev>
+++++
+
+Use environment variables to configure {agent} when running in a containerized environment.
+Variables on this page are grouped by action type:
+
+* <<env-common-vars,Common variables>>
+* <<env-prepare-kibana-for-fleet,Configure {kib}:>> prepare the {fleet} plugin in {kib}
+* <<env-bootstrap-fleet-server,Configure {fleet-server}:>> bootstrap {fleet-server} on an {agent}
+* <<env-enroll-agent,Configure {agent} and {fleet}:>> enroll an {agent}
+
+[discrete]
+[[env-common-vars]]
+== Common variables
+
+// forces a unique ID so that settings can be included multiple times on the same page
+:type: common
+
+To limit the number of environment variables that need to be set,
+the following common variables are available.
+These variables can be used across all {agent} actions,
+but have a lower precedence than action-specific environment variables.
+
+These common variables are useful, for example, when using the same {es} and {kib} credentials
+to prepare the {fleet} plugin in {kib}, configure {fleet-server}, and enroll an {agent}.
+
+[cols="2*<a"]
+|===
+| Settings | Description
+
+include::shared-env.asciidoc[tag=elasticsearch-host]
+
+include::shared-env.asciidoc[tag=elasticsearch-username]
+
+include::shared-env.asciidoc[tag=elasticsearch-password]
+
+include::shared-env.asciidoc[tag=elasticsearch-ca]
+
+include::shared-env.asciidoc[tag=kibana-host]
+
+include::shared-env.asciidoc[tag=kibana-username]
+
+include::shared-env.asciidoc[tag=kibana-password]
+
+include::shared-env.asciidoc[tag=kibana-ca]
+
+|===
+
+[discrete]
+[[env-prepare-kibana-for-fleet]]
+== Prepare {kib} for {fleet}
+
+// forces a unique ID so that settings can be included multiple times on the same page
+:type: fleet-kib
+
+Settings used to prepare the {fleet} plugin in {kib}.
+
+[cols="2*<a"]
+|===
+| Settings | Description
+
+include::shared-env.asciidoc[tag=kibana-fleet-setup]
+
+include::shared-env.asciidoc[tag=kibana-fleet-host]
+
+include::shared-env.asciidoc[tag=kibana-fleet-username]
+
+include::shared-env.asciidoc[tag=kibana-fleet-password]
+
+include::shared-env.asciidoc[tag=kibana-fleet-ca]
+
+|===
+
+[discrete]
+[[env-bootstrap-fleet-server]]
+== Bootstrap {fleet-server}
+
+// forces a unique ID so that settings can be included multiple times on the same page
+:type: bootstrap-fleet
+
+Settings used to bootstrap {fleet-server} on this {agent}.
+At least one {fleet-server} is required in a deployment.
+
+[cols="2*<a"]
+|===
+| Settings | Description
+
+include::shared-env.asciidoc[tag=fleet-server-enable]
+
+include::shared-env.asciidoc[tag=fleet-server-elasticsearch-host]
+
+include::shared-env.asciidoc[tag=fleet-server-elasticsearch-username]
+
+include::shared-env.asciidoc[tag=fleet-server-elasticsearch-password]
+
+include::shared-env.asciidoc[tag=fleet-server-elasticsearch-ca]
+
+include::shared-env.asciidoc[tag=fleet-server-service-token]
+
+include::shared-env.asciidoc[tag=fleet-server-policy-name]
+
+include::shared-env.asciidoc[tag=fleet-server-policy-id]
+
+include::shared-env.asciidoc[tag=fleet-server-host]
+
+include::shared-env.asciidoc[tag=fleet-server-port]
+
+include::shared-env.asciidoc[tag=fleet-server-cert]
+
+include::shared-env.asciidoc[tag=fleet-server-cert-key]
+
+include::shared-env.asciidoc[tag=fleet-server-insecure-http]
+
+|===
+
+[discrete]
+[[env-enroll-agent]]
+== Enroll {agent}
+
+// forces a unique ID so that settings can be included multiple times on the same page
+:type: enroll
+
+Settings used to enroll an {agent} into a {fleet-server}.
+
+[cols="2*<a"]
+|===
+| Settings | Description
+
+include::shared-env.asciidoc[tag=fleet-enroll]
+
+include::shared-env.asciidoc[tag=fleet-url]
+
+include::shared-env.asciidoc[tag=fleet-enrollment-token]
+
+include::shared-env.asciidoc[tag=fleet-token-name]
+
+include::shared-env.asciidoc[tag=fleet-token-policy-name]
+
+include::shared-env.asciidoc[tag=fleet-ca]
+
+include::shared-env.asciidoc[tag=fleet-insecure]
+
+include::shared-env.asciidoc[tag=kibana-fleet-host]
+
+include::shared-env.asciidoc[tag=kibana-fleet-username]
+
+include::shared-env.asciidoc[tag=kibana-fleet-password]
+
+include::shared-env.asciidoc[tag=kibana-fleet-ca]
+
+|===