From 6188cddfc2902c8f925fc613de939751c11b97d6 Mon Sep 17 00:00:00 2001 From: Nicolas Chaulet Date: Fri, 15 May 2020 10:14:23 -0400 Subject: [PATCH 1/5] [Ingest Manager] Document fleet configuration flags --- docs/ingest_manager/fleet.asciidoc | 25 +++++++++++++++++++++++++ docs/ingest_manager/index.asciidoc | 7 ++++++- 2 files changed, 31 insertions(+), 1 deletion(-) create mode 100644 docs/ingest_manager/fleet.asciidoc diff --git a/docs/ingest_manager/fleet.asciidoc b/docs/ingest_manager/fleet.asciidoc new file mode 100644 index 0000000000000..043012ec3475e --- /dev/null +++ b/docs/ingest_manager/fleet.asciidoc @@ -0,0 +1,25 @@ +[role="xpack"] +[[ingest-manager-fleet]] + +== Fleet + +Fleet is the part of the Ingest Manager Plugin in Kibana that handles the part of enrolling Elastic Agents, +managing agents and sending configurations to the Elastic Agent. + +[float] +=== Configuration + +Before using Fleet you need to configure host settings for Kibana and Elasticsearch. This could be done using: +* In your kibana config file by setting `xpack.ingestManager.fleet.elasticsearch.host` and `xpack.ingestManager.fleet.kibana.host` +* From Kibana UI in the Ingest Manager plugin global settings page. + +[NOTE] +============================================================================ +If you are using cloud this flags are already set for you. +============================================================================ + +[float] +=== Requirements + +To be able to run Fleet, Kibana and Elasticsearch should use TLS and API key should be enabled on Elasticsearch. In some scenario you could have to disable the check of TLS requirements this can be done by adding `xpack.ingestManager.fleet.tlsCheckDisabled: true` to your Kibana configuration. + diff --git a/docs/ingest_manager/index.asciidoc b/docs/ingest_manager/index.asciidoc index 866935d1fa580..3f26c8da60491 100644 --- a/docs/ingest_manager/index.asciidoc +++ b/docs/ingest_manager/index.asciidoc @@ -1,5 +1,6 @@ +[[ingest-manager]] [role="xpack"] -[[epm]] + == Ingest Manager These are the docs for the Ingest Manager. @@ -68,6 +69,8 @@ More details about the registry can be found [here](https://github.com/elastic/p Fleet is the part of the Ingest Manager UI in Kibana that handles the part of enrolling Elastic Agents, managing agents and sending configurations to the Elastic Agent. +<> + ==== Indexing Strategy Ingest Management + Elastic Agent follow a strict new indexing strategy: `{type}-{dataset}-{namespace}`. An example @@ -206,3 +209,5 @@ When a package is installed or upgraded, certain Kibana and Elasticsearch assets * link:index-templates.asciidoc[Elasticsearch Index Templates] * Kibana Index Patterns + +include::fleet.asciidoc[] \ No newline at end of file From fa691fa5c0659b17c9ad3fa451d250047fe3b406 Mon Sep 17 00:00:00 2001 From: Nicolas Chaulet Date: Fri, 15 May 2020 16:32:11 -0400 Subject: [PATCH 2/5] Create ingest manager settings doc --- docs/ingest_manager/fleet.asciidoc | 25 --------- docs/ingest_manager/index.asciidoc | 7 +-- .../settings/ingest-manager-settings.asciidoc | 56 +++++++++++++++++++ docs/settings/settings-xkb.asciidoc | 1 + docs/setup/settings.asciidoc | 1 + 5 files changed, 59 insertions(+), 31 deletions(-) delete mode 100644 docs/ingest_manager/fleet.asciidoc create mode 100644 docs/settings/ingest-manager-settings.asciidoc diff --git a/docs/ingest_manager/fleet.asciidoc b/docs/ingest_manager/fleet.asciidoc deleted file mode 100644 index 043012ec3475e..0000000000000 --- a/docs/ingest_manager/fleet.asciidoc +++ /dev/null @@ -1,25 +0,0 @@ -[role="xpack"] -[[ingest-manager-fleet]] - -== Fleet - -Fleet is the part of the Ingest Manager Plugin in Kibana that handles the part of enrolling Elastic Agents, -managing agents and sending configurations to the Elastic Agent. - -[float] -=== Configuration - -Before using Fleet you need to configure host settings for Kibana and Elasticsearch. This could be done using: -* In your kibana config file by setting `xpack.ingestManager.fleet.elasticsearch.host` and `xpack.ingestManager.fleet.kibana.host` -* From Kibana UI in the Ingest Manager plugin global settings page. - -[NOTE] -============================================================================ -If you are using cloud this flags are already set for you. -============================================================================ - -[float] -=== Requirements - -To be able to run Fleet, Kibana and Elasticsearch should use TLS and API key should be enabled on Elasticsearch. In some scenario you could have to disable the check of TLS requirements this can be done by adding `xpack.ingestManager.fleet.tlsCheckDisabled: true` to your Kibana configuration. - diff --git a/docs/ingest_manager/index.asciidoc b/docs/ingest_manager/index.asciidoc index 3f26c8da60491..866935d1fa580 100644 --- a/docs/ingest_manager/index.asciidoc +++ b/docs/ingest_manager/index.asciidoc @@ -1,6 +1,5 @@ -[[ingest-manager]] [role="xpack"] - +[[epm]] == Ingest Manager These are the docs for the Ingest Manager. @@ -69,8 +68,6 @@ More details about the registry can be found [here](https://github.com/elastic/p Fleet is the part of the Ingest Manager UI in Kibana that handles the part of enrolling Elastic Agents, managing agents and sending configurations to the Elastic Agent. -<> - ==== Indexing Strategy Ingest Management + Elastic Agent follow a strict new indexing strategy: `{type}-{dataset}-{namespace}`. An example @@ -209,5 +206,3 @@ When a package is installed or upgraded, certain Kibana and Elasticsearch assets * link:index-templates.asciidoc[Elasticsearch Index Templates] * Kibana Index Patterns - -include::fleet.asciidoc[] \ No newline at end of file diff --git a/docs/settings/ingest-manager-settings.asciidoc b/docs/settings/ingest-manager-settings.asciidoc new file mode 100644 index 0000000000000..3a9e35e8ea5d8 --- /dev/null +++ b/docs/settings/ingest-manager-settings.asciidoc @@ -0,0 +1,56 @@ +[role="xpack"] +[[ingest-manager-settings-kb]] +=== Ingest Manager settings in Kibana +++++ +Ingest Manager settings +++++ + +You can configure `xpack.ingestManager` settings in your `kibana.yml` + +[[general-ingest-manager-settings-kb]] +==== General Ingest Manager settings + +[cols="2*<"] +|=== +| `xpack.ingestManager.enabled` + | Set to `true` to enable {kib} Ingest Manager. +|=== + +[cols="2*<"] +|=== +| `xpack.ingestManager.epm.enabled` + | Set to `true` (default) to enable {kib} EPM. +|=== + +[cols="2*<"] +|=== +| `xpack.ingestManager.fleet.enabled` + | Set to `true` (default) to enable {kib} Fleet. +|=== + +[[ingest-manager-data-visualizer-settings]] + +==== Fleet settings + +[cols="2*<"] +|=== +| `xpack.ingestManager.fleet.kibana.host` + | The hostname used by Elastic Agent for accessing Kibana +|=== + +[cols="2*<"] +|=== +| `xpack.ingestManager.fleet.elasticsearch.host` + | The hostname used by Elastic Agent for accessing ElasticSearch +|=== + +[cols="2*<"] +|=== +| `xpack.ingestManager.fleet.tlsCheckDisabled` + | Set to `true` to allow to run Fleet on a Kibana instance without TLS enabled. +|=== + +[NOTE] +==== +In Elastic Cloud, Fleet flags are already configured. +==== \ No newline at end of file diff --git a/docs/settings/settings-xkb.asciidoc b/docs/settings/settings-xkb.asciidoc index f9727db838d55..b2057e9389759 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 cc662af08b8f1..bcb5b2ca19954 100644 --- a/docs/setup/settings.asciidoc +++ b/docs/setup/settings.asciidoc @@ -642,3 +642,4 @@ include::secure-settings.asciidoc[] include::{docdir}/settings/security-settings.asciidoc[] include::{docdir}/settings/spaces-settings.asciidoc[] include::{docdir}/settings/telemetry-settings.asciidoc[] +include::{docdir}/settings/ingest-manager-settings.asciidoc[] From 35e947992ba55e9f25c992c625551cf270ac4edc Mon Sep 17 00:00:00 2001 From: Nicolas Chaulet Date: Sun, 7 Jun 2020 18:28:21 -0400 Subject: [PATCH 3/5] Apply suggestions from code review Co-authored-by: DeDe Morton --- .../settings/ingest-manager-settings.asciidoc | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/settings/ingest-manager-settings.asciidoc b/docs/settings/ingest-manager-settings.asciidoc index 3a9e35e8ea5d8..20f00d580e683 100644 --- a/docs/settings/ingest-manager-settings.asciidoc +++ b/docs/settings/ingest-manager-settings.asciidoc @@ -1,11 +1,11 @@ [role="xpack"] [[ingest-manager-settings-kb]] -=== Ingest Manager settings in Kibana +=== Ingest Manager settings in {kib} ++++ Ingest Manager settings ++++ -You can configure `xpack.ingestManager` settings in your `kibana.yml` +You can configure `xpack.ingestManager` settings in your `kibana.yml`. [[general-ingest-manager-settings-kb]] ==== General Ingest Manager settings @@ -13,19 +13,19 @@ You can configure `xpack.ingestManager` settings in your `kibana.yml` [cols="2*<"] |=== | `xpack.ingestManager.enabled` - | Set to `true` to enable {kib} Ingest Manager. + | Set to `true` to enable Ingest Manager. |=== [cols="2*<"] |=== | `xpack.ingestManager.epm.enabled` - | Set to `true` (default) to enable {kib} EPM. + | Set to `true` (default) to enable the package manager. |=== [cols="2*<"] |=== | `xpack.ingestManager.fleet.enabled` - | Set to `true` (default) to enable {kib} Fleet. + | Set to `true` (default) to enable Fleet. |=== [[ingest-manager-data-visualizer-settings]] @@ -35,22 +35,22 @@ You can configure `xpack.ingestManager` settings in your `kibana.yml` [cols="2*<"] |=== | `xpack.ingestManager.fleet.kibana.host` - | The hostname used by Elastic Agent for accessing Kibana + | The hostname used by Elastic Agent for accessing {kib}. |=== [cols="2*<"] |=== | `xpack.ingestManager.fleet.elasticsearch.host` - | The hostname used by Elastic Agent for accessing ElasticSearch + | The hostname used by Elastic Agent for accessing {es}. |=== [cols="2*<"] |=== | `xpack.ingestManager.fleet.tlsCheckDisabled` - | Set to `true` to allow to run Fleet on a Kibana instance without TLS enabled. + | Set to `true` to allow Fleet to run on a {kib} instance without TLS enabled. |=== [NOTE] ==== -In Elastic Cloud, Fleet flags are already configured. -==== \ No newline at end of file +In {ecloud}, Fleet flags are already configured. +==== From d60ce007fbcbcfffefddac5f2a53a6761efe8a46 Mon Sep 17 00:00:00 2001 From: Nicolas Chaulet Date: Sun, 7 Jun 2020 20:50:14 -0400 Subject: [PATCH 4/5] Fix documentation --- docs/settings/ingest-manager-settings.asciidoc | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/docs/settings/ingest-manager-settings.asciidoc b/docs/settings/ingest-manager-settings.asciidoc index 20f00d580e683..f4b43957efaf5 100644 --- a/docs/settings/ingest-manager-settings.asciidoc +++ b/docs/settings/ingest-manager-settings.asciidoc @@ -5,31 +5,40 @@ Ingest Manager settings ++++ -You can configure `xpack.ingestManager` settings in your `kibana.yml`. +You can configure `xpack.ingestManager` settings in your `kibana.yml`. +By default Ingest Manager is not enabled you need to enable it. Also to you use Fleet, you need to configure {kib} and {es} hosts. [[general-ingest-manager-settings-kb]] ==== General Ingest Manager settings [cols="2*<"] |=== -| `xpack.ingestManager.enabled` +| `xpack.ingestManager.enabled` {ess-icon} | Set to `true` to enable Ingest Manager. |=== [cols="2*<"] |=== -| `xpack.ingestManager.epm.enabled` +| `xpack.ingestManager.epm.enabled` {ess-icon} | Set to `true` (default) to enable the package manager. |=== [cols="2*<"] |=== -| `xpack.ingestManager.fleet.enabled` +| `xpack.ingestManager.fleet.enabled` {ess-icon} | Set to `true` (default) to enable Fleet. |=== [[ingest-manager-data-visualizer-settings]] +==== EPM settings + +[cols="2*<"] +|=== +| `xpack.ingestManager.epm.registryUrl` + | The address use to reach EPM registry +|=== + ==== Fleet settings [cols="2*<"] From 5645ba90ed2c4611699d1cf8f3f3d6a84c3bad73 Mon Sep 17 00:00:00 2001 From: Nicolas Chaulet Date: Tue, 9 Jun 2020 10:46:10 -0400 Subject: [PATCH 5/5] Apply suggestions from code review Co-authored-by: DeDe Morton --- .../settings/ingest-manager-settings.asciidoc | 28 +++++++++---------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/settings/ingest-manager-settings.asciidoc b/docs/settings/ingest-manager-settings.asciidoc index f4b43957efaf5..15f64e344d7c6 100644 --- a/docs/settings/ingest-manager-settings.asciidoc +++ b/docs/settings/ingest-manager-settings.asciidoc @@ -1,65 +1,65 @@ [role="xpack"] [[ingest-manager-settings-kb]] -=== Ingest Manager settings in {kib} +=== {ingest-manager} settings in {kib} ++++ -Ingest Manager settings +{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. Also to you use Fleet, you need to configure {kib} and {es} hosts. +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 +==== General {ingest-manager} settings [cols="2*<"] |=== | `xpack.ingestManager.enabled` {ess-icon} - | Set to `true` to enable Ingest Manager. + | Set to `true` to enable {ingest-manager}. |=== [cols="2*<"] |=== | `xpack.ingestManager.epm.enabled` {ess-icon} - | Set to `true` (default) to enable the package manager. + | Set to `true` (default) to enable {package-manager}. |=== [cols="2*<"] |=== | `xpack.ingestManager.fleet.enabled` {ess-icon} - | Set to `true` (default) to enable Fleet. + | Set to `true` (default) to enable {fleet}. |=== [[ingest-manager-data-visualizer-settings]] -==== EPM settings +==== {package-manager} settings [cols="2*<"] |=== | `xpack.ingestManager.epm.registryUrl` - | The address use to reach EPM registry + | The address to use to reach {package-manager} registry. |=== -==== Fleet settings +==== {fleet} settings [cols="2*<"] |=== | `xpack.ingestManager.fleet.kibana.host` - | The hostname used by Elastic Agent for accessing {kib}. + | The hostname used by {agent} for accessing {kib}. |=== [cols="2*<"] |=== | `xpack.ingestManager.fleet.elasticsearch.host` - | The hostname used by Elastic Agent for accessing {es}. + | 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. + | Set to `true` to allow {fleet} to run on a {kib} instance without TLS enabled. |=== [NOTE] ==== -In {ecloud}, Fleet flags are already configured. +In {ecloud}, {fleet} flags are already configured. ====