Skip to content
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.

Sign up for GitHub

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

[DOCS][Reporting] Adds info about using a custom reporting index #54052

Merged
merged 2 commits into from
Jan 7, 2020
Merged

[DOCS][Reporting] Adds info about using a custom reporting index #54052

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
073f9b7
[DOCS][Reporting] Adds info about using a custom reporting index
gchaps Jan 6, 2020
c25ba39
[DOCS] Incorporates edits into reporting security doc
gchaps Jan 6, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/user/security/reporting.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,30 @@ that provides read and write privileges in
Go to *Management > Users*, add a new user, and assign the user the built-in
`reporting_user` role and your new custom role, `custom_reporting_user`.

[float]
==== With a custom index

If you are using Reporting with a custom index,
start the `xpack.reporting.index` setting
Copy link
Member

Choose a reason for hiding this comment

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

Maybe:

If you are using Reporting with a custom index, the xpack.reporting.index setting should begin with .reporting-. The default {kib} user has all privileges against the .reporting-* pattern of indices.

The change would make it consistent with the wording where there is similar advice: https://www.elastic.co/guide/en/kibana/current/configuring-reporting.html#report-indices

On that page, it says:

NOTE: If security is enabled, the xpack.reporting.index setting should begin with .reporting- in order for the kibana_system role to have the necessary privileges over the index.

with `.reporting-*`. The default {kib} system user has
`all` privileges against the `.reporting-*` pattern of indices.

[source,js]
xpack.reporting.index: '.reporting-custom-index'

If you use a different pattern for the `xpack.reporting.index` setting,
you must create a custom role with appropriate access to the index, similar
to the following:

. Go to *Management > Roles*, and click *Create role*.
. Name the role `custom-reporting-user`.
. Specify the custom index and assign it the `all` index privilege.
. Go to *Management > Users* and create a new user with
the `kibana_system` role and the `custom-reporting-user` role.
. Configure {kib} to use the new account:
[source,js]
elasticsearch.username: 'custom_kibana_system'

[float]
[[reporting-roles-user-api]]
==== With the user API
Expand Down