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

tsullivan · 2021-12-15T20:19:32Z

Summary

Closes #120263

Follows: #115125, #100427, #94966

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

Screenshots

Warning in the startup logs

Warning in the upgrade assistant

Warning seen if a role mapping to `reporting_user` exists

Warning seen if an existing user has the reporting_user role

elasticmachine · 2021-12-15T20:20:46Z

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

elasticmachine · 2021-12-15T20:20:46Z

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

gchaps · 2021-12-15T20:34:59Z

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

-              ` The "{fromPath}.roles.enabled" setting will default to false` +
-              ` in a future release.`,
-            values: { fromPath },
+              `The default mechanism for Reporting privilege will work differently in future versions,` +


either "the Reporting privilege" or "Reporting privileges"

Thanks. I'll go with Reporting privileges

gchaps · 2021-12-15T20:36:59Z

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

      defaultMessage:
-        'Existing users have their Reporting privilege granted by a deprecated setting.',
+        `The default mechanism for Reporting privilege will work differently in future versions, and` +


Same comment as above. Singular or plural for Reporting privilege.

gchaps · 2021-12-15T20:38:39Z

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

      defaultMessage:
-        'Existing users have their Reporting privilege granted by a deprecated setting.',
+        `The default mechanism for Reporting privilege will work differently in future versions, and` +
+        ` this cluster contains users who have a deprecated role for this privilege.` +


"has" instead of "contains"? contains makes me think that users are inside of the clusters.

