Skip to content

Commit 8e25078

Browse files
kibanamachinelcawl
andauthored
[9.0] [DOCS] Consolidate and clean up Kibana settings (part 1) (#214934) (#215048)
# Backport This will backport the following commits from `main` to `9.0`: - [[DOCS] Consolidate and clean up Kibana settings (part 1) (#214934)](#214934) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Lisa Cawley","email":"[email protected]"},"sourceCommit":{"committedDate":"2025-03-18T18:37:40Z","message":"[DOCS] Consolidate and clean up Kibana settings (part 1) (#214934)","sha":"3b2df8935b7ab386a7b94df5f14737fc1b9b0307","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","docs","backport:version","v9.1.0","v9.0.1"],"title":"[DOCS] Consolidate and clean up Kibana settings (part 1)","number":214934,"url":"https://github.com/elastic/kibana/pull/214934","mergeCommit":{"message":"[DOCS] Consolidate and clean up Kibana settings (part 1) (#214934)","sha":"3b2df8935b7ab386a7b94df5f14737fc1b9b0307"}},"sourceBranch":"main","suggestedTargetBranches":["9.0"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/214934","number":214934,"mergeCommit":{"message":"[DOCS] Consolidate and clean up Kibana settings (part 1) (#214934)","sha":"3b2df8935b7ab386a7b94df5f14737fc1b9b0307"}},{"branch":"9.0","label":"v9.0.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Lisa Cawley <[email protected]>
1 parent 02bf213 commit 8e25078

24 files changed

+762
-1358
lines changed

docs/images/apm-settings.png

-1.18 MB
Binary file not shown.

docs/reference/cloud/elastic-cloud-kibana-settings.md

Lines changed: 0 additions & 281 deletions
Large diffs are not rendered by default.

docs/reference/configuration-reference.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ navigation_title: "Configuration"
66
Configuration settings enable you to customize the behavior of Kibana apps and features.
77
This reference provides details about each setting, such as its purpose, default behavior, and availability in Elastic Cloud environments.
88

9-
% TO-DO: For information about how to update these settings, refer to "Configure Kibana" (link to appropriate deployment pages) %
9+
For information about how to update these settings, refer to the appropriate instructions for your environment. For example, [{{ecloud}} Hosted](docs-content://deploy-manage/deploy/elastic-cloud/edit-stack-settings.md), [{{ece}}](docs-content://deploy-manage/deploy/cloud-enterprise/edit-stack-settings-kibana.md), or [self-managed clusters](docs-content://deploy-manage/deploy/self-managed/configure-kibana.md).
1010

1111
The settings are grouped by feature or purpose, for example:
1212

@@ -16,9 +16,11 @@ The settings are grouped by feature or purpose, for example:
1616
- [Banners](/reference/configuration-reference/banner-settings.md)
1717
- [Cases](/reference/configuration-reference/cases-settings.md)
1818
- [Fleet](/reference/configuration-reference/fleet-settings.md)
19+
- [General](/reference/configuration-reference/general-settings.md)
1920
- [Internationalization](/reference/configuration-reference/internationalization-settings.md)
2021
- [Logging](/reference/configuration-reference/logging-settings.md)
2122
- [Logs](/reference/configuration-reference/logs-settings.md)
23+
- [Maps](/reference/configuration-reference/map-settings.md)
2224
- [Metrics](/reference/configuration-reference/metrics-settings.md)
2325
- [Monitoring](/reference/configuration-reference/monitoring-settings.md)
2426
- [Reporting](/reference/configuration-reference/reporting-settings.md)

docs/reference/configuration-reference/ai-assistant-settings.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22
navigation_title: "AI Assistant settings"
33
mapped_pages:
44
- https://www.elastic.co/guide/en/kibana/current/ai-assistant-settings-kb.html
5+
applies_to:
6+
deployment:
7+
self: all
58
---
69

710
# AI Assistant settings in {{kib}} [ai-assistant-settings-kb]
811

9-
1012
`xpack.productDocBase.artifactRepositoryUrl`
1113
: Url of the repository to use to download and install the Elastic product documentation artifacts for the AI assistants. Defaults to `https://kibana-knowledge-base-artifacts.elastic.co`
1214

docs/reference/configuration-reference/alerting-settings.md

Lines changed: 449 additions & 936 deletions
Large diffs are not rendered by default.

docs/reference/configuration-reference/apm-settings.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,25 @@
22
mapped_pages:
33
- https://www.elastic.co/guide/en/kibana/current/apm-settings-kb.html
44
- https://github.com/elastic/cloud/blob/master/docs/cloud-enterprise/ce-apm-settings.asciidoc
5+
applies_to:
6+
deployment:
7+
ess: all
8+
self: all
59
---
610

711
# APM settings in Kibana [apm-settings-kb]
812

913
These settings allow the APM app to function, and specify the data that it surfaces. Unless you’ve customized your setup, you do not need to configure any settings to use the APM app. It is enabled by default.
1014

15+
:::{note}
16+
If a setting is applicable to {{ecloud}} Hosted environments, its name is followed by this icon: ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on Elastic Cloud Hosted")
17+
:::
18+
1119
## APM indices [apm-indices-settings-kb]
1220

1321
The APM app uses data views to query APM indices. To change the default APM indices that the APM app queries, open the APM app and select **Settings** > **Indices**. Index settings in the APM app take precedence over those set in `kibana.yml`.
1422

15-
Starting in version 8.2.0, APM indices are {{kib}} Spaces-aware; Changes to APM index settings will only apply to the currently enabled space.
16-
17-
:::{image} ../../images/apm-settings.png
18-
:alt: APM app settings in Kibana
19-
:class: screenshot
20-
:::
23+
APM indices are {{kib}} space-aware; changes to APM index settings will only apply to the currently enabled space.
2124

2225
## General APM settings [general-apm-settings-kb]
2326

docs/reference/configuration-reference/banner-settings.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
navigation_title: "Banners settings"
33
mapped_pages:
44
- https://www.elastic.co/guide/en/kibana/current/banners-settings-kb.html
5+
applies_to:
6+
deployment:
7+
self: all
58
---
69

710
# Banner settings in {{kib}} [banners-settings-kb]

docs/reference/configuration-reference/cases-settings.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
navigation_title: "Cases settings"
33
mapped_pages:
44
- https://www.elastic.co/guide/en/kibana/current/cases-settings.html
5+
applies_to:
6+
deployment:
7+
self: all
58
---
69

710
# Cases settings in {{kib}} [cases-settings]

docs/reference/configuration-reference/fleet-settings.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,25 @@
22
navigation_title: "{{fleet}} settings"
33
mapped_pages:
44
- https://www.elastic.co/guide/en/kibana/current/fleet-settings-kb.html
5+
applies_to:
6+
deployment:
7+
ess: all
8+
self: all
59
---
610

711
# {{fleet}} settings in {{kib}} [fleet-settings-kb]
812

913

1014
::::{note}
1115
In {{ecloud}}, {{fleet}} flags are already configured.
12-
16+
If a setting is applicable to {{ecloud}} Hosted environments, its name is followed by this icon: ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on Elastic Cloud Hosted")
1317
::::
1418

15-
16-
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.
19+
By default, {{fleet}} is enabled. To use {{fleet}}, you also need to configure {{kib}} and {{es}} hosts.
1720

1821
Many {{fleet}} settings can also be configured directly through the {{fleet}} UI. See [Fleet UI settings](docs-content://reference/ingestion-tools/fleet/fleet-settings.md) for details.
1922

20-
See the [{{fleet}}](docs-content://reference/ingestion-tools/fleet/index.md) docs for more information about {{fleet}}.
23+
Go to the [{{fleet}}](docs-content://reference/ingestion-tools/fleet/index.md) docs for more information about {{fleet}}.
2124

2225
## General {{fleet}} settings [general-fleet-settings-kb]
2326

@@ -27,6 +30,9 @@ See the [{{fleet}}](docs-content://reference/ingestion-tools/fleet/index.md) doc
2730
`xpack.fleet.isAirGapped`
2831
: Set to `true` to indicate {{fleet}} is running in an air-gapped environment. Refer to [Air-gapped environments](docs-content://reference/ingestion-tools/fleet/air-gapped.md) for details. Enabling this flag helps Fleet skip needless requests and improve the user experience for air-gapped environments.
2932

33+
`xpack.fleet.createArtifactsBulkBatchSize` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ess}}")
34+
: Allow to configure batch size for creating and updating Fleet user artifacts. Examples include creation of Trusted Applications and Endpoint Exceptions in Security. It is available in {{ecloud}} 8.9.0 and later versions.
35+
% TBD: Supported only in Elastic Cloud?
3036

3137
## {{package-manager}} settings [fleet-data-visualizer-settings]
3238

@@ -342,13 +348,13 @@ These settings are not supported to pre-configure the Endpoint and Cloud Securit
342348
:::::
343349

344350

345-
`xpack.fleet.enableExperimental`
351+
`xpack.fleet.enableExperimental` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ess}}")
346352
: List of experimental feature flag to enable in Fleet.
353+
It is available in {{ecloud}} 8.6.0 and later versions.
347354

348-
::::{note}
349-
Experimental features should not be enabled in production environments. The features in this section are experimental and may be changed or removed completely in future releases. Elastic will make a best effort to fix any issues, but experimental features are not supported to the same level as generally available (GA) features.
350-
351-
::::
355+
::::{note}
356+
Experimental features should not be enabled in production environments. The features in this section are experimental and may be changed or removed completely in future releases. Elastic will make a best effort to fix any issues, but experimental features are not supported to the same level as generally available (GA) features.
357+
::::
352358

353359

354360
`xpack.fleet.enableManagedLogsAndMetricsDataviews`

0 commit comments

Comments
 (0)