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

[Meta] 8.0 Kibana deprecations #109166

Closed
cjcenizal opened this issue Aug 18, 2021 · 7 comments
Closed

[Meta] 8.0 Kibana deprecations #109166

cjcenizal opened this issue Aug 18, 2021 · 7 comments
Labels
Feature:Upgrade Assistant Meta Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more

Comments

@cjcenizal
Copy link
Contributor

cjcenizal commented Aug 18, 2021

We'll use this issue to track 8.0 Kibana deprecations, to ensure a smooth 8.0 upgrade experience.

Example

For an example PR of how to design and register a deprecation, please see #110960. This deprecation is awesome because it:

  • Targets 7.x
  • Requests review from copy-writers
  • Handles errors when the deprecation can't retrieve the necessary data to register itself
  • Covers the deprecations with automated tests
  • Was tested manually in Upgrade Assistant

Creating deprecations

Target 7.x

When creating a deprecation, target the 7.x branch with your PR. Upgrade Assistant is enabled for 7.16, but continues to be disabled for 8.0. UA is currently designed solely for major upgrades, not upgrades between minors.

Use the Core Deprecations API

The Core Deprecations API is the engine that drives Upgrade Assistant's Kibana-specific functionality. For questions, reach out to @elastic/kibana-core.

Write great copy

@debadair and @gchaps have created copywriting guidelines how to write good copy for your deprecations. Please consult them with questions.

Include relevant links

Provide links to docs wherever possible.

Specify the correct level

Deprecations with level: 'critical' will block the upgrade until they're addressed. Deprecations with level: 'warning' will not.

Add steps for testing to your PR

This helps the Stack Management and QA teams double-check the UX and ensure the new UA features work well with your deprecation.

Add screenshots of how the deprecation appears in UA to your PR

Same as above.

Test your deprecation in Upgrade Assistant

This goes without saying, but please open Upgrade Assistant and follow your steps for testing yourself. Please also test your remediation steps to identify and smooth over any rough edges in this process.

Deprecations list

Alerting

@elastic/kibana-alerting-services

Deprecation Issue Done Tested with 7.16
Deprecate ability to disable alerting, actions, task manager, stack alerts, and event log plugins #108396 #108281
Deprecate xpack.task_manager.index setting #82524 #84155

APM

@elastic/apm-ui

Deprecation Issue Done Tested with 7.16
[APM] 8.0 breaking changes #83256 🔴

Core

@elastic/kibana-core

Deprecation Issue Done Tested with 7.16
[Breaking change] Logging configuration format change #84363
[Breaking change] Move xpack.telemetry.* config to telemetry.* #82432

Operations

@elastic/kibana-operations

Deprecation Issue Done Tested with 7.16
[Breaking change] Remove deprecated environment variables CONFIG_PATH and DATA_PATH #111535 🔴
Require saved-object IDs to be unique across all spaces
Remove support for legacy logging system #50660
Change format of system logs #50660
Remove support for importing Saved Object exports made in 6.x #103921
Remove support for accessing the Kibana index outside Kibana #81536
Remove legacy multi-tenancy https://github.com/elastic/dev/issues/1538
Breaking the api/status API Response format, by default #94419
Remove api/settings route #105695
Remove process field from /stats API #104124
Hang on Kibana startup if Elasticsearch does not have scripting enabled #96106

Geo

@elastic/kibana-gis

Deprecation Issue Done Tested with 7.16
[Breaking change] Remove proxyElasticMapsServiceInMaps yml setting #82132 #103740
[Breaking change] Remove map.regionmap.* kibana.yml settings #81704 #103373
[Breaking change] Remove Coordinate map and region map visualizations #81703 #105981

Kibana App

@elastic/kibana-app

Deprecation Issue Done Tested with 7.16
Remove kibana.defaultAppId #54088 #109798
[Breaking change] Removal of Timelion app (removed in 7.16) #82702 #94845

Kibana Presentation

@elastic/kibana-presentation

Deprecation Issue Done Tested with 7.16
[Breaking change] Dashboard only mode has been removed #81690 🔴

Kibana App Services

@elastic/kibana-app-services

Deprecation Issue Done Tested with 7.16
[Breaking][data.indexPatterns] Remove expression-based scripted fields from Kibana #77669 ✅ Folded into general scripted field deprecation.
[Breaking change] Reporting: remove reporting_user role #92485 #100427
[Breaking change] Reporting: remove support for xpack.reporting.index #101964 #84005
[Breaking] [data.autocomplete] - Migrate core kibana autocomplete configs to data plugin #66085 #100586
[Reporting] Migrate to new ILM policy #81544 #104303

Monitoring

@elastic/stack-monitoring-ui

Deprecation Issue Done Tested with 7.16
[Monitoring] 8.0 Upgrade Assistant #51877
Decided not to move forward with these deprecations. See issue for more context.

Security

@elastic/kibana-security Tested with 7.16 ✅

See #111160

Stack Management

@elastic/kibana-stack-management

Deprecation Issue Done Tested with 7.16
[Breaking change] Add deprecation from removed proxyConfig and proxyFilter Console settings #109872 🔴 🔴
@cjcenizal cjcenizal added Meta Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more Feature:Upgrade Assistant labels Aug 18, 2021
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-stack-management (Team:Stack Management)

@cjcenizal cjcenizal changed the title [Meta] 8.0 Kibana deprecations [Meta] 8.0 Kibana breaking changes Aug 18, 2021
@cjcenizal cjcenizal changed the title [Meta] 8.0 Kibana breaking changes [Meta] 8.0 Kibana deprecations Aug 18, 2021
@cjcenizal
Copy link
Contributor Author

cjcenizal commented Aug 19, 2021

Deprecations in the UI

Here's how a deprecation retrieved from the API will be surfaced in the UI. Note that support for "title" is currently blocked on #99625.

image

@willemdh
Copy link

Multiple Data Paths will be deprecated too apparently... Might be sth worth adding.

@thomasneirynck
Copy link
Contributor

thomasneirynck commented Aug 19, 2021

@elastic/kibana-gis deprecations listed with upgrade assistant

@tsullivan
Copy link
Member

@cjcenizal

[Breaking change] Reporting: remove reporting_user role

We don't have enough good reasoning to completely remove this, which would mean removing support for xpack.reporting.roles.enabled: true.

Still though, we'd like to log deprecations that support will be removed "in a future version" to motivate users to change their config as early as possible.

cc @elastic/kibana-reporting-services @vadimkibana

@Bamieh
Copy link
Member

Bamieh commented Oct 10, 2021

@cjcenizal I've added a details FAQ for deprecations service with examples and a more tailored copy-writing guidelines based on the google doc. https://github.com/elastic/kibana/tree/master/src/core/server/deprecations#writing-deprecation-details

I believe it makes more sense to link it here rather than the google doc as it contains notes about using the service, i18n, and all the best practices we have

@cjcenizal
Copy link
Contributor Author

Looks like everything that's been noted here has been addressed, with the possible exception of some items on the Security team's meta issue (#111160). Thanks for everyone's hard work on this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:Upgrade Assistant Meta Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more
Projects
None yet
Development

No branches or pull requests

6 participants