diff --git a/docs/index.asciidoc b/docs/index.asciidoc index 59c945ee9e55d..18becd617ed07 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -28,8 +28,6 @@ include::monitoring/configuring-monitoring.asciidoc[] include::security/securing-kibana.asciidoc[] -include::settings/settings-xkb.asciidoc[] - include::getting-started.asciidoc[] include::discover.asciidoc[] diff --git a/docs/monitoring/configuring-monitoring.asciidoc b/docs/monitoring/configuring-monitoring.asciidoc index bcc98f279bc60..b4a7273136f37 100644 --- a/docs/monitoring/configuring-monitoring.asciidoc +++ b/docs/monitoring/configuring-monitoring.asciidoc @@ -20,4 +20,3 @@ To learn about monitoring in general, see include::monitoring-kibana.asciidoc[] include::monitoring-metricbeat.asciidoc[] include::viewing-metrics.asciidoc[] -include::{kib-repo-dir}/settings/monitoring-settings.asciidoc[] \ No newline at end of file diff --git a/docs/redirects.asciidoc b/docs/redirects.asciidoc index 152e9a84717f6..4ccf38ad49925 100644 --- a/docs/redirects.asciidoc +++ b/docs/redirects.asciidoc @@ -12,3 +12,10 @@ The following pages have moved or been deleted. See <>. + +[role="exclude",id="settings-xpack-kb"] +== {xpack} Settings in {kib} + +include::{asciidoc-dir}/../../shared/settings.asciidoc[] + +For more {kib} configuration settings, see <>. diff --git a/docs/security/securing-kibana.asciidoc b/docs/security/securing-kibana.asciidoc index f9869d704551b..85c71f1c2d4aa 100644 --- a/docs/security/securing-kibana.asciidoc +++ b/docs/security/securing-kibana.asciidoc @@ -1,8 +1,8 @@ [role="xpack"] [[using-kibana-with-security]] -== Configuring Security in {kib} +== Configuring security in {kib} ++++ -Configuring Security +Configuring security ++++ {kib} users have to log in when {security} is enabled on your cluster. You @@ -126,4 +126,3 @@ NOTE: This must be a user who has been assigned the `kibana_user` role. include::authentication/index.asciidoc[] include::securing-communications/index.asciidoc[] include::audit-logging.asciidoc[] -include::{kib-repo-dir}/settings/security-settings.asciidoc[] diff --git a/docs/settings/apm-settings.asciidoc b/docs/settings/apm-settings.asciidoc index 0045162ed41b6..615dc98c066ba 100644 --- a/docs/settings/apm-settings.asciidoc +++ b/docs/settings/apm-settings.asciidoc @@ -1,8 +1,8 @@ [role="xpack"] [[apm-settings-kb]] -=== APM Settings in Kibana +=== APM settings in Kibana ++++ -APM Settings +APM settings ++++ You do not need to configure any settings to use APM. It is enabled by default. @@ -11,7 +11,7 @@ copy and paste the relevant settings below into your `kibana.yml` configuration [float] [[general-apm-settings-kb]] -==== General APM Settings +==== General APM settings xpack.apm.enabled:: Set to `false` to disabled the APM plugin {kib}. Defaults to `true`. diff --git a/docs/settings/dev-settings.asciidoc b/docs/settings/dev-settings.asciidoc index 880b0a1b9078a..436f169b82ca3 100644 --- a/docs/settings/dev-settings.asciidoc +++ b/docs/settings/dev-settings.asciidoc @@ -1,8 +1,8 @@ [role="xpack"] [[dev-settings-kb]] -=== Development Tools Settings in Kibana +=== Development tools settings in Kibana ++++ -Development Tools Settings +Development tools settings ++++ You do not need to configure any settings to use the development tools in {kib}. @@ -10,7 +10,7 @@ They are enabled by default. [float] [[grok-settings]] -==== Grok Debugger Settings +==== Grok Debugger settings `xpack.grokdebugger.enabled`:: Set to `true` (default) to enable the <>. diff --git a/docs/settings/graph-settings.asciidoc b/docs/settings/graph-settings.asciidoc index 7a1c425b3614c..7e597362b1cfc 100644 --- a/docs/settings/graph-settings.asciidoc +++ b/docs/settings/graph-settings.asciidoc @@ -1,14 +1,14 @@ [role="xpack"] [[graph-settings-kb]] -=== Graph Settings in Kibana +=== Graph settings in Kibana ++++ -Graph Settings +Graph settings ++++ -You do not need to configure any settings to use {graph}. +You do not need to configure any settings to use the {graph-features}. [float] [[general-graph-settings]] -==== General Graph Settings +==== General graph settings `xpack.graph.enabled`:: -Set to `false` to disable {graph}. +Set to `false` to disable the {graph-features}. diff --git a/docs/settings/infrastructure-ui-settings.asciidoc b/docs/settings/infrastructure-ui-settings.asciidoc index bfecabbf101ff..3d7180f7a7575 100644 --- a/docs/settings/infrastructure-ui-settings.asciidoc +++ b/docs/settings/infrastructure-ui-settings.asciidoc @@ -1,14 +1,14 @@ [role="xpack"] [[infrastructure-ui-settings-kb]] -=== Infrastructure UI Settings in Kibana +=== Infrastructure UI settings in Kibana ++++ -Infrastructure UI Settings +Infrastructure UI settings ++++ You do not need to configure any settings to use the Infrastructure UI. It is enabled by default. [float] [[general-infra-ui-settings-kb]] -==== General Infrastructure UI Settings +==== General Infrastructure UI settings include::general-infra-logs-ui-settings.asciidoc[] \ No newline at end of file diff --git a/docs/settings/logs-ui-settings.asciidoc b/docs/settings/logs-ui-settings.asciidoc index fbe81435a8109..a2c9e12e22fb0 100644 --- a/docs/settings/logs-ui-settings.asciidoc +++ b/docs/settings/logs-ui-settings.asciidoc @@ -1,14 +1,14 @@ [role="xpack"] [[logs-ui-settings-kb]] -=== Logs UI Settings in Kibana +=== Logs UI settings in Kibana ++++ -Logs UI Settings +Logs UI settings ++++ You do not need to configure any settings to use the Logs UI. It is enabled by default. [float] [[general-logs-ui-settings-kb]] -==== General Logs UI Settings +==== General Logs UI settings include::general-infra-logs-ui-settings.asciidoc[] diff --git a/docs/settings/ml-settings.asciidoc b/docs/settings/ml-settings.asciidoc index ec051a9ec4899..6528568e86890 100644 --- a/docs/settings/ml-settings.asciidoc +++ b/docs/settings/ml-settings.asciidoc @@ -1,20 +1,21 @@ [role="xpack"] [[ml-settings-kb]] -=== Machine Learning Settings in Kibana +=== Machine learning settings in Kibana ++++ -Machine Learning Settings +Machine learning settings ++++ -You do not need to configure any settings to use {ml}. It is enabled by default. +You do not need to configure any settings to use {kib} {ml-features}. They are +enabled by default. [float] [[general-ml-settings-kb]] -==== General Machine Learning Settings +==== General {ml} settings `xpack.ml.enabled`:: -Set to `true` (default) to enable {ml}. + +Set to `true` (default) to enable {kib} {ml-features}. + + If set to `false` in `kibana.yml`, the {ml} icon is hidden in this {kib} instance. If `xpack.ml.enabled` is set to `true` in `elasticsearch.yml`, however, you can still use the {ml} APIs. To disable {ml} entirely, see the -{ref}/ml-settings.html[{es} Machine Learning Settings]. +{ref}/ml-settings.html[{es} {ml} settings]. diff --git a/docs/settings/monitoring-settings.asciidoc b/docs/settings/monitoring-settings.asciidoc index 7710970cd6fe8..03c990d048a4e 100644 --- a/docs/settings/monitoring-settings.asciidoc +++ b/docs/settings/monitoring-settings.asciidoc @@ -1,8 +1,8 @@ [role="xpack"] [[monitoring-settings-kb]] -=== Monitoring Settings in Kibana +=== Monitoring settings in Kibana ++++ -Monitoring Settings +Monitoring settings ++++ By default, the Monitoring application is enabled, but data collection @@ -25,14 +25,14 @@ from Logstash, you configure in `logstash.yml`. For more information, see -{xpack-ref}/xpack-monitoring.html[Monitoring the Elastic Stack]. +{stack-ov}/xpack-monitoring.html[Monitoring the Elastic Stack]. [float] [[monitoring-general-settings]] -==== General Monitoring Settings +==== General monitoring settings `xpack.monitoring.enabled`:: -Set to `true` (default) to enable {monitoring} in {kib}. Unlike the +Set to `true` (default) to enable the {monitor-features} in {kib}. Unlike the `xpack.monitoring.ui.enabled` setting, when this setting is `false`, the monitoring back-end does not run and {kib} stats are not sent to the monitoring cluster. @@ -68,7 +68,7 @@ which has a default value of `30000`. [float] [[monitoring-collection-settings]] -==== Monitoring Collection Settings +==== Monitoring collection settings These settings control how data is collected from {kib}. @@ -84,7 +84,7 @@ Defaults to `10000` (10 seconds). [float] [[monitoring-ui-settings]] -==== Monitoring UI Settings +==== Monitoring UI settings These settings adjust how the {kib} Monitoring page displays monitoring data. However, the defaults work best in most circumstances. For more information @@ -111,7 +111,7 @@ value in this setting. [float] [[monitoring-ui-cgroup-settings]] -===== Monitoring UI Container Settings +===== Monitoring UI container settings The Monitoring UI exposes the Cgroup statistics that we collect for you to make better decisions about your container performance, rather than guessing based on diff --git a/docs/settings/reporting-settings.asciidoc b/docs/settings/reporting-settings.asciidoc index 81e7c4ef72b0b..209993ede94fe 100644 --- a/docs/settings/reporting-settings.asciidoc +++ b/docs/settings/reporting-settings.asciidoc @@ -1,21 +1,21 @@ [role="xpack"] [[reporting-settings-kb]] -=== {reporting} settings in Kibana +=== Reporting settings in Kibana ++++ -Reporting Settings +Reporting settings ++++ You can configure `xpack.reporting` settings in your `kibana.yml` to: -* <> +* <> * <> * <> [float] [[general-reporting-settings]] -==== General Reporting Settings +==== General reporting settings [[xpack-enable-reporting]]`xpack.reporting.enabled`:: -Set to `false` to disable {reporting}. +Set to `false` to disable the {report-features}. `xpack.reporting.encryptionKey`:: Set to any text string. By default, Kibana will generate a random key when it @@ -24,7 +24,7 @@ setting to preserve the same key across multiple restarts and multiple instances [float] [[reporting-kibana-server-settings]] -==== Kibana Server Settings +==== Kibana server settings Reporting uses the Kibana interface to generate reports. In most cases, you don't need to configure Reporting to communicate with Kibana. However, if you use a reverse-proxy @@ -44,7 +44,7 @@ proxy host requires that the Kibana server has network access to the proxy. [float] [[reporting-job-queue-settings]] -==== Background Job Settings +==== Background job settings Reporting generates reports in the background and jobs are coordinated using documents in Elasticsearch. Depending on how often you generate reports and the overall number of @@ -78,7 +78,7 @@ Defaults to `120000` (two minutes). [float] [[reporting-capture-settings]] -==== Capture Settings +==== Capture settings Reporting works by capturing screenshots from Kibana. The following settings control the capturing process. @@ -96,7 +96,7 @@ backward compatibility. The only valid option is `chromium`. [float] [[reporting-chromium-settings]] -==== Chromium Settings +==== Chromium settings When `xpack.reporting.capture.browser.type` is set to `chromium` (default) you can also specify the following settings. @@ -120,7 +120,7 @@ Examples of valid entries are "elastic.co", "*.elastic.co", ".elastic.co", ".ela [float] [[reporting-csv-settings]] -==== CSV Settings +==== CSV settings [[xpack-reporting-csv]]`xpack.reporting.csv.maxSizeBytes`:: The maximum size of a CSV file before being truncated. This setting exists to prevent large exports from causing performance and storage issues. @@ -128,7 +128,7 @@ Defaults to `10485760` (10mB) [float] [[reporting-advanced-settings]] -==== Advanced Settings +==== Advanced settings `xpack.reporting.index`:: Reporting uses a weekly index in Elasticsearch to store the reporting job and diff --git a/docs/settings/security-settings.asciidoc b/docs/settings/security-settings.asciidoc index a14368e5cbd98..1f724d7e3a3f1 100644 --- a/docs/settings/security-settings.asciidoc +++ b/docs/settings/security-settings.asciidoc @@ -1,21 +1,22 @@ [role="xpack"] [[security-settings-kb]] -=== Security Settings in Kibana +=== Security settings in Kibana ++++ -Security Settings +Security settings ++++ -You do not need to configure any additional settings to use {security} in {kib}. -It is enabled by default. +You do not need to configure any additional settings to use the +{security-features} in {kib}. They are enabled by default. [float] [[general-security-settings]] -==== General Security Settings +==== General security settings + `xpack.security.enabled`:: -Set to `true` (default) to enable {security}. + +Set to `true` (default) to enable {security-features}. + + -Do not set this to `false`. To disable {security} entirely, see -{ref}/security-settings.html[{es} Security Settings]. + +Do not set this to `false`. To disable {security-features} entirely, see +{ref}/security-settings.html[{es} security settings]. + + If set to `false` in `kibana.yml`, the login form, user and role management screens, and authorization using <> are disabled. + @@ -30,7 +31,7 @@ for more details. [float] [[security-ui-settings]] -==== User Interface Security Settings +==== User interface security settings You can configure the following settings in the `kibana.yml` file: diff --git a/docs/settings/settings-xkb.asciidoc b/docs/settings/settings-xkb.asciidoc deleted file mode 100644 index 98e2784bbb0a8..0000000000000 --- a/docs/settings/settings-xkb.asciidoc +++ /dev/null @@ -1,19 +0,0 @@ -[role="xpack"] -[[settings-xpack-kb]] -== {xpack} Settings in {kib} -++++ -{xpack} Settings -++++ - -include::{asciidoc-dir}/../../shared/settings.asciidoc[] - -For more {kib} configuration settings, see <>. - -include::apm-settings.asciidoc[] -include::dev-settings.asciidoc[] -include::graph-settings.asciidoc[] -include::infrastructure-ui-settings.asciidoc[] -include::logs-ui-settings.asciidoc[] -include::ml-settings.asciidoc[] -include::reporting-settings.asciidoc[] -include::spaces-settings.asciidoc[] diff --git a/docs/settings/ssl-settings.asciidoc b/docs/settings/ssl-settings.asciidoc index a80f4d5d7efa6..4344625833947 100644 --- a/docs/settings/ssl-settings.asciidoc +++ b/docs/settings/ssl-settings.asciidoc @@ -1,5 +1,5 @@ [float] -=== {component} TLS/SSL Settings +=== {component} TLS/SSL settings You can configure the following TLS/SSL settings. If the settings are not configured, the default values are used. See {stack-ov}/security-settings.html[Default TLS/SSL Settings]. @@ -40,7 +40,7 @@ Java Cryptography Architecture documentation]. Defaults to the value of `xpack.ssl.cipher_suites`. [float] -==== {component} TLS/SSL Key and Trusted Certificate Settings +==== {component} TLS/SSL key and trusted certificate settings The following settings are used to specify a private key, certificate, and the trusted certificates that should be used when communicating over an SSL/TLS connection. @@ -58,7 +58,7 @@ If none of the settings below are specified, the defaults values are used. See {stack-ov}/security-settings.html[Default TLS/SSL settings]. [float] -===== PEM Encoded Files +===== PEM encoded files When using PEM encoded files, use the following settings: @@ -77,7 +77,7 @@ that will be presented when requested. List of paths to the PEM encoded certificate files that should be trusted. [float] -===== Java Keystore Files +===== Java keystore files When using Java keystore files (JKS), which contain the private key, certificate and certificates that should be trusted, use the following settings: diff --git a/docs/setup.asciidoc b/docs/setup.asciidoc index c226e24f49ffb..ae0e72ed4c649 100644 --- a/docs/setup.asciidoc +++ b/docs/setup.asciidoc @@ -52,8 +52,6 @@ include::setup/start-stop.asciidoc[] include::setup/settings.asciidoc[] -include::setup/secure-settings.asciidoc[] - include::setup/docker.asciidoc[] include::setup/access.asciidoc[] diff --git a/docs/setup/secure-settings.asciidoc b/docs/setup/secure-settings.asciidoc index 39f3633163899..a7ccd3f77405e 100644 --- a/docs/setup/secure-settings.asciidoc +++ b/docs/setup/secure-settings.asciidoc @@ -1,5 +1,5 @@ [[secure-settings]] -=== Secure Settings +=== Secure settings Some settings are sensitive, and relying on filesystem permissions to protect their values is not sufficient. For this use case, Kibana provides a diff --git a/docs/setup/settings.asciidoc b/docs/setup/settings.asciidoc index dfee525b49a25..9574667a001fc 100644 --- a/docs/setup/settings.asciidoc +++ b/docs/setup/settings.asciidoc @@ -11,7 +11,7 @@ The default settings configure Kibana to run on `localhost:5601`. To change the host or port number, or connect to Elasticsearch running on a different machine, you'll need to update your `kibana.yml` file. You can also enable SSL and set a variety of other options. Finally, environment variables can be injected into configuration using `${MY_ENV_VAR}` syntax. -.Kibana Configuration Settings +.Kibana configuration settings `console.enabled:`:: *Default: true* Set to false to disable Console. Toggling this will cause the server to regenerate assets on the next startup, which may cause a delay before pages start being served. @@ -181,4 +181,16 @@ unauthenticated users to access the Kibana server status API and status page. `xpack.rollup.enabled:`:: *Default: true* Set this value to false to disable the Rollup user interface. -`xpack.license_management.enabled`:: *Default: true* Set this value to false to disable the License Management user interface. \ No newline at end of file +`xpack.license_management.enabled`:: *Default: true* Set this value to false to disable the License Management user interface. + +include::{docdir}/settings/apm-settings.asciidoc[] +include::{docdir}/settings/dev-settings.asciidoc[] +include::{docdir}/settings/graph-settings.asciidoc[] +include::{docdir}/settings/infrastructure-ui-settings.asciidoc[] +include::{docdir}/settings/logs-ui-settings.asciidoc[] +include::{docdir}/settings/ml-settings.asciidoc[] +include::{docdir}/settings/monitoring-settings.asciidoc[] +include::{docdir}/settings/reporting-settings.asciidoc[] +include::secure-settings.asciidoc[] +include::{docdir}/settings/security-settings.asciidoc[] +include::{docdir}/settings/spaces-settings.asciidoc[]