-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
Log deprecation warnings for plugins which will no longer be disable-able in 8.0 #111890
Log deprecation warnings for plugins which will no longer be disable-able in 8.0 #111890
Conversation
@elasticmachine merge upstream |
@elasticmachine merge upstream |
Sorry folks, Github seems to be confused now that I'll go ahead and close this PR and open a new one. |
Replacement PR: #112602 |
💔 Build Failed
Failed CI StepsTest FailuresKibana Pipeline / general / Jest Integration Tests.packages/kbn-plugin-helpers/src/integration_tests.builds a generated plugin into a viable archiveStandard Out
Stack Trace
Metrics [docs]Public APIs missing comments
Async chunks
Page load bundle
Saved Objects .kibana field count
History
To update your PR or re-run it, just comment with: cc @lukeelmers |
NOTE: This PR was replaced by #112602
Closes #110614
Notes if you are pinged for a CODEOWNERS review
This PR moves forward with the plan outlined in #89584 to remove the ability for plugins to be disable-able by default in 8.0.
If you are tagged for a review here, it is for one of the following reasons:
enabled
property in your config schema, so a deprecation has been added for it.enabled
property but does not have a config schema, however you had indicated you need to preserve the ability to disable it (e.g.vis_type_*
plugins). In this case an explicit config has been added for you.The good news is that most likely you'll only need to review one or two lines of code 🙂
To test the deprecations:
<my-plugin>.enabled: true
<my-plugin>.enabled: false
I also tried to find any documentation that referred to a plugin with an
.enabled
property. If the docs for your app have been changed, please give them a look. (Preview: https://kibana_111890.docs-preview.app.elstc.co/diff)This change will be backported to 7.16. In a follow-up PR, we will implement the actual 8.0 breaking change by removing the deprecated config.
Notes for Core Team
The approach here does the following:
.enabled
config that's implicitly added (i.e., plugins which currently have no config schema)vis_type_*
plugins which currently don't have one but will need to keep an.enabled
config in 8.0.enabled
config that's explicitly added in their config schemadeprecate
anddeprecateFromRoot
to theConfigDeprecationFactory
.enabled
properties.I went with this approach because:
.enabled
property in 8.0, so this is just a precursor to that PR.enabled
property are unaffected.enabled
property moving forward, they just add it to their config schemaHowever, I'm still open to feedback on alternatives.
Release note
Deprecates the ability for most plugins to be disabled using the
{plugin_name}.enabled
config option. In 8.0, most Kibana plugins can no longer be disabled using this option. Plugin developers can still opt-in to this feature by explicitly adding an.enabled
property to their config schema.If you are currently using one of these options in your Kibana config, please remove it before upgrading to 8.0.