IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Enterprise Search settings in Kibana i18n settings in Kibana »
Elastic Docs ›Kibana Guide [8.5] ›Set up ›Configure Kibana

Fleet settings in Kibana

edit

Fleet settings in Kibana

edit

In Elastic Cloud, Fleet flags are already configured.

You can configure xpack.fleet settings in your kibana.yml. By default, Fleet is enabled. To use Fleet, you also need to configure Kibana and Elasticsearch hosts.

See the Fleet docs for more information.

General Fleet settings

edit
xpack.fleet.agents.enabled logo cloud
Set to true (default) to enable Fleet.

Elastic Package Manager settings

edit
xpack.fleet.registryUrl
The address to use to reach the Elastic Package Manager registry.
xpack.fleet.registryProxyUrl
The proxy address to use to reach the Elastic Package Manager registry if an internet connection is not directly available. Refer to Air-gapped environments for details.
xpack.fleet.packageVerification.gpgKeyPath
The path on disk to the GPG key used to verify Elastic Package Manager packages. If the Elastic public key is ever reissued as a security precaution, you can use this setting to specify the new key.

Fleet settings

edit
xpack.fleet.agents.fleet_server.hosts

Hostnames used by Elastic Agent for accessing Fleet Server.

If configured in your kibana.yml, this setting is grayed out and unavailable in the Fleet UI. To make this setting editable in the UI, do not configure it in the configuration file.

xpack.fleet.agents.elasticsearch.hosts
Hostnames used by Elastic Agent for accessing Elasticsearch.
xpack.fleet.agents.elasticsearch.ca_sha256
Hash pin used for certificate verification. The pin is a base64-encoded string of the SHA-256 fingerprint.

Preconfiguration settings (for advanced use cases)

edit

Use these settings to pre-define integrations and agent policies that you want Fleet to load up by default.

These settings are not supported to pre-configure the Endpoint and Cloud Security integration.

xpack.fleet.packages

List of integrations that are installed when the Fleet app starts up for the first time.

Required properties of xpack.fleet.packages
name
Name of the integration from the package registry.
version
Either an exact semantic version, or the keyword latest to fetch the latest integration version.
xpack.fleet.agentPolicies

List of agent policies that are configured when the Fleet app starts.

Required properties of xpack.fleet.agentPolicies
id
Unique ID for this policy. The ID may be a number or string.
name
Policy name.
Optional properties of xpack.fleet.agentPolicies
description
Text description of this policy.
namespace
String identifying this policy’s namespace.
monitoring_enabled
List of keywords that specify the monitoring data to collect. Valid values include ['logs'], ['metrics'], and ['logs', 'metrics'].
is_managed
If true, this policy is not editable by the user and can only be changed by updating the Kibana config.
is_default
If true, this policy is the default agent policy.
is_default_fleet_server
If true, this policy is the default Fleet Server agent policy.
data_output_id
ID of the output to send data. (Need to be identical to monitoring_output_id)
monitoring_output_id
ID of the output to send monitoring data. (Need to be identical to data_output_id)
package_policies

List of integration policies to add to this policy.

Properties of package_policies
id
Unique ID of the integration policy. The ID may be a number or string.
name
(required) Name of the integration policy.
package

(required) Integration that this policy configures.

Properties of package
name
Name of the integration associated with this policy.
description
Text string describing this integration policy.
namespace
String identifying this policy’s namespace.
inputs
Array that overrides any default input settings for this integration. Follows the same schema as integration inputs, with the exception that any object in vars can be passed frozen: true in order to prevent that specific var from being edited by the user.
xpack.fleet.outputs

List of outputs that are configured when the Fleet app starts.

If configured in your kibana.yml, output settings are grayed out and unavailable in the Fleet UI. To make these settings editable in the UI, do not configure them in the configuration file.

Required properties of xpack.fleet.outputs
id
Unique ID for this output. The ID should be a string.
name
Output name.
type
Type of Output. Currently we only support "elasticsearch".
hosts
Array that contains the list of host for that output.
config
Extra config for that output.
Optional properties of xpack.fleet.outputs
is_default
If true, this output is the default output.

Example configuration:

xpack.fleet.packages:
  - name: apache
    version: 0.5.0

xpack.fleet.agentPolicies:
  - name: Preconfigured Policy
    id: 1
    namespace: test
    package_policies:
      - package:
          name: system
        name: System Integration
        id: preconfigured-system
        inputs:
          - type: system/metrics
            enabled: true
            vars:
              - name: system.hostfs
                value: home/test
            streams:
              - data_stream:
                  dataset: system.core
                enabled: true
                vars:
                  - name: period
                    value: 20s
          - type: winlog
            enabled: false
« Enterprise Search settings in Kibana i18n settings in Kibana »