Skip to content

Commit c72a86a

Browse files
committed
Clean-up
1 parent 8551712 commit c72a86a

File tree

1 file changed

+26
-25
lines changed

1 file changed

+26
-25
lines changed

docs/en/install-upgrade/air-gapped-install.asciidoc

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,13 @@ Some components of the {stack} require additional configuration and local depend
3737
*** <<air-gapped-agent-integration-configure-yml>>
3838
*** <<air-gapped-agent-integration-configure-fleet-api>>
3939

40+
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+
4042
[discrete]
4143
[[air-gapped-self-managed-linux]]
4244
=== 1. Self-Managed Install (Linux)
4345

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.
4547

4648
[discrete]
4749
[[air-gapped-elasticsearch]]
@@ -55,14 +57,13 @@ Air-gapped install of {es} is fairly straightforward, as this component does not
5557

5658
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].
5759

58-
Specifically (see appropriate sections in the rest of the doc):
60+
Specifically:
5961

6062
* To be able to use {kib} mapping visualizations, you need to set up and configure the <<air-gapped-elastic-maps-service,Elastic Maps Service>>.
6163
* 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>>.
6667

6768
[discrete]
6869
[[air-gapped-beats]]
@@ -80,9 +81,9 @@ Elastic {beats} are light-weight data shippers. They do not require any unique s
8081
[[air-gapped-elastic-agent]]
8182
==== 1.5. {agent}
8283

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}>>.
8485

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.
8687

8788
To learn more about install and configuration, refer to the {fleet-guide}/elastic-agent-installation.html[{agent} install documentation].
8889

@@ -93,7 +94,7 @@ To get a better understanding of how to work with {agent} configuration settings
9394
[[air-gapped-fleet]]
9495
==== 1.6. {fleet-server}
9596

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}>>.
9798

9899
To learn more about installing {fleet-server}, refer to the {fleet-guide}/fleet-server.html[{fleet-server} set up documentation].
99100

@@ -104,7 +105,7 @@ To learn more about installing {fleet-server}, refer to the {fleet-guide}/fleet-
104105
Air-gapped setup of the APM server is possible in two ways:
105106

106107
* 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].
108109

109110
[discrete]
110111
[[air-gapped-elastic-maps-service]]
@@ -122,27 +123,27 @@ Detailed install and configuration instructions are available in the {enterprise
122123
[[air-gapped-elastic-package-registry]]
123124
==== 1.10. {package-registry}
124125

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.
126127

127128
Refer to <<air-gapped-elastic-package-registry-example>> for additional setup examples.
128129

129130
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.
130131

131132
[discrete]
132133
[[air-gapped-elastic-artifact-registry]]
133-
==== 1.11. Elastic Artifact Registry
134+
==== 1.11. {artifact-registry}
134135

135-
Air-gapped install of the Elastic 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 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.
136137

137138
Refer to <<air-gapped-elastic-artifact-registry-example>> for additional setup examples.
138139

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.
140141

141142
[discrete]
142143
[[air-gapped-elastic-endpoint-artifact-repository]]
143144
==== 1.12. Elastic Endpoint Artifact Repository
144145

145-
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.
146147

147148
[discrete]
148149
[[air-gapped-kubernetes-and-openshift]]
@@ -161,7 +162,7 @@ The main requirements are:
161162
* Syncing container images for ECK and all other {stack} components over to a locally-accessible container repository.
162163
* 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.
163164
* 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}.
165166
* Building your custom deployment container image for the Elastic Endpoint Artifact Repository.
166167

167168
[discrete]
@@ -174,15 +175,15 @@ This container would, ideally, run as a Kubernetes deployment. Refer to <<air-ga
174175

175176
[discrete]
176177
[[air-gapped-k8s-os-elastic-artifact-registry]]
177-
==== 2.3. Elastic Artifact Registry
178+
==== 2.3. {artifact-registry}
178179

179180
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>>.
180181

181182
[discrete]
182183
[[air-gapped-k8s-os-elastic-endpoint-artifact-repository]]
183184
==== 2.4. Elastic Endpoint Artifact Repository
184185

185-
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>>.
186187

187188
[discrete]
188189
[[air-gapped-k8s-os-ironbank-secure-images]]
@@ -265,7 +266,7 @@ WantedBy=default.target
265266

266267
[discrete]
267268
[[air-gapped-elastic-artifact-registry-example]]
268-
=== Appendix B - Elastic Artifact Registry
269+
=== Appendix B - {artifact-registry}
269270

270271
The following example script downloads artifacts from the internet to be later served as a private Elastic Package Registry.
271272

@@ -337,7 +338,7 @@ done
337338
338339
----
339340

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}.
341342

342343
[source,shell]
343344
----
@@ -454,7 +455,7 @@ When configuring any integration in {agent}, you need to set up integration sett
454455
Note the following terms and definitions:
455456

456457
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.
458459

459460
Agent integration::
460461
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:
483484

484485
*Example:* {observability-guide}/logs-metrics-get-started.html[Get started with logs and metrics]
485486

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:
487488

488489
[role="screenshot"]
489490
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
498499

499500
NOTE: This documentation is still under development; there may be gaps around building custom agent policies.
500501

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:
502503

503504
`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.
505506

506507
`xpack.fleet.agentPolicies`::
507508
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
518519

519520
*Best option for*: Declarative configuration and users who need reproducible and automated deployments in even the trickiest of environments.
520521

521-
*Example:* Read the following.
522+
*Example:* See the following.
522523

523524
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.
524525

0 commit comments

Comments
 (0)