[Reporting/Docs] Add clarity to reporting concepts #125175

tsullivan · 2022-02-10T00:04:27Z

Closes [Reporting] Document that disabling Reporting completely isn't recommended #120996
Closes Clarify Kibana documentation regarding App privileges and reporting configuration #124839
Closes [Reporting] Document xpack.reporting.kibanaServer as optional #124862

Screenshots

1. Clarifies how to use Kibana Application privileges with Reporting:

2. Discourages setting `xpack.reporting.enabled: false`:

3. Clarifies that `xpack.reporting.kibanaServer` is optional and to handle it with caution, and moves that documentation to the bottom of the page

…leges

tsullivan · 2022-02-10T19:18:39Z

@elasticmachine merge upstream

elasticmachine · 2022-02-10T20:06:37Z

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

KOTungseth

I left a bunch of minor edits, but otherwise, LGTM!

docs/settings/reporting-settings.asciidoc

KOTungseth · 2022-02-10T20:33:15Z

docs/settings/reporting-settings.asciidoc

+Set to `true` (default) to enable the {kib} instance to poll Elasticsearch for pending jobs and claim them for
+execution. Setting this to `false` allows the {kib} instance to only add new jobs to the reporting queue, list
+jobs, and provide the downloads to completed reports through the UI. This requires a deployment where at least
+one other Kibana instance in the Elastic cluster has this setting to `true`.


Suggested change

one other Kibana instance in the Elastic cluster has this setting to `true`.

one other {kib} instance in the Elastic cluster has this setting set to `true`.

docs/settings/reporting-settings.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

docs/settings/reporting-settings.asciidoc

kibana-ci · 2022-02-11T00:44:53Z

💚 Build Succeeded

Buildkite Build
Commit: 6cded3c

History

💚 Build #23342 succeeded d7743e5
💚 Build #23341 succeeded de32dbc
💚 Build #23339 succeeded d60cbb5
💚 Build #23244 succeeded 5c0cc84
💚 Build #23009 succeeded 566bdfa

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

* discourage setting enabled:false * mark xpack.reporting.kibanaServer as experimental * move kibanaServer section down * add kibana privileges with reporting options screenshot * rephrase why reporting.roles is depreccated * screenshot for how to define a custom role the grants reporting privileges * Apply suggestions from code review Co-authored-by: Kaarina Tungseth <[email protected]> * Apply suggestions from code review Co-authored-by: Kaarina Tungseth <[email protected]> * Update docs/settings/reporting-settings.asciidoc Co-authored-by: Kaarina Tungseth <[email protected]> * Apply suggestions from code review Co-authored-by: Kaarina Tungseth <[email protected]> * Update docs/settings/reporting-settings.asciidoc Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: Kaarina Tungseth <[email protected]> (cherry picked from commit 1095208)

kibanamachine · 2022-02-11T16:44:55Z

💔 Some backports could not be created

