From 1f19eebed6369e2ec2715ee27a5bf0d78d2b9077 Mon Sep 17 00:00:00 2001 From: Nicolas Chaulet Date: Wed, 10 Jun 2020 14:21:01 -0400 Subject: [PATCH] [Ingest Manager] Document fleet configuration flags (#66736) (#68769) --- .../settings/ingest-manager-settings.asciidoc | 65 +++++++++++++++++++ docs/settings/settings-xkb.asciidoc | 1 + docs/setup/settings.asciidoc | 1 + 3 files changed, 67 insertions(+) create mode 100644 docs/settings/ingest-manager-settings.asciidoc diff --git a/docs/settings/ingest-manager-settings.asciidoc b/docs/settings/ingest-manager-settings.asciidoc new file mode 100644 index 00000000000000..15f64e344d7c6f --- /dev/null +++ b/docs/settings/ingest-manager-settings.asciidoc @@ -0,0 +1,65 @@ +[role="xpack"] +[[ingest-manager-settings-kb]] +=== {ingest-manager} settings in {kib} +++++ +{ingest-manager} settings +++++ + +You can configure `xpack.ingestManager` settings in your `kibana.yml`. +By default, {ingest-manager} is not enabled. You need to enable it. To use {fleet}, you also need to configure {kib} and {es} hosts. + +[[general-ingest-manager-settings-kb]] +==== General {ingest-manager} settings + +[cols="2*<"] +|=== +| `xpack.ingestManager.enabled` {ess-icon} + | Set to `true` to enable {ingest-manager}. +|=== + +[cols="2*<"] +|=== +| `xpack.ingestManager.epm.enabled` {ess-icon} + | Set to `true` (default) to enable {package-manager}. +|=== + +[cols="2*<"] +|=== +| `xpack.ingestManager.fleet.enabled` {ess-icon} + | Set to `true` (default) to enable {fleet}. +|=== + +[[ingest-manager-data-visualizer-settings]] + +==== {package-manager} settings + +[cols="2*<"] +|=== +| `xpack.ingestManager.epm.registryUrl` + | The address to use to reach {package-manager} registry. +|=== + +==== {fleet} settings + +[cols="2*<"] +|=== +| `xpack.ingestManager.fleet.kibana.host` + | The hostname used by {agent} for accessing {kib}. +|=== + +[cols="2*<"] +|=== +| `xpack.ingestManager.fleet.elasticsearch.host` + | The hostname used by {agent} for accessing {es}. +|=== + +[cols="2*<"] +|=== +| `xpack.ingestManager.fleet.tlsCheckDisabled` + | Set to `true` to allow {fleet} to run on a {kib} instance without TLS enabled. +|=== + +[NOTE] +==== +In {ecloud}, {fleet} flags are already configured. +==== diff --git a/docs/settings/settings-xkb.asciidoc b/docs/settings/settings-xkb.asciidoc index 4d594b4113e69f..04fed0d6204b7b 100644 --- a/docs/settings/settings-xkb.asciidoc +++ b/docs/settings/settings-xkb.asciidoc @@ -20,3 +20,4 @@ include::ml-settings.asciidoc[] include::reporting-settings.asciidoc[] include::spaces-settings.asciidoc[] include::i18n-settings.asciidoc[] +include::ingest-manager-settings.asciidoc[] diff --git a/docs/setup/settings.asciidoc b/docs/setup/settings.asciidoc index c8393a114842a6..4f98a6956ffc74 100644 --- a/docs/setup/settings.asciidoc +++ b/docs/setup/settings.asciidoc @@ -641,3 +641,4 @@ include::secure-settings.asciidoc[] include::{kib-repo-dir}/settings/security-settings.asciidoc[] include::{kib-repo-dir}/settings/spaces-settings.asciidoc[] include::{kib-repo-dir}/settings/telemetry-settings.asciidoc[] +include::{docdir}/settings/ingest-manager-settings.asciidoc[]