[Reporting] Use the deprecations service to advise `reporting_user` config changes #100427

tsullivan · 2021-05-20T21:30:56Z

Resolves #92485

Follows: #94966

Summary

The reporting_user role is a legacy solution for granting Reporting feature privilege. In 8.0, the role should no longer be automatically created, and users who have that role should not automatically be granted privilege to generate reports in Kibana. Applications will instead use sub-feature control checks to enable Reporting for privileged users.

This PR uses the deprecations service (#94845) provided by core to register this deprecation. All registered deprecations will be displayed in the Upgrade Assistant (to be implemented via #97159).

Screenshots

Call the API with default (deprecated) config and a reporting_user enabled user:

Call the API with the recommended config change but still with a reporting_user enabled user:

Calling the API with the recommended config change and no reporting_user enabled users will not return any deprecations.

Checklist

Delete any items that are not applicable to this PR.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Unit or functional tests were updated or added to match the most common scenarios

For maintainers

This was checked for breaking API changes and was labeled appropriately

tsullivan · 2021-05-20T21:40:39Z

x-pack/plugins/reporting/server/config/index.ts

-            `starting in 8.0. Please set 'xpack.reporting.roles.enabled' to 'false' and grant reporting privilege to users ` +
-            `through feature controls in Management > Security > Roles`,
+            `starting in 8.0. Please set 'xpack.reporting.roles.enabled' to 'false' and grant reporting privileges to users ` +
+            `using Kibana application privileges **Management > Security > Roles**.`,


Updated this text to match the new text, which felt more refined.

tsullivan · 2021-05-20T21:47:34Z

x-pack/plugins/reporting/server/core.ts

@@ -69,19 +69,17 @@ export class ReportingCore {
  private config?: ReportingConfig; // final config, includes dynamic values based on OS type
  private executing: Set<string>;

-  public getStartContract: () => ReportingStart;
+  public getContract: () => ReportingSetup;


Renamed because we can call this from setup as well - ReportingStart and ReportingSetup are the same interface.

tsullivan · 2021-05-20T21:48:04Z

x-pack/plugins/reporting/server/plugin.ts

@@ -65,6 +64,8 @@ export class ReportingPlugin
      logger: this.logger,
    });

+    registerUiSettings(core);


put all the register* together for cosmetic purposes

elasticmachine · 2021-05-20T22:54:57Z

Pinging @elastic/kibana-app-services (Team:AppServices)

elasticmachine · 2021-05-20T22:54:58Z

Pinging @elastic/kibana-reporting-services (Team:Reporting Services)

…anges

jloleysens

Code changes LGTM also tested this locally, great job @tsullivan 🍻

jloleysens · 2021-05-25T15:57:29Z

x-pack/plugins/reporting/server/deprecations.ts

