mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 18:51:07 -04:00
3ac1666c1d
This adds new Fleet preconfiguration settings to the Kibana [Fleet settings](https://www.elastic.co/guide/en/kibana/master/fleet-settings-kb.html) page. I also moved the "example configuration" to right below the `xpack.fleet.agentPolicies` setting, since that's what's shown in the example. [Preview page](https://kibana_158771.docs-preview.app.elstc.co/guide/en/kibana/master/fleet-settings-kb.html) Closes: https://github.com/elastic/ingest-docs/issues/191
268 lines
8.3 KiB
Text
268 lines
8.3 KiB
Text
[role="xpack"]
|
|
[[fleet-settings-kb]]
|
|
=== {fleet} settings in {kib}
|
|
++++
|
|
<titleabbrev>{fleet} settings</titleabbrev>
|
|
++++
|
|
|
|
[NOTE]
|
|
====
|
|
In {ecloud}, {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 {kib} and {es} hosts.
|
|
|
|
See the {fleet-guide}/index.html[{fleet}] docs for more information.
|
|
|
|
[[general-fleet-settings-kb]]
|
|
==== General {fleet} settings
|
|
|
|
`xpack.fleet.agents.enabled` {ess-icon}::
|
|
Set to `true` (default) to enable {fleet}.
|
|
|
|
|
|
[[fleet-data-visualizer-settings]]
|
|
|
|
==== {package-manager} settings
|
|
|
|
`xpack.fleet.registryUrl`::
|
|
The address to use to reach the {package-manager} registry.
|
|
|
|
`xpack.fleet.registryProxyUrl`::
|
|
The proxy address to use to reach the {package-manager} registry if an internet connection is not directly available.
|
|
Refer to {fleet-guide}/air-gapped.html[Air-gapped environments] for details.
|
|
|
|
`xpack.fleet.packageVerification.gpgKeyPath`::
|
|
The path on disk to the GPG key used to verify {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
|
|
|
|
`xpack.fleet.agents.fleet_server.hosts`::
|
|
Hostnames used by {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 {agent} for accessing {es}.
|
|
|
|
`xpack.fleet.agents.elasticsearch.ca_sha256`::
|
|
Hash pin used for certificate verification. The pin is a base64-encoded string of the SHA-256 fingerprint.
|
|
|
|
[role="child_attributes"]
|
|
==== Preconfiguration settings (for advanced use cases)
|
|
|
|
Use these settings to pre-define integrations, agent policies, and {fleet-server}
|
|
hosts or proxies that you want {fleet} to load up by default.
|
|
|
|
NOTE: 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`
|
|
[%collapsible%open]
|
|
=====
|
|
`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`
|
|
[%collapsible%open]
|
|
=====
|
|
`id`:::
|
|
Unique ID for this policy. The ID may be a number or string.
|
|
`name`:::
|
|
Policy name.
|
|
=====
|
|
+
|
|
.Optional properties of `xpack.fleet.agentPolicies`
|
|
[%collapsible%open]
|
|
=====
|
|
`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 {kib} 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`
|
|
[%collapsible%open]
|
|
=======
|
|
`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`
|
|
[%collapsible%open]
|
|
========
|
|
`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.
|
|
=======
|
|
=====
|
|
+
|
|
Example configuration:
|
|
+
|
|
[source,yaml]
|
|
----
|
|
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
|
|
----
|
|
|
|
|
|
`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.
|
|
+
|
|
NOTE: The `xpack.fleet.outputs` settings are intended for advanced configurations such as having multiple outputs. We recommend not enabling the `xpack.fleet.agents.elasticsearch.host` settings when using `xpack.fleet.outputs`.
|
|
+
|
|
.Required properties of `xpack.fleet.outputs`
|
|
[%collapsible%open]
|
|
=====
|
|
`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.
|
|
`proxy_id`:::
|
|
Unique ID of a proxy to access the output.
|
|
=====
|
|
+
|
|
.Optional properties of `xpack.fleet.outputs`
|
|
[%collapsible%open]
|
|
=====
|
|
`is_default`:::
|
|
If `true`, the output specified in `xpack.fleet.outputs` will be the one used to send agent data unless there is another one configured specifically for the agent policy.
|
|
`is_default_monitoring`:::
|
|
If `true`, the output specified in `xpack.fleet.outputs` will be the one used to send agent monitoring data unless there is another one configured specifically for the agent policy.
|
|
=====
|
|
|
|
`xpack.fleet.fleetServerHosts`::
|
|
List of {fleet-server} hosts that are configured when the {fleet} app starts.
|
|
+
|
|
.Required properties of `xpack.fleet.fleetServerHosts`
|
|
[%collapsible%open]
|
|
=====
|
|
`id`:::
|
|
Unique ID for the host server.
|
|
`name`:::
|
|
Name of the host server.
|
|
`host_urls`:::
|
|
Array of one or more host URLs that {agents} will use to connect to {fleet-server}.
|
|
=====
|
|
+
|
|
.Optional properties of `xpack.fleet.fleetServerHosts`
|
|
[%collapsible%open]
|
|
=====
|
|
`is_default`:::
|
|
Whether or not this host should be the default to use for {fleet-server}.
|
|
`proxy_id`:::
|
|
Unique ID of the proxy to access the {fleet-server} host.
|
|
=====
|
|
|
|
`xpack.fleet.proxy`::
|
|
List of proxies to access {fleet-server} that are configured when the {fleet} app starts.
|
|
+
|
|
.Required properties of `xpack.fleet.proxy`
|
|
[%collapsible%open]
|
|
=====
|
|
`id`:::
|
|
Unique ID of the proxy to access the {fleet-server} host.
|
|
`name`:::
|
|
Name of the proxy to access the {fleet-server} host.
|
|
`url`:::
|
|
URL that {agents} use to connect to the proxy to access {fleet-server}.
|
|
=====
|
|
+
|
|
.Optional properties of `xpack.fleet.proxy`
|
|
[%collapsible%open]
|
|
=====
|
|
`proxy_headers`:::
|
|
Map of headers to use with the proxy.
|
|
.Properties of `proxy_headers`
|
|
[%collapsible%open]
|
|
=======
|
|
`key`::::
|
|
Key to use for the proxy header.
|
|
`value`::::
|
|
Value to use for the proxy header.
|
|
=======
|
|
`certificate_authorities`:::
|
|
Certificate authority (CA) used to issue the certificate.
|
|
`certificate`:::
|
|
The name of the certificate used to authenticate the proxy.
|
|
`certificate_key`:::
|
|
The certificate key used to authenticate the proxy.
|
|
=====
|
|
|
|
`xpack.fleet.enableExperimental`::
|
|
List of experimental feature flag to enable in Fleet.
|
|
|
|
|