You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
NOTE: If you're working in an air-gapped environment and have a subscription level that includes Support coverage, link:https://www.elastic.co/contact[contact us] if you'd like to request an offline version of the Elastic documentation.
41
+
40
42
[discrete]
41
43
[[air-gapped-self-managed-linux]]
42
44
=== 1. Self-Managed Install (Linux)
43
45
44
-
Refer to the section for each Elastic compopnent for air-gapped installation configuration and dependencies in a self-managed Linux environment.
46
+
Refer to the section for each Elastic component for air-gapped installation configuration and dependencies in a self-managed Linux environment.
45
47
46
48
[discrete]
47
49
[[air-gapped-elasticsearch]]
@@ -55,14 +57,13 @@ Air-gapped install of {es} is fairly straightforward, as this component does not
55
57
56
58
Air-gapped install of {kib} may require a number of additional services in the local network in order to access some of the features. General install and configuration guides are available in the {kibana-ref}/install.html[{kib} install documentation].
57
59
58
-
Specifically (see appropriate sections in the rest of the doc):
60
+
Specifically:
59
61
60
62
* To be able to use {kib} mapping visualizations, you need to set up and configure the <<air-gapped-elastic-maps-service,Elastic Maps Service>>.
61
63
* To be able to use {kib} sample data, install or update hundreds of prebuilt alert rules, and explore available data integrations, you need to set up and configure the <<air-gapped-elastic-package-registry,{package-registry}>>.
62
-
To provide detection rule updates for {endpoint-sec} agents, you need to set up and configure the <<air-gapped-elastic-endpoint-artifact-repository,Elastic Endpoint Artifact Repository>>.
63
-
To access {ents} capabilities (in addition to the general search capabilities of {es}), you need to set up and configure <<air-gapped-enterprise-search,{ents}>>.
64
-
To access the APM integration, you need to set up and configure <<air-gapped-elastic-apm,Elastic APM>>.
65
-
64
+
* To provide detection rule updates for {endpoint-sec} agents, you need to set up and configure the <<air-gapped-elastic-endpoint-artifact-repository,Elastic Endpoint Artifact Repository>>.
65
+
* To access {ents} capabilities (in addition to the general search capabilities of {es}), you need to set up and configure <<air-gapped-enterprise-search,{ents}>>.
66
+
* To access the APM integration, you need to set up and configure <<air-gapped-elastic-apm,Elastic APM>>.
66
67
67
68
[discrete]
68
69
[[air-gapped-beats]]
@@ -80,9 +81,9 @@ Elastic {beats} are light-weight data shippers. They do not require any unique s
80
81
[[air-gapped-elastic-agent]]
81
82
==== 1.5. {agent}
82
83
83
-
Air-gapped install of {agent} depends on the <<air-gapped-elastic-package-registry,{package-registry}>> and the <<air-gapped-elastic-artifact-registry,Elastic Artifact Registry>> for most use-cases. The agent itself is fairly lightweight and installs dependencies only as required by its configuration. In terms of connections to these dependencies, {agents} need to be able to connect to the Elastic Artifact Registry directly, but {package-registry} connections are handled through <<air-gapped-kibana,{kib}>>.
84
+
Air-gapped install of {agent} depends on the <<air-gapped-elastic-package-registry,{package-registry}>> and the <<air-gapped-elastic-artifact-registry,{artifact-registry}>> for most use-cases. The agent itself is fairly lightweight and installs dependencies only as required by its configuration. In terms of connections to these dependencies, {agents} need to be able to connect to the {artifact-registry} directly, but {package-registry} connections are handled through <<air-gapped-kibana,{kib}>>.
84
85
85
-
Additionally, if the {agent} {elastic-defend} integration is used, then <<air-gapped-elastic-endpoint-artifact-repository,Elastic Endpoint Artifact Repository>> is necessary in order to deploy updates for some of the detection and prevention capabilities.
86
+
Additionally, if the {agent} {elastic-defend} integration is used, then access to the <<air-gapped-elastic-endpoint-artifact-repository,Elastic Endpoint Artifact Repository>> is necessary in order to deploy updates for some of the detection and prevention capabilities.
86
87
87
88
To learn more about install and configuration, refer to the {fleet-guide}/elastic-agent-installation.html[{agent} install documentation].
88
89
@@ -93,7 +94,7 @@ To get a better understanding of how to work with {agent} configuration settings
93
94
[[air-gapped-fleet]]
94
95
==== 1.6. {fleet-server}
95
96
96
-
{fleet-server} is a required middleware component for any scalable deployment of the {agent}. Air-gapped dependencies of {fleet-server} are the same as those of the <<air-gapped-elastic-agent,{agent}>>.
97
+
{fleet-server} is a required middleware component for any scalable deployment of the {agent}. The air-gapped dependencies of {fleet-server} are the same as those of the <<air-gapped-elastic-agent,{agent}>>.
97
98
98
99
To learn more about installing {fleet-server}, refer to the {fleet-guide}/fleet-server.html[{fleet-server} set up documentation].
99
100
@@ -104,7 +105,7 @@ To learn more about installing {fleet-server}, refer to the {fleet-guide}/fleet-
104
105
Air-gapped setup of the APM server is possible in two ways:
105
106
106
107
* By setting up one of the {agent} deployments with an APM integration, as described in {apm-guide-ref}/apm-integration-upgrade-steps.html[Switch a self-installation to the APM integration].
107
-
* Or, by installing a standalone Elastic APM Server, as described in the APM {apm-guide-ref}/configuring-howto-apm-server.html[configuration documentation].
108
+
* Or, by installing a standalone Elastic APM Server, as described in the {apm-guide-ref}/configuring-howto-apm-server.html[APM configuration documentation].
108
109
109
110
[discrete]
110
111
[[air-gapped-elastic-maps-service]]
@@ -122,27 +123,27 @@ Detailed install and configuration instructions are available in the {enterprise
122
123
[[air-gapped-elastic-package-registry]]
123
124
==== 1.10. {package-registry}
124
125
125
-
Air-gapped install of the EPR is possible using any OCI-compatible runtime like Podman (a typical choice for RHEL-like Linux systems) or Docker. Links to the official container image and usage guide is available on the {fleet-ref}/air-gapped.html[Air-gapped environments] page in the {fleet} and {agent} Guide.
126
+
Air-gapped install of the EPR is possible using any OCI-compatible runtime like Podman (a typical choice for RHEL-like Linux systems) or Docker. Links to the official container image and usage guide is available on the {fleet-guide}/air-gapped.html[Air-gapped environments] page in the {fleet} and {agent} Guide.
126
127
127
128
Refer to <<air-gapped-elastic-package-registry-example>> for additional setup examples.
128
129
129
130
NOTE: Besides setting up the EPR service, you also need to <<air-gapped-kibana,configure {kib}>> to use this service. If using TLS with the EPR service, it is also necessary to set up {kib} to trust the certificate presented by the EPR.
130
131
131
132
[discrete]
132
133
[[air-gapped-elastic-artifact-registry]]
133
-
==== 1.11. Elastic Artifact Registry
134
+
==== 1.11. {artifact-registry}
134
135
135
-
Air-gapped install of the Elastic artifactregistry is necessary in order to enable {agent} deployments to perform self-upgrades and install certain components which are needed for some of the data integrations (that is, in addition to what is also retrieved from the EPR). To learn how to set up such a repository, refer to {fleet-guide}/air-gapped.html#host-artifact-registry[Host your own artifact registry for binary downloads] in the {fleet} and {elastic-agent} Guide.
136
+
Air-gapped install of the {artifact-registry} is necessary in order to enable {agent} deployments to perform self-upgrades and install certain components which are needed for some of the data integrations (that is, in addition to what is also retrieved from the EPR). To learn more, refer to {fleet-guide}/air-gapped.html#host-artifact-registry[Host your own artifact registry for binary downloads] in the {fleet} and {elastic-agent} Guide.
136
137
137
138
Refer to <<air-gapped-elastic-artifact-registry-example>> for additional setup examples.
138
139
139
-
NOTE: When setting up own web server, such as NGINX, to function as the Elastic Artifact Registry, it is recommended not to use TLS as there are, currently, no direct ways to establish certificate trust between {agents} and this service.
140
+
NOTE: When setting up own web server, such as NGINX, to function as the {artifact-registry}, it is recommended not to use TLS as there are, currently, no direct ways to establish certificate trust between {agents} and this service.
Air-gapped setup of this component is, essentially, identical to the setup of the <<air-gapped-elastic-artifact-registry,Elastic Artifact Registry>> except that different artifacts are served. To learn more, refer to {security-guide}/offline-endpoint.html[Configure offline endpoints and air-gapped environments] in the Elastic Security guide.
146
+
Air-gapped setup of this component is, essentially, identical to the setup of the <<air-gapped-elastic-artifact-registry,{artifact-registry}>> except that different artifacts are served. To learn more, refer to {security-guide}/offline-endpoint.html[Configure offline endpoints and air-gapped environments] in the Elastic Security guide.
146
147
147
148
[discrete]
148
149
[[air-gapped-kubernetes-and-openshift]]
@@ -161,7 +162,7 @@ The main requirements are:
161
162
* Syncing container images for ECK and all other {stack} components over to a locally-accessible container repository.
162
163
* Modifying the ECK helm chart configuration so that ECK is aware that it is supposed to use your offline container repository instead of the public Elastic repository.
163
164
* Optionally, disabling ECK telemetry collection in the ECK helm chart. This configuration propagates to all other Elastic components, such as {kib}.
164
-
* Building your custom deployment container image for the Elastic Artifact Registry.
165
+
* Building your custom deployment container image for the {artifact-registry}.
165
166
* Building your custom deployment container image for the Elastic Endpoint Artifact Repository.
166
167
167
168
[discrete]
@@ -174,15 +175,15 @@ This container would, ideally, run as a Kubernetes deployment. Refer to <<air-ga
174
175
175
176
[discrete]
176
177
[[air-gapped-k8s-os-elastic-artifact-registry]]
177
-
==== 2.3. Elastic Artifact Registry
178
+
==== 2.3. {artifact-registry}
178
179
179
180
A custom container would need to be created following similar instructions to setting up a web server in the <<air-gapped-elastic-artifact-registry,self-managed install case>>. For example, a container file using an NGINX base image could be used to run a build similar to the example described in <<air-gapped-elastic-artifact-registry-example>>.
Just like Elastic Artifact Registry. A custom container would need to be created following similar instructions to setting up a web server for the <<air-gapped-elastic-artifact-registry,self-managed install case>>.
186
+
Just like the {artifact-registry}. A custom container needs to be created following similar instructions to setting up a web server for the <<air-gapped-elastic-artifact-registry,self-managed install case>>.
186
187
187
188
[discrete]
188
189
[[air-gapped-k8s-os-ironbank-secure-images]]
@@ -265,7 +266,7 @@ WantedBy=default.target
265
266
266
267
[discrete]
267
268
[[air-gapped-elastic-artifact-registry-example]]
268
-
=== Appendix B - Elastic Artifact Registry
269
+
=== Appendix B - {artifact-registry}
269
270
270
271
The following example script downloads artifacts from the internet to be later served as a private Elastic Package Registry.
271
272
@@ -337,7 +338,7 @@ done
337
338
338
339
----
339
340
340
-
The following is an example NGINX configuration for running a web server for the Elastic Artifact Registry.
341
+
The following is an example NGINX configuration for running a web server for the {artifact-registry}.
341
342
342
343
[source,shell]
343
344
----
@@ -454,7 +455,7 @@ When configuring any integration in {agent}, you need to set up integration sett
454
455
Note the following terms and definitions:
455
456
456
457
Integration::
457
-
A variety of optional capabilities that can be deployed on top of the {stack}. refer to link:https://www.elastic.co/integrations/[Integrations] to learn more.
458
+
A variety of optional capabilities that can be deployed on top of the {stack}. Refer to link:https://www.elastic.co/integrations/[Integrations] to learn more.
458
459
459
460
Agent integration::
460
461
The integrations that require {agent} to run. For example, the Sample Data integration requires only {es} and {kib} and consists of dashboards, data, and related objects, but the APM integration not only has some {es} objects, but also needs {agent} to run the APM Server.
@@ -483,7 +484,7 @@ There are three ways to configure {agent} integrations:
483
484
484
485
*Example:* {observability-guide}/logs-metrics-get-started.html[Get started with logs and metrics]
485
486
486
-
Agent policies and integration settings can be managed using the {kib} UI. For example, the following shows the configuration of logging for the System integration in an agent policy:
487
+
Agent policies and integration settings can be managed using the {kib} UI. For example, the following shows the configuration of logging for the System integration in an {agent} policy:
487
488
488
489
[role="screenshot"]
489
490
image::images/air-gapped-configure-logging.png[Configuration of a logging integration in an agent policy]
@@ -498,10 +499,10 @@ image::images/air-gapped-configure-logging.png[Configuration of a logging integr
498
499
499
500
NOTE: This documentation is still under development; there may be gaps around building custom agent policies.
500
501
501
-
It is possible to have kibana create agent policies on your behalf by adding appropriate config items in `kibana.yml` settings file, these include:
502
+
You can have {kib} create {agent} policies on your behalf by adding appropriate configuration parameters in the `kibana.yml` settings file, these include:
502
503
503
504
`xpack.fleet.packages`::
504
-
Takes a list of all integration package names and versions that {kib} should download from the {package-registry} (EPR). This is done because agents themselves do not directly fetch packages from the EPR.
505
+
Takes a list of all integration package names and versions that {kib} should download from the {package-registry} (EPR). This is done because {agents} themselves do not directly fetch packages from the EPR.
505
506
506
507
`xpack.fleet.agentPolicies`::
507
508
Takes a list of {agent} policies in the format expected by the {fleet-guide}/fleet-api-docs.html[{kib} {fleet} HTTP API]. Refer to the setting in {kibana-ref}/fleet-settings-kb.html#_preconfiguration_settings_for_advanced_use_cases[Preconfiguration settings] for the format. See also <<air-gapped-agent-integration-configure-fleet-api>>.
@@ -518,7 +519,7 @@ You can add other, more discretionary settings for {fleet}, {agents}, & policies
518
519
519
520
*Best option for*: Declarative configuration and users who need reproducible and automated deployments in even the trickiest of environments.
520
521
521
-
*Example:* Read the following.
522
+
*Example:* See the following.
522
523
523
524
It is possible to use custom scripts that call the {kib} {fleet} API to create or update policies without restarting {kib}, and also allowing for custom error handling and update logic.
0 commit comments