@@ -0,0 +1,52 @@
+/*


FWIW I am going to be adding a deprecation action soon for migrating existing reporting indices to the new ILM policy - as part of that I'll probably create a depreactions folder and place this inside a file like reporting_user_role.ts. Nothing to action now, we can take the discussion further on that PR.

Sounds good to me, as long as we have correct spelling for deprecations 🙂

Indeed 😄

alisonelizabeth

Code LGTM. Did not test locally.

Great to see a team start to use the deprecations service 🎉 . Feel free to let me or the core team know if you have any feedback on it!

jloleysens · 2021-05-26T09:32:59Z

x-pack/plugins/reporting/server/deprecations.ts

+          correctiveActions: {
+            manualSteps: [
+              ...(usingDeprecatedConfig ? [`Set "${upgradableConfig}" in kibana.yml`] : []),
+              `Create one or more custom roles that provide Kibana application privileges to reporting features in **Management > Security > Roles**.`,


What is the current position on translations in deprecation manual steps or was the accidentally left out?

While working on this, I referenced this Draft PR to add an FAQ: https://github.com/elastic/kibana/pull/99043/files#r636460961

I asked a similar question, and found that it's currently not recommended to use i18n for deprecations: #99072

dokmic

LGTM. Great job 👍

tsullivan · 2021-05-26T19:49:44Z

@elasticmachine merge upstream

kibanamachine · 2021-05-26T21:40:44Z

💚 Build Succeeded

Metrics [docs]

Unknown metric groups

References to deprecated APIs

id	before	after	diff
`canvas`	29	25	-4
`crossClusterReplication`	8	6	-2
`fleet`	22	20	-2
`globalSearch`	4	2	-2
`indexManagement`	12	7	-5
`infra`	261	149	-112
`lens`	67	45	-22
`licensing`	18	15	-3
`lists`	239	236	-3
`maps`	286	208	-78
`ml`	121	115	-6
`monitoring`	109	56	-53
`securitySolution`	386	342	-44
`stackAlerts`	101	95	-6
total			-342

History

💚 Build #126806 succeeded d31e5f2
💚 Build #126793 succeeded b0c2504422c9f8e4ffd98c973e60ea351ad0153e

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

…anges (elastic#100427) Co-authored-by: Kibana Machine <[email protected]> # Conflicts: # x-pack/plugins/reporting/server/core.ts # x-pack/plugins/reporting/server/plugin.ts

…anges (#100427) (#100750) Co-authored-by: Kibana Machine <[email protected]> # Conflicts: # x-pack/plugins/reporting/server/core.ts # x-pack/plugins/reporting/server/plugin.ts

tsullivan · 2021-09-23T17:07:16Z

x-pack/plugins/reporting/server/config/index.test.ts

@@ -45,7 +45,7 @@ describe('deprecations', () => {
    const { messages } = applyReportingDeprecations({ roles: { enabled: true } });
    expect(messages).toMatchInlineSnapshot(`
      Array [
-        "\\"xpack.reporting.roles\\" is deprecated. Granting reporting privilege through a \\"reporting_user\\" role will not be supported starting in 8.0. Please set 'xpack.reporting.roles.enabled' to 'false' and grant reporting privilege to users through feature controls in Management > Security > Roles",
+        "\\"xpack.reporting.roles\\" is deprecated. Granting reporting privilege through a \\"reporting_user\\" role will not be supported starting in 8.0. Please set 'xpack.reporting.roles.enabled' to 'false' and grant reporting privileges to users using Kibana application privileges **Management > Security > Roles**.",


I think we don't have the authority to remove support for the reporting_user role in 8.0. The ability to switch off the support is still very new in Kibana and we've seen plenty of cases where configuring things properly stumps users. This text should be changed to say that the support will be removed "in a future version"

Edit: filed #113014

tsullivan added Team:AppServices labels May 20, 2021

tsullivan commented May 20, 2021

View reviewed changes

tsullivan changed the title ~~[Reporting] Use the deprecations service to advise upgradable config changes~~ [Reporting] Use the deprecations service to advise critical config changes May 20, 2021

tsullivan force-pushed the reporting/user-role-deprecation branch from 226ae02 to b0c2504 Compare May 20, 2021 21:45

tsullivan commented May 20, 2021

View reviewed changes

tsullivan force-pushed the reporting/user-role-deprecation branch from c76d3dd to deac77e Compare May 20, 2021 22:53

tsullivan mentioned this pull request May 20, 2021

[Breaking change] Reporting: remove reporting_user role #92485

Closed

tsullivan added v7.14.0 v8.0.0 reason:enhancement release_note:skip Skip the PR/issue when compiling release notes labels May 20, 2021

tsullivan marked this pull request as ready for review May 20, 2021 22:54

tsullivan requested review from jloleysens, dokmic, a team, Bamieh and alisonelizabeth May 20, 2021 22:55

[Reporting] Use the deprecations service to advise critical config ch…

d31e5f2

…anges

tsullivan force-pushed the reporting/user-role-deprecation branch from deac77e to d31e5f2 Compare May 20, 2021 23:17

jloleysens approved these changes May 25, 2021

View reviewed changes

alisonelizabeth approved these changes May 25, 2021

View reviewed changes

jloleysens reviewed May 26, 2021

View reviewed changes

dokmic approved these changes May 26, 2021

View reviewed changes

Merge branch 'master' into reporting/user-role-deprecation

1bce33c

tsullivan merged commit 417c06b into elastic:master May 27, 2021

tsullivan deleted the reporting/user-role-deprecation branch May 27, 2021 00:31

tsullivan mentioned this pull request May 27, 2021

[7.x] [Reporting] Use the deprecations service to advise critical config changes (#100427) #100750

Merged

cjcenizal mentioned this pull request Aug 19, 2021

[Meta] 8.0 Kibana deprecations #109166

Closed

tsullivan commented Sep 23, 2021

View reviewed changes

sophiec20 added the enhancement New value added to drive a business result label Mar 27, 2024

sophiec20 added the (Deprecated) Feature:Reporting Use Reporting:Screenshot, Reporting:CSV, or Reporting:Framework instead label Aug 21, 2024

tsullivan mentioned this pull request Oct 17, 2024

[Reporting] Clarify deprecation changes of the roles settings #121349

Merged

1 task

tsullivan changed the title ~~[Reporting] Use the deprecations service to advise critical config changes~~ [Reporting] Use the deprecations service to advise reporting_user config changes Oct 17, 2024

tsullivan mentioned this pull request Oct 17, 2024

[Reporting] Add deprecation messages for roles mapped to reporting_user #115125

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Reporting] Use the deprecations service to advise `reporting_user` config changes #100427

[Reporting] Use the deprecations service to advise `reporting_user` config changes #100427

tsullivan commented May 20, 2021 •

edited

Loading

tsullivan May 20, 2021

tsullivan May 20, 2021

tsullivan May 20, 2021

elasticmachine commented May 20, 2021

elasticmachine commented May 20, 2021

jloleysens left a comment

jloleysens May 25, 2021

tsullivan May 25, 2021

jloleysens May 26, 2021

alisonelizabeth left a comment

jloleysens May 26, 2021

tsullivan May 26, 2021

dokmic left a comment

tsullivan commented May 26, 2021

kibanamachine commented May 26, 2021

References to deprecated APIs

tsullivan Sep 23, 2021 •

edited

Loading

[Reporting] Use the deprecations service to advise reporting_user config changes #100427

[Reporting] Use the deprecations service to advise reporting_user config changes #100427

Conversation

tsullivan commented May 20, 2021 • edited Loading

Summary

Screenshots

Checklist

For maintainers

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elasticmachine commented May 20, 2021

elasticmachine commented May 20, 2021

jloleysens left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alisonelizabeth left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dokmic left a comment

Choose a reason for hiding this comment

tsullivan commented May 26, 2021

kibanamachine commented May 26, 2021

💚 Build Succeeded

Metrics [docs]

References to deprecated APIs

History

tsullivan Sep 23, 2021 • edited Loading

Choose a reason for hiding this comment

[Reporting] Use the deprecations service to advise `reporting_user` config changes #100427

[Reporting] Use the deprecations service to advise `reporting_user` config changes #100427

tsullivan commented May 20, 2021 •

edited

Loading

tsullivan Sep 23, 2021 •

edited

Loading