Status	Branch	Result
❌	8.0	Backport failed because of merge conflicts
✅	8.1
❌	7.17	Backport failed because of merge conflicts You might need to backport the following PRs to 7.17: - Remove CentOS (#121128)

How to fix

Re-run the backport manually:

node scripts/backport --pr 125175

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

* discourage setting enabled:false * mark xpack.reporting.kibanaServer as experimental * move kibanaServer section down * add kibana privileges with reporting options screenshot * rephrase why reporting.roles is depreccated * screenshot for how to define a custom role the grants reporting privileges * Apply suggestions from code review Co-authored-by: Kaarina Tungseth <[email protected]> * Apply suggestions from code review Co-authored-by: Kaarina Tungseth <[email protected]> * Update docs/settings/reporting-settings.asciidoc Co-authored-by: Kaarina Tungseth <[email protected]> * Apply suggestions from code review Co-authored-by: Kaarina Tungseth <[email protected]> * Update docs/settings/reporting-settings.asciidoc Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: Kaarina Tungseth <[email protected]> (cherry picked from commit 1095208) Co-authored-by: Tim Sullivan <[email protected]>

* discourage setting enabled:false * mark xpack.reporting.kibanaServer as experimental * move kibanaServer section down * add kibana privileges with reporting options screenshot * rephrase why reporting.roles is depreccated * screenshot for how to define a custom role the grants reporting privileges * Apply suggestions from code review Co-authored-by: Kaarina Tungseth <[email protected]> * Apply suggestions from code review Co-authored-by: Kaarina Tungseth <[email protected]> * Update docs/settings/reporting-settings.asciidoc Co-authored-by: Kaarina Tungseth <[email protected]> * Apply suggestions from code review Co-authored-by: Kaarina Tungseth <[email protected]> * Update docs/settings/reporting-settings.asciidoc Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: Kaarina Tungseth <[email protected]> (cherry picked from commit 1095208)

* discourage setting enabled:false * mark xpack.reporting.kibanaServer as experimental * move kibanaServer section down * add kibana privileges with reporting options screenshot * rephrase why reporting.roles is depreccated * screenshot for how to define a custom role the grants reporting privileges * Apply suggestions from code review Co-authored-by: Kaarina Tungseth <[email protected]> * Apply suggestions from code review Co-authored-by: Kaarina Tungseth <[email protected]> * Update docs/settings/reporting-settings.asciidoc Co-authored-by: Kaarina Tungseth <[email protected]> * Apply suggestions from code review Co-authored-by: Kaarina Tungseth <[email protected]> * Update docs/settings/reporting-settings.asciidoc Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: Kaarina Tungseth <[email protected]> (cherry picked from commit 1095208) # Conflicts: # docs/settings/reporting-settings.asciidoc

* discourage setting enabled:false * mark xpack.reporting.kibanaServer as experimental * move kibanaServer section down * add kibana privileges with reporting options screenshot * rephrase why reporting.roles is depreccated * screenshot for how to define a custom role the grants reporting privileges * Apply suggestions from code review Co-authored-by: Kaarina Tungseth <[email protected]> * Apply suggestions from code review Co-authored-by: Kaarina Tungseth <[email protected]> * Update docs/settings/reporting-settings.asciidoc Co-authored-by: Kaarina Tungseth <[email protected]> * Apply suggestions from code review Co-authored-by: Kaarina Tungseth <[email protected]> * Update docs/settings/reporting-settings.asciidoc Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: Kaarina Tungseth <[email protected]> (cherry picked from commit 1095208)

* discourage setting enabled:false * mark xpack.reporting.kibanaServer as experimental * move kibanaServer section down * add kibana privileges with reporting options screenshot * rephrase why reporting.roles is depreccated * screenshot for how to define a custom role the grants reporting privileges * Apply suggestions from code review Co-authored-by: Kaarina Tungseth <[email protected]> * Apply suggestions from code review Co-authored-by: Kaarina Tungseth <[email protected]> * Update docs/settings/reporting-settings.asciidoc Co-authored-by: Kaarina Tungseth <[email protected]> * Apply suggestions from code review Co-authored-by: Kaarina Tungseth <[email protected]> * Update docs/settings/reporting-settings.asciidoc Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: Kaarina Tungseth <[email protected]> (cherry picked from commit 1095208) # Conflicts: # docs/settings/reporting-settings.asciidoc Co-authored-by: Kibana Machine <[email protected]>

tsullivan added 6 commits February 9, 2022 14:48

discourage setting enabled:false

de0866e

mark xpack.reporting.kibanaServer as experimental

4bf4785

move kibanaServer section down

a49c388

add kibana privileges with reporting options screenshot

6e46be5

rephrase why reporting.roles is depreccated

650485c

screenshot for how to define a custom role the grants reporting privi…

566bdfa

…leges

tsullivan changed the title ~~Reporting/docs all~~ [Reporting] Update documentation to clarify various misunderstood concepts Feb 10, 2022

tsullivan changed the title ~~[Reporting] Update documentation to clarify various misunderstood concepts~~ [Reporting/Docs] Add clarity to reporting concepts Feb 10, 2022

Merge branch 'main' into reporting/docs-all

5c0cc84

tsullivan marked this pull request as ready for review February 10, 2022 20:05

tsullivan requested review from a team as code owners February 10, 2022 20:05

tsullivan added v7.17.1 v8.0.0 v8.1.0 v8.2.0 (Deprecated) Feature:Reporting Use Reporting:Screenshot, Reporting:CSV, or Reporting:Framework instead release_note:skip Skip the PR/issue when compiling release notes Team:AppServicesUx labels Feb 10, 2022

KOTungseth approved these changes Feb 10, 2022

View reviewed changes

vadimkibana approved these changes Feb 10, 2022

View reviewed changes

tsullivan and others added 4 commits February 10, 2022 17:39

Apply suggestions from code review

d60cbb5

Co-authored-by: Kaarina Tungseth <[email protected]>

Apply suggestions from code review

39bee96

Co-authored-by: Kaarina Tungseth <[email protected]>

Update docs/settings/reporting-settings.asciidoc

de32dbc

Co-authored-by: Kaarina Tungseth <[email protected]>

Apply suggestions from code review

d7743e5

Co-authored-by: Kaarina Tungseth <[email protected]>

tsullivan commented Feb 11, 2022

View reviewed changes

docs/settings/reporting-settings.asciidoc Outdated Show resolved Hide resolved

Update docs/settings/reporting-settings.asciidoc

6cded3c

tsullivan added the auto-backport Deprecated - use backport:version if exact versions are needed label Feb 11, 2022

tsullivan merged commit 1095208 into elastic:main Feb 11, 2022

tsullivan deleted the reporting/docs-all branch February 11, 2022 16:40

kibanamachine mentioned this pull request Feb 11, 2022

[8.1] [Reporting/Docs] Add clarity to reporting concepts (#125175) #125406

Merged

tsullivan mentioned this pull request Feb 11, 2022

[8.0] [Reporting/Docs] Add clarity to reporting concepts (#125175) #125412

Merged

tsullivan mentioned this pull request Feb 11, 2022

[7.17] [Reporting/Docs] Add clarity to reporting concepts (#125175) #125414

Merged

kibanamachine mentioned this pull request Feb 11, 2022

[Response Ops][Cases] Add more granular checks before decoding user actions #124896

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Reporting/Docs] Add clarity to reporting concepts #125175

[Reporting/Docs] Add clarity to reporting concepts #125175

tsullivan commented Feb 10, 2022 •

edited

Loading

tsullivan commented Feb 10, 2022

elasticmachine commented Feb 10, 2022

KOTungseth left a comment

KOTungseth Feb 10, 2022

kibana-ci commented Feb 11, 2022

kibanamachine commented Feb 11, 2022

	one other Kibana instance in the Elastic cluster has this setting to `true`.
	one other {kib} instance in the Elastic cluster has this setting set to `true`.

[Reporting/Docs] Add clarity to reporting concepts #125175

[Reporting/Docs] Add clarity to reporting concepts #125175

Conversation

tsullivan commented Feb 10, 2022 • edited Loading

Screenshots

1. Clarifies how to use Kibana Application privileges with Reporting:

2. Discourages setting xpack.reporting.enabled: false:

3. Clarifies that xpack.reporting.kibanaServer is optional and to handle it with caution, and moves that documentation to the bottom of the page

tsullivan commented Feb 10, 2022

elasticmachine commented Feb 10, 2022

KOTungseth left a comment

Choose a reason for hiding this comment

KOTungseth Feb 10, 2022

Choose a reason for hiding this comment

kibana-ci commented Feb 11, 2022

💚 Build Succeeded

History

kibanamachine commented Feb 11, 2022

💔 Some backports could not be created

How to fix

Questions ?

tsullivan commented Feb 10, 2022 •

edited

Loading

2. Discourages setting `xpack.reporting.enabled: false`:

3. Clarifies that `xpack.reporting.kibanaServer` is optional and to handle it with caution, and moves that documentation to the bottom of the page