Skip to content

[8.x/Docs/Reporting] Update guidance for xpack.reporting.roles.enabled#203703

Merged
stephmilovic merged 5 commits intoelastic:8.xfrom
tsullivan:docs/reporting/access-control-model-explaination
Dec 17, 2024
Merged

[8.x/Docs/Reporting] Update guidance for xpack.reporting.roles.enabled#203703
stephmilovic merged 5 commits intoelastic:8.xfrom
tsullivan:docs/reporting/access-control-model-explaination

Conversation

@tsullivan
Copy link
Copy Markdown
Member

Summary

The purpose of this PR is to clarify the 8.x documentation of xpack.reporting.roles.enabled, and to focus on wording that encourages users to set xpack.reporting.roles.enabled: false as a way to take advantage of a newer access control model and grant users the least amount of privilege they need. This adds more explain to what the xpack.reporting.roles.enabled setting actually does, and explain that these concerns are specific to 8.x.

@tsullivan tsullivan added release_note:skip Skip the PR/issue when compiling release notes v8.18.0 labels Dec 10, 2024
@github-actions
Copy link
Copy Markdown
Contributor

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@tsullivan tsullivan added v8.16.0 backport:version Backport to applied version labels v8.17.0 labels Dec 10, 2024
Copy link
Copy Markdown
Contributor

@clintandrewhall clintandrewhall left a comment

Choose a reason for hiding this comment

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

A couple of suggestions for consistency.

Copy link
Copy Markdown
Contributor

@jloleysens jloleysens left a comment

Choose a reason for hiding this comment

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

Overall LGTM, left a non-blocking question, but I may have misunderstood something.

NOTE: In Kibana 8.x versions, the default `xpack.reporting.roles.enabled: true` setting uses an older access control model separate from {kib} application
privileges. The default model grants users with the built-in `reporting_user` role access to create any type of report in Kibana. Since the default model
is not based on {kib} application privileges, users that do not have permission to create reports will see {report-features} in Kibana, but will receive an
error if they attempt to request a report. The default model also does not allow API keys or authentication tokens to authorize report generation. Refer to
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Interesting, I did not realise requesting reports would error under this model.

So the current default xpack.reporting.roles.enabled: true does not allow users to use reporting functionality at all if I'm following correctly?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@jloleysens

So the current default xpack.reporting.roles.enabled: true does not allow users to use reporting functionality at all if I'm following correctly?

I hope this is actually clear in the docs - the default setting doesn't allow users to use the reporting functionality IF they do not have the reporting_user role.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

OK, that was my misunderstanding, I think it is clear enough!

@kapral18
Copy link
Copy Markdown
Contributor

Please do not merge this pull request. We disabled auto-merge because we are trying to merge a this big PR as part of sustainable architecture migration which is impossible with ever increasing stream of backports. We will resume the automerge after our PR is merged. Reach out to #sustainable-kibana-architecture for more info.

@kapral18
Copy link
Copy Markdown
Contributor

Auto-merge has been re-enabled. Thank you for your patience. :heart

@stephmilovic stephmilovic merged commit 7b31a48 into elastic:8.x Dec 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport:version Backport to applied version labels release_note:skip Skip the PR/issue when compiling release notes v8.16.0 v8.17.0 v8.18.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants