Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Breaking] Remove deprecated enabled settings from plugins. #113495

Merged
merged 23 commits into from
Oct 17, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
2c0206b
Update docs to remove references to settings.
lukeelmers Sep 30, 2021
a9ad5a1
Remove explicit 'enabled' settings from plugins.
lukeelmers Sep 30, 2021
ce8e195
Remove docker env vars.
lukeelmers Sep 30, 2021
d7a2516
Update config service to stop implicitly adding an 'enabled' config.
lukeelmers Sep 30, 2021
e83aaaf
Remove functional_vis_wizard test suite.
lukeelmers Sep 30, 2021
767b358
Remove old configuration from api_integration test config.
lukeelmers Sep 30, 2021
2607fe8
Remove old configuration from case_api_integration test config.
lukeelmers Sep 30, 2021
5b63628
Remove disable-able plugins from detection_engine_api_integration tes…
lukeelmers Sep 30, 2021
09c893a
Remove old configuration from fleet_functional test config.
lukeelmers Sep 30, 2021
00e6489
Remove old configuration from plugin_functional test config.
lukeelmers Sep 30, 2021
10d1067
Remove old configuration from saved_objects_field_count test config.
lukeelmers Sep 30, 2021
aef646b
Try removing the top-level monitoring/enterpriseSearch configs from FTR.
lukeelmers Oct 1, 2021
8b19bcd
Add 8.0 breaking changes docs.
lukeelmers Oct 5, 2021
ed6bf9d
Fix error handling for plugins without config schemas.
lukeelmers Oct 7, 2021
1acd603
Fix plugin service jest tests.
lukeelmers Oct 9, 2021
d838308
Remove unnecessary configPath entries from x-pack test plugins.
lukeelmers Oct 10, 2021
32ac98d
Avoid mocking isEnabledAtPath in jest test.
lukeelmers Oct 10, 2021
35569da
Revert console changes.
lukeelmers Oct 13, 2021
a7912a1
Revert all stack management changes.
lukeelmers Oct 14, 2021
577400b
Remove extra notable-breaking-changes tag in docs.
lukeelmers Oct 15, 2021
e857477
Merge branch 'master' into feat/remove-disableable-plugins
kibanamachine Oct 15, 2021
1cc6a0b
Merge branch 'master' into feat/remove-disableable-plugins
kibanamachine Oct 16, 2021
6db727d
Merge branch 'master' into feat/remove-disableable-plugins
kibanamachine Oct 17, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 0 additions & 10 deletions docs/dev-tools/console/console.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -129,13 +129,3 @@ image::dev-tools/console/images/console-settings.png["Console Settings", width=6

For a list of available keyboard
shortcuts, click *Help*.

[float]
[[console-settings]]
=== Disable Console

deprecated:[7.16.0,"In 8.0 and later, this setting will no longer be supported."]
If you don’t want to use *Console*, you can disable it by setting `console.enabled`
to `false` in your `kibana.yml` configuration file. Changing this setting
causes the server to regenerate assets on the next startup,
which might cause a delay before pages start being served.
11 changes: 9 additions & 2 deletions docs/migration/migrate_8_0.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ See also <<whats-new>> and <<release-notes>>.
//NOTE: The notable-breaking-changes tagged regions are re-used in the
//Installation and Upgrade Guide

// tag::notable-breaking-changes[]
[float]
[[breaking_80_index_pattern_changes]]
=== Index pattern changes
Expand All @@ -30,18 +31,24 @@ to function as expected. Support for these index patterns has been removed in 8.
*Impact:* You must migrate your time_based index patterns to a wildcard pattern,
for example, `logstash-*`.


[float]
[[breaking_80_setting_changes]]
=== Settings changes

// tag::notable-breaking-changes[]
[float]
==== Multitenancy by changing `kibana.index` is no longer supported
*Details:* `kibana.index`, `xpack.reporting.index` and `xpack.task_manager.index` can no longer be specified.

*Impact:* Users who relied on changing these settings to achieve multitenancy should use *Spaces*, cross-cluster replication, or cross-cluster search instead. To migrate to *Spaces*, users are encouraged to use saved object management to export their saved objects from a tenant into the default tenant in a space. Improvements are planned to improve on this workflow. See https://github.com/elastic/kibana/issues/82020 for more details.

[float]
==== Disabling most plugins with the `{plugin_name}.enabled` setting is no longer supported
*Details:* The ability for most plugins to be disabled using the `{plugin_name}.enabled` config option has been removed.

*Impact:* Some plugins, such as `telemetry`, `newsfeed`, `reporting`, and the various `vis_type` plugins will continue to support this setting, however the rest of the plugins that ship with Kibana will not. By default, any newly created plugins will not support this configuration unless it is explicitly added to the plugin's `configSchema`.

If you are currently using one of these settings in your Kibana config, please remove it before upgrading to 8.0. If you were using these settings to control user access to certain Kibana applications, we recommend leveraging Feature Controls instead.

[float]
==== Legacy browsers are now rejected by default
*Details:* `csp.strict` is now enabled by default, so Kibana will fail to load for older, legacy browsers that do not enforce basic Content Security Policy protections - notably Internet Explorer 11.
Expand Down
4 changes: 0 additions & 4 deletions docs/settings/apm-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,6 @@ Changing these settings may disable features of the APM App.

[cols="2*<"]
|===
| `xpack.apm.enabled` {ess-icon}
| deprecated:[7.16.0,"In 8.0 and later, this setting will no longer be supported."]
Set to `false` to disable the APM app. Defaults to `true`.

| `xpack.apm.maxServiceEnvironments` {ess-icon}
| Maximum number of unique service environments recognized by the UI. Defaults to `100`.

Expand Down
34 changes: 0 additions & 34 deletions docs/settings/dev-settings.asciidoc

This file was deleted.

3 changes: 0 additions & 3 deletions docs/settings/fleet-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,6 @@ See the {fleet-guide}/index.html[{fleet}] docs for more information.

[cols="2*<"]
|===
| `xpack.fleet.enabled` {ess-icon}
| deprecated:[7.16.0,"In 8.0 and later, this setting will no longer be supported."]
Set to `true` (default) to enable {fleet}.
| `xpack.fleet.agents.enabled` {ess-icon}
| Set to `true` (default) to enable {fleet}.
|===
Expand Down
4 changes: 0 additions & 4 deletions docs/settings/general-infra-logs-ui-settings.asciidoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@

`xpack.infra.enabled`::
deprecated:[7.16.0,"In 8.0 and later, this setting will no longer be supported."]
Set to `false` to disable the Logs and Metrics app plugin {kib}. Defaults to `true`.

`xpack.infra.sources.default.logAlias`::
Index pattern for matching indices that contain log data. Defaults to `filebeat-*,kibana_sample_data_logs*`. To match multiple wildcard patterns, use a comma to separate the names, with no space after the comma. For example, `logstash-app1-*,default-logs-*`.

Expand Down
12 changes: 0 additions & 12 deletions docs/settings/graph-settings.asciidoc

This file was deleted.

26 changes: 0 additions & 26 deletions docs/settings/ml-settings.asciidoc

This file was deleted.

7 changes: 0 additions & 7 deletions docs/settings/monitoring-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,6 @@ For more information, see

[cols="2*<"]
|===
| `monitoring.enabled`
| deprecated:[7.16.0,"In 8.0 and later, this setting will no longer be supported."]
Set to `true` (default) to enable the {monitor-features} in {kib}. Unlike the
<<monitoring-ui-enabled, `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.

| `monitoring.ui.ccs.enabled`
| Set to `true` (default) to enable {ref}/modules-cross-cluster-search.html[cross-cluster search] of your monitoring data. The {ref}/modules-remote-clusters.html#remote-cluster-settings[`remote_cluster_client`] role must exist on each node.

Expand Down
3 changes: 0 additions & 3 deletions docs/settings/settings-xkb.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,8 @@ For more {kib} configuration settings, see <<settings>>.
include::alert-action-settings.asciidoc[]
include::apm-settings.asciidoc[]
include::banners-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[]
include::task-manager-settings.asciidoc[]
Expand Down
4 changes: 0 additions & 4 deletions docs/settings/url-drilldown-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@ Configure the URL drilldown settings in your `kibana.yml` configuration file.

[cols="2*<"]
|===
| [[url-drilldown-enabled]] `url_drilldown.enabled`
| deprecated:[7.16.0,"In 8.0 and later, this setting will no longer be supported."]
When `true`, enables URL drilldowns on your {kib} instance.

| [[external-URL-policy]] `externalUrl.policy`
| Configures the external URL policies. URL drilldowns respect the global *External URL* service, which you can use to deny or allow external URLs.
By default all external URLs are allowed.
Expand Down
23 changes: 6 additions & 17 deletions docs/setup/settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,12 @@ configuration using `${MY_ENV_VAR}` syntax.
[cols="2*<"]
|===

| `console.enabled:`
| deprecated:[7.16.0,"In 8.0 and later, this setting will no longer be supported."]
Toggling this causes the server to regenerate assets on the next startup,
which may cause a delay before pages start being served.
Set to `false` to disable Console. *Default: `true`*
| `csp.rules:`
| deprecated:[7.14.0,"In 8.0 and later, this setting will no longer be supported."]
A https://w3c.github.io/webappsec-csp/[Content Security Policy] template
that disables certain unnecessary and potentially insecure capabilities in
the browser. It is strongly recommended that you keep the default CSP rules
that ship with {kib}.

| `csp.script_src:`
| Add sources for the https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/script-src[Content Security Policy `script-src` directive].
Expand Down Expand Up @@ -688,15 +689,6 @@ sources and images. When false, Vega can only get data from {es}. *Default: `fal
`exploreDataInChart.enabled`
| Enables you to view the underlying documents in a data series from a dashboard panel. *Default: `false`*

| `xpack.license_management.enabled`
| deprecated:[7.16.0,"In 8.0 and later, this setting will no longer be supported."]
Set this value to false to disable the License Management UI.
*Default: `true`*

| `xpack.rollup.enabled:`
| deprecated:[7.16.0,"In 8.0 and later, this setting will no longer be supported."]
Set this value to false to disable the Rollup UI. *Default: true*

| `i18n.locale` {ess-icon}
| Set this value to change the {kib} interface language.
Valid locales are: `en`, `zh-CN`, `ja-JP`. *Default: `en`*
Expand All @@ -706,14 +698,11 @@ Valid locales are: `en`, `zh-CN`, `ja-JP`. *Default: `en`*
include::{kib-repo-dir}/settings/alert-action-settings.asciidoc[]
include::{kib-repo-dir}/settings/apm-settings.asciidoc[]
include::{kib-repo-dir}/settings/banners-settings.asciidoc[]
include::{kib-repo-dir}/settings/dev-settings.asciidoc[]
include::{kib-repo-dir}/settings/graph-settings.asciidoc[]
include::{kib-repo-dir}/settings/fleet-settings.asciidoc[]
include::{kib-repo-dir}/settings/i18n-settings.asciidoc[]
include::{kib-repo-dir}/settings/logging-settings.asciidoc[]
include::{kib-repo-dir}/settings/logs-ui-settings.asciidoc[]
include::{kib-repo-dir}/settings/infrastructure-ui-settings.asciidoc[]
include::{kib-repo-dir}/settings/ml-settings.asciidoc[]
include::{kib-repo-dir}/settings/monitoring-settings.asciidoc[]
include::{kib-repo-dir}/settings/reporting-settings.asciidoc[]
include::secure-settings.asciidoc[]
Expand Down
17 changes: 0 additions & 17 deletions docs/user/plugins.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -145,23 +145,6 @@ You can also remove a plugin manually by deleting the plugin's subdirectory unde

NOTE: Removing a plugin will result in an "optimize" run which will delay the next start of {kib}.

[float]
[[disable-plugin]]
== Disable plugins

deprecated:[7.16.0,"In 8.0 and later, this setting will only be supported for a subset of plugins that have opted in to the behavior."]

Use the following command to disable a plugin:

[source,shell]
-----------
./bin/kibana --<plugin ID>.enabled=false <1>
-----------

NOTE: Disabling or enabling a plugin will result in an "optimize" run which will delay the start of {kib}.

<1> You can find a plugin's plugin ID as the value of the `name` property in the plugin's `kibana.json` file.

[float]
[[configure-plugin-manager]]
== Configure the plugin manager
Expand Down
Loading