gchaps · 2021-12-15T20:41:14Z

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

            }),
          ]
        : []),

      i18n.translate('xpack.reporting.deprecations.reportingRoleUsers.manualStepThree', {
-        defaultMessage: 'Create a custom role with Kibana privileges to grant access to Reporting.',
+        defaultMessage:
+          `Create one or more roles that grant the Kibana application` +


Would this work?

Go to Management > Security > Roles to create or more roles that grant the Kibana application privilege for Reporting.

Elsewhere, you use Reporting (capital R). Is that correct here?

gchaps · 2021-12-15T20:41:50Z

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

-      defaultMessage: 'Existing roles are mapped to a deprecated role for Reporting privileges',
+    message: i18n.translate('xpack.reporting.deprecations.reportingRoleMappings.description', {
+      defaultMessage:
+        `The default mechanism for Reporting privilege will work differently in future versions, and` +


Same comment as above. Singular or plural?

gchaps · 2021-12-15T20:42:45Z

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

@@ -156,11 +166,17 @@ async function getRoleMappingsDeprecations(
        : []),

      i18n.translate('xpack.reporting.deprecations.reportingRoleMappings.manualStepThree', {
-        defaultMessage: 'Create a custom role with Kibana privileges to grant access to Reporting.',
+        defaultMessage:
+          `Create one or more roles that grant the Kibana application` +


Same comment as above.

gchaps · 2021-12-15T20:59:00Z

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

-                  ` Users assigned a reporting role specified in "xpack.reporting.roles.allow"` +
-                  ` will no longer have reporting privileges, they must be assigned an application privilege based role.`,
+              i18n.translate('xpack.reporting.deprecations.reportingRoles.manualStepFour', {
+                defaultMessage: `Grant reporting privileges to users by assigning one of the new roles.`,


Is it clear to users what the new roles are?

the new roles must be created by the admin

…deprecation-wording-iii

gchaps · 2021-12-16T16:28:15Z

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

-                  `Grant reporting privileges to users by assigning one of the new roles.` +
-                  ` Users assigned a reporting role specified in "xpack.reporting.roles.allow"` +
-                  ` will no longer have reporting privileges, they must be assigned an application privilege based role.`,
+                  `Go to **Management > Security > Roles** to create one or more roles that grant` +


I noticed that bold formatting doesn't show up in the screenshots. Best to remove the **.

gchaps · 2021-12-16T16:30:55Z

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

            }),
          ]
        : []),

      i18n.translate('xpack.reporting.deprecations.reportingRoleUsers.manualStepThree', {
-        defaultMessage: 'Create a custom role with Kibana privileges to grant access to Reporting.',
+        defaultMessage:
+          `Go to **Management > Security > Roles** to create one or more roles that grant` +


Remove bold formatting.

gchaps · 2021-12-16T16:32:04Z

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

            }),
          ]
        : []),

      i18n.translate('xpack.reporting.deprecations.reportingRoleMappings.manualStepThree', {
-        defaultMessage: 'Create a custom role with Kibana privileges to grant access to Reporting.',
+        defaultMessage:
+          `Go to **Management > Security > Roles** to create one or more roles that grant` +


Remove bold formatting.

tsullivan · 2021-12-16T17:15:54Z

@elasticmachine merge upstream

kibana-ci · 2021-12-16T18:39:28Z

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

💚 Build #13565 succeeded 260b1ee
💔 Build #13553 failed eb92a78
💔 Build #13523 failed 197fa77

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

…c#121349) * [Reporting] Clarify deprecation changes of the roles settings * updates per feedback * update test snapshots * minor fix * fix i18n * remove formatting marks Co-authored-by: Kibana Machine <[email protected]>

…c#121349) * [Reporting] Clarify deprecation changes of the roles settings * updates per feedback * update test snapshots * minor fix * fix i18n * remove formatting marks Co-authored-by: Kibana Machine <[email protected]> # Conflicts: # x-pack/plugins/translations/translations/ja-JP.json # x-pack/plugins/translations/translations/zh-CN.json

… (#121444) * [Reporting] Clarify deprecation changes of the roles settings * updates per feedback * update test snapshots * minor fix * fix i18n * remove formatting marks Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: Kibana Machine <[email protected]>

… (#121447) * [Reporting] Clarify deprecation changes of the roles settings * updates per feedback * update test snapshots * minor fix * fix i18n * remove formatting marks Co-authored-by: Kibana Machine <[email protected]> # Conflicts: # x-pack/plugins/translations/translations/ja-JP.json # x-pack/plugins/translations/translations/zh-CN.json

[Reporting] Clarify deprecation changes of the roles settings

197fa77

tsullivan requested review from a team as code owners December 15, 2021 20:19

tsullivan added v7.17.0 v8.0.0 v8.1.0 release_note:skip Skip the PR/issue when compiling release notes deprecation_warnings (Deprecated) Feature:Reporting Use Reporting:Screenshot, Reporting:CSV, or Reporting:Framework instead Team:AppServicesUx labels Dec 15, 2021

gchaps reviewed Dec 15, 2021

View reviewed changes

tsullivan added 5 commits December 15, 2021 15:30

updates per feedback

25b15aa

update test snapshots

294db45

minor fix

eb92a78

Merge remote-tracking branch 'elastic/main' into reporting/reporting-…

65a7142

…deprecation-wording-iii

fix i18n

260b1ee

gchaps reviewed Dec 16, 2021

View reviewed changes

vadimkibana approved these changes Dec 16, 2021

View reviewed changes

kibanamachine and others added 2 commits December 16, 2021 12:15

Merge branch 'main' into reporting/reporting-deprecation-wording-iii

dd356f2

remove formatting marks

7880ec4

tsullivan merged commit f809278 into elastic:main Dec 16, 2021

tsullivan deleted the reporting/reporting-deprecation-wording-iii branch December 16, 2021 18:57

tsullivan mentioned this pull request Dec 16, 2021

[8.0] [Reporting] Clarify deprecation changes of the roles settings (#121349) #121444

Merged

tsullivan mentioned this pull request Dec 16, 2021

[7.17] [Reporting] Clarify deprecation changes of the roles settings (#121349) #121447

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

tsullivan commented Dec 15, 2021 •

edited

Loading

elasticmachine commented Dec 15, 2021

elasticmachine commented Dec 15, 2021

gchaps Dec 15, 2021

tsullivan Dec 15, 2021

gchaps Dec 15, 2021

gchaps Dec 15, 2021

gchaps Dec 15, 2021

gchaps Dec 15, 2021

gchaps Dec 15, 2021

gchaps Dec 15, 2021

tsullivan Dec 15, 2021

gchaps Dec 16, 2021

gchaps Dec 16, 2021

gchaps Dec 16, 2021

tsullivan commented Dec 16, 2021

kibana-ci commented Dec 16, 2021

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

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

Conversation

tsullivan commented Dec 15, 2021 • edited Loading

Summary

Checklist

Screenshots

Warning in the startup logs

Warning in the upgrade assistant

Warning seen if a role mapping to reporting_user exists

Warning seen if an existing user has the reporting_user role

elasticmachine commented Dec 15, 2021

elasticmachine commented Dec 15, 2021

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

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

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

tsullivan commented Dec 16, 2021

kibana-ci commented Dec 16, 2021

💚 Build Succeeded

Metrics [docs]

History

tsullivan commented Dec 15, 2021 •

edited

Loading

Warning seen if a role mapping to `reporting_user` exists