Skip to content

Commit 8551712

Browse files
committed
Add How to Configure sections
1 parent d7dfb78 commit 8551712

File tree

2 files changed

+38
-3
lines changed

2 files changed

+38
-3
lines changed

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

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -479,18 +479,53 @@ There are three ways to configure {agent} integrations:
479479
[[air-gapped-agent-integration-configure-kibana]]
480480
==== D.2.1. Using the {kib} UI
481481

482-
tbd
482+
*Best option for:* Manual configuration and users who prefer using a UI over scripting.
483+
484+
*Example:* {observability-guide}/logs-metrics-get-started.html[Get started with logs and metrics]
485+
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+
488+
[role="screenshot"]
489+
image::images/air-gapped-configure-logging.png[Configuration of a logging integration in an agent policy]
483490

484491
[discrete]
485492
[[air-gapped-agent-integration-configure-yml]]
486493
==== D.2.2. Using the `kibana.yml` config file
487494

488-
tbd
495+
*Good option for:* Declarative configuration and users who need reproducible and automated deployments.
496+
497+
*Example:* {kibana-ref}/fleet-settings-kb.html[Fleet settings in {kib}]
498+
499+
NOTE: This documentation is still under development; there may be gaps around building custom agent policies.
500+
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+
503+
`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+
506+
`xpack.fleet.agentPolicies`::
507+
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>>.
508+
509+
`xpack.fleet.registryUrl`::
510+
Takes a URL of the {package-registry} that can be reached by the {kib} server. Enable this setting only when deploying in an air-gapped environment.
511+
512+
Other settings::
513+
You can add other, more discretionary settings for {fleet}, {agents}, & policies. Refer to {kibana-ref}/fleet-settings-kb.html[Fleet settings in {kib}].
489514

490515
[discrete]
491516
[[air-gapped-agent-integration-configure-fleet-api]]
492517
==== D.2.3. Using the {kib} {fleet} API
493518

494-
tbd
519+
*Best option for*: Declarative configuration and users who need reproducible and automated deployments in even the trickiest of environments.
520+
521+
*Example:* Read the following.
522+
523+
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.
524+
525+
At this time, you can refer to the the {fleet-guide}/fleet-api-docs.html[{kib} {fleet} HTTP API] documentation, however additional resources from public code repositories should be consulted to capture the full set of configuration options available for a given integration. Specifically, many integrations have configuration options such as `inputs` and `data_streams` that are unique.
526+
527+
In particular, the `*.yml.hbs` templates should be consulted to determine which `vars` are available for configuring a particular integration using the {kib} {fleet} API.
495528

529+
* For most Integrations, refer to the README and `*.yml.hbs` files in the appropriate directory in the link:https://github.com/elastic/integrations/tree/main/packages[elastic/integrations repository].
496530

531+
* For the APM integration, refer to the README and `*.yml.hbs` files in the link:https://github.com/elastic/apm-server/tree/main/apmpackage/apm/agent[elastic/apm-server repository].
Loading

0 commit comments

Comments
 (0)