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

Removes unused and renamed deprecated core settings and deprecated settings from core plugins #113653

Merged

Conversation

TinaHeiligers
Copy link
Contributor

@TinaHeiligers TinaHeiligers commented Oct 1, 2021

Related to #103915

Currently blocked by https://github.com/elastic/cloud/issues/89185 (for settings handled in this PR).

To reviewers:
If your team was pinged it means we needed to update one or more files in your domain.
Please filter the files and review changes that needed to be made.

Core team: There will be follow up PRs to handle the remaining core deprecations as these will likely require some further discussion.

During the 7 series, we added deprecations for configuration settings that were going to be removed in 8.0.

This PR removes support for the following configuration settings and adds documentation on breaking changes as needed:

setting deprecation type deprecation version breaking changes documented requires cloud kibana template change requires docker config change
newsfeed.defaultLanguage unused 7.9.0 yes no no
xpack.banners.placement value change from 'header' to 'top' 7.13.0 yes no no
cpu.cgroup.path.override rename to ops.cGroupOverrides.cpuPath 7.10.0 yes no yes
cpuacct.cgroup.path.override rename to ops.cGroupOverrides.cpuAcctPath 7.10.0 yes no yes
server.xsrf.whitelist rename to server.xsrf.allowlist 7.11.0 yes no yes
KIBANA_PATH_CONF rename to KBN_PATH_CONF 7.16.0 no (not documented before rename) no no
kibana.disableWelcomeScreen rename to home.disableWelcomeScreen 7.7.0 no no no
ui_metric.enabled rename to usageCollection.uiCounters.enabled 7.11.0 no no no
ui_metric.debug rename to usageCollection.uiCounters.debug 7.11.0 no no no
usageCollection.uiMetric.enabled rename to usageCollection.uiCounters.enabled 7.11.0 no no no
usageCollection.uiMetric.debug rename to usageCollection.uiCounters.debug 7.11.0 no no no
xpack.xpack_main.xpack_api_polling_frequency_millis rename to xpack.licensing.api_polling_frequency 7.6.0 no (Reason: Deprecated setting isn't documented, neither is the new setting) yes no

Additional changes:

  • server.cors deprecation remains but changed from level:critical to level:warning on recommendation from @kibana-security

Checklist

For maintainers

Release note:

The deprecation notice for server.cors has changed from level:critical to level:warning.

Support for the following deprecated configuration settings has been removed:

  • newsfeed.defaultLanguage is no longer used. Newsfeed items will be retrieved based on the browser locale and default to English.
  • xpack.banners.placement has changed value from 'header' to 'top'
  • cpu.cgroup.path.override is no longer valid and has been replaced with ops.cGroupOverrides.cpuPath
  • cpuacct.cgroup.path.override is no longer valid and has been replaced with ops.cGroupOverrides.cpuAcctPath
  • server.xsrf.whitelist is no longer valid and has been replaced with server.xsrf.allowlist
  • xpack.xpack_main.xpack_api_polling_frequency_millis is no longer valid and has been replace with xpack.licensing.api_polling_frequency
  • KIBANA_PATH_CONF is no longer valid. Going forward, set the path to the Kibana configuration file using the KBN_PATH_CONF environment variable.

@TinaHeiligers TinaHeiligers added release_note:breaking v8.0.0 backport:skip This commit does not require backporting Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc labels Oct 1, 2021
@TinaHeiligers TinaHeiligers marked this pull request as ready for review October 1, 2021 21:14
@TinaHeiligers TinaHeiligers requested review from a team as code owners October 1, 2021 21:14
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-core (Team:Core)

Copy link
Member

@jbudz jbudz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

KIBANA_PATH_CONF and kibana-docker changes LGTM

@@ -16,18 +16,22 @@ function collectDeprecations(
) {
const deprecations = provider(configDeprecationFactory);
const deprecationMessages: string[] = [];
const deprecationLevels: string[] = [];
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needed to test changing the rewriteCorsSetting level from critical to warning.

@@ -39,23 +39,4 @@ export type BannersConfigType = TypeOf<typeof configSchema>;
export const config: PluginConfigDescriptor<BannersConfigType> = {
schema: configSchema,
exposeToBrowser: {},
deprecations: () => [
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The unit tests only tested deprecations.

@@ -364,4 +364,34 @@ Configuration management tools and automation will need to be updated to use the
=== `server.xsrf.token` is no longer valid
*Details:* The deprecated `server.xsrf.token` setting in the `kibana.yml` file has been removed.

[float]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I only added breaking changes for the settings that are documented.

@TinaHeiligers
Copy link
Contributor Author

@elasticmachine merge upstream

@kibanamachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

Copy link
Contributor

@jonathan-buttner jonathan-buttner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code changes look good for cases.

Copy link
Contributor

@pgayvallet pgayvallet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@TinaHeiligers TinaHeiligers merged commit 67be0a8 into elastic:master Oct 5, 2021
@TinaHeiligers TinaHeiligers deleted the config-breaking/remove-deprecations branch October 5, 2021 19:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting release_note:breaking Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants