[DOCS] Dashboard-only-mode: Update to match UI (#20734) (#20773)

* [DOCS] Dashboard-only-mode: Update to match UI

* [DOCS] Incorporated review comments, added note about data access
This commit is contained in:
gchaps 2018-07-13 13:41:23 -07:00 committed by GitHub
parent 5fae20eec0
commit 750a855627
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 37 additions and 24 deletions

View file

@ -1,19 +1,25 @@
[role="xpack"]
[[advanced-dashboard-mode-configuration]]
=== Advanced configuration for Dashboard Only mode
=== Advanced Configuration for Dashboard Only Mode
Kibana comes preconfigured with a reserved role called `kibana_dashboard_only_user` which will be sufficient
for most use cases. However, if your setup requires a custom Kibana index, you can manually create
Dashboard Mode roles.
If {security} is enabled, Kibana has a built-in `kibana_dashboard_only_user`
role that grants read only access to the `.kibana` index. This role is sufficient
for most use cases. However, if your setup requires a custom {kib} index, you can create
your own roles and tag them as *Dashboard only mode*.
To do so, go into *Management > Advanced Settings* and search for `xpackDashboardMode:roles`. Then assign whatever
role names you wish to use to flag a user for Dashboard Only mode.
Go to *Management > Kibana > Advanced Settings* and search for *Dashboard*. By default
`xpackDashboardMode:roles` is set to `kibana_dashboard_only_user`.
Here you can add as many roles as you like.
[role="screenshot"]
image:management/dashboard_only_mode/images/advanced_dashboard_mode_role_setup.png["Advanced dashboard mode role setup"]
It isn't necessary for Dashboard Only mode roles to have any additional permissions, but it's a convenient location
to also place access rules to the custom Kibana index. If you wish to grant read only access to your custom Kibana
index, it must have `view_index_metadata` permissions as well as `read` permissions. These role settings are available
under *Management > Security > Roles*.
By default, a *dashboard only mode* user doesn't have access to any data indices.
To grant read only access to your custom {kib}
index, you must assign `view_index_metadata` and `read` privileges.
These privileges are available under *Management > Security > Roles*.
For more information on roles and privileges, see {xpack-ref}/authorization.html[User Authorization].
[role="screenshot"]
image:management/dashboard_only_mode/images/custom_dashboard_mode_role.png["Custom dashboard mode role with read permissions on a custom kibana index"]

Binary file not shown.

Before

Width:  |  Height:  |  Size: 52 KiB

After

Width:  |  Height:  |  Size: 60 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 254 KiB

After

Width:  |  Height:  |  Size: 145 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 317 KiB

After

Width:  |  Height:  |  Size: 304 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 122 KiB

View file

@ -2,25 +2,32 @@
[[xpack-dashboard-only-mode]]
== Kibana Dashboard Only Mode
{xpack} gives the ability for admins to limit what certain users see when they log in to Kibana with a
reserved `kibana_dashboard_only_user` role.
If {security} is enabled, you can use the `kibana_dashboard_only_user` built-in role to limit
what users see when they log in to {kib}.
When you assign a user this role, the next time they sign in to Kibana they will only be able to see the Dashboard app,
and no editing tools will be available.
image:management/dashboard_only_mode/images/view_only_listing_page.png["View Only Dashboard Listing Page"]
Users assigned this role are only able to see the Dashboard app in the navigation
pane. When users open a dashboard, they will have a limited visual experience.
All edit and create controls are hidden.
[role="screenshot"]
image:management/dashboard_only_mode/images/view_only_dashboard.png["View Only Dashboard"]
IMPORTANT: If a user is also assigned the reserved `superuser` role, they will be able to see all of Kibana and have
full access.
To assign this role, go to *Management > Security > Users*, add or edit
a user, and add the `kibana_dashboard_only_user` role. You must assign roles
that grant the user appropriate data access. For information on roles
and privileges, see {xpack-ref}/authorization.html[User Authorization].
The `kibana_dashboard_only_user` role comes preconfigured with read only permissions on the `.kibana` index.
The `kibana_dashboard_only_user` role is
preconfigured with read only permissions on the `.kibana` index.
IMPORTANT: If you assign a user the `kibana_dashboard_only_user` role, along with a role with write permissions on
the .kibana index, they *will* have write access, even though the controls will remain hidden in the kibana
UI.
IMPORTANT: If you assign users the `kibana_dashboard_only_user` role, along with a role
with write permissions on the `.kibana` index, they *will* have write access,
even though the controls remain hidden in the {kib} UI.
IMPORTANT: If you also assign users the reserved `superuser` role, they will be able to see
all of {kib} and have full access.
<<advanced-dashboard-mode-configuration, Advanced configurations>> that use a
custom {kib} index are possible.
For advanced set ups that use a custom Kibana index,
<<advanced-dashboard-mode-configuration, advanced configurations>> are possible.
include::advanced_configuration.asciidoc[]