Skip to content

Commit

Permalink
[docs][skip ci] Read only access for @elastic/kibana-app applications (
Browse files Browse the repository at this point in the history
…#35560) (#38307)

* Adding read-only mode section to Discover

* No more "mode" or "badge" terminology

* Putting newline back

* Adding "Saving" section for visualize

* Adding dashboard read only access section

* Timelion gets read-only documentation

* Adding read only access section to index patterns and advanced settings

* Adding graph read only access section
  • Loading branch information
kobelb authored Jun 13, 2019
1 parent 3ad204d commit a4ca6c6
Show file tree
Hide file tree
Showing 19 changed files with 112 additions and 10 deletions.
15 changes: 15 additions & 0 deletions docs/dashboard.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,21 @@ you'll be prompted to do so as you follow the steps for creating a dashboard.
Or, you can use one of the prebuilt sample data sets, available from the
Kibana home page.

[float]
[[dashboard-read-only-access]]
=== [xpack]#Read only access#
When you have insufficient privileges to create or save dashboards, the following
indicator in Kibana will be displayed. The buttons to create new dashboards or edit
existing dashboard won't be visible. For more information on granting access to
Kibana see <<xpack-security-authorization>>.

[role="screenshot"]
image::images/dashboard-read-only-badge.png[Example of Dashboard's read only access indicator in Kibana's header]

[float]
[[dashboard-create-new-dashboard]]
=== Creating a new Dashboard

. In the side navigation, click *Dashboard*.
. Click *Create new dashboard.*
. Click *Add*.
Expand Down
Binary file added docs/discover/images/read-only-badge.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions docs/discover/search.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,16 @@ Saving searches enables you to reload them into Discover and use them as the bas
for <<visualize, visualizations>>. Saving a search saves both the search query string
and the currently selected index pattern.

[role="xpack"]
[[discover-read-only-access]]
==== Read only access
When you have insufficient privileges to save searches, the following indicator in Kibana will be
displayed and the *Save* button won't be visible. For more information on granting access to
Kibana see <<xpack-security-authorization>>.

[role="screenshot"]
image::discover/images/read-only-badge.png[Example of Discover's read only access indicator in Kibana's header]

==== Saving a Search
To save the current search:

Expand Down
14 changes: 12 additions & 2 deletions docs/graph/configuring-graph.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ might be deleted after a workspace is saved, there's no practical basis for
checking permissions for the data in a saved workspace.

For this reason, you can configure the save policy for graph workspaces to
ensure appropriate handling of your data. You can allow users to save
only the configuration information for a graph, require users to
ensure appropriate handling of your data. You can allow all users to save
only the configuration information for a graph, require all users to
explicitly include the workspace data, or completely disable the ability
to save a workspace.

Expand All @@ -47,6 +47,16 @@ default policy.
Only the configuration is saved unless the user
explicitly selects the include data option.

[float]
=== Using Security to Grant Access
You can also use security to grant read only or all access to different roles.
When security is used to grant read only access, the following indicator in Kibana
will be displayed. For more information on granting access to Kibana see
<<xpack-security-authorization>>.

[role="screenshot"]
image::graph/images/graph-read-only-badge.png[Example of Graph's read only access indicator in Kibana's header]

[float]
[[disable-drill-down]]
=== Disabling Drill Down Configuration
Expand Down
Binary file added docs/graph/images/graph-read-only-badge.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/dashboard-read-only-badge.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/management-index-read-only-badge.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/settings-read-only-badge.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/timelion-read-only-badge.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions docs/management/advanced-options.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,19 @@ for displayed decimal values.
. Scroll or search for the setting you want to modify.
. Enter a new value for the setting.

[float]
[[settings-read-only-access]]
=== [xpack]#Read only access#
When you have insufficient privileges to edit advanced settings, the following
indicator in Kibana will be displayed. The buttons to edit settings won't be visible.
For more information on granting access to Kibana see <<xpack-security-authorization>>.

[role="screenshot"]
image::images/settings-read-only-badge.png[Example of Advanced Settings Management's read only access indicator in Kibana's header]

[float]
[[kibana-settings-reference]]
=== Kibana settings reference

WARNING: Modifying a setting can affect {kib}
performance and cause problems that are
Expand Down
11 changes: 11 additions & 0 deletions docs/management/index-patterns.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,17 @@ you cannot search them.
Use caution when modifying advanced options, as it's possible to set values that are incompatible with one another.
* Configure Kibana for a production environment

[float]
[[index-patterns-read-only-access]]
=== [xpack]#Read only access#
When you have insufficient privileges to create or save index patterns, the following
indicator in Kibana will be displayed. The buttons to create new index patterns or save
existing index patterns won't be visible. For more information on granting access to
Kibana see <<xpack-security-authorization>>.

[role="screenshot"]
image::images/management-index-read-only-badge.png[Example of Index Pattern Management's read only access indicator in Kibana's header]

[float]
[[settings-create-pattern]]
== Creating an Index Pattern to Connect to Elasticsearch
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,4 @@ Now that you have thresholds and a moving average, let's format the visualizatio
image::images/timelion-conditional04.png[]
{nbsp}

Save your Timelion sheet and continue on to the next section to add these new visualizations to your dashboard.
Continue on to the next section to learn how to save your timelion sheet and add an expression to your dashboard.
2 changes: 0 additions & 2 deletions docs/timelion/getting-started/timelion-create.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,5 +33,3 @@ It’s a bit hard to differentiate the two series. Customize the labels in order

image::images/timelion-create03.png[]
{nbsp}

Save the entire Timelion sheet as _Metricbeat Example_. As a best practice, you should be saving any significant changes made to this sheet as you progress through this tutorial.
2 changes: 1 addition & 1 deletion docs/timelion/getting-started/timelion-customize.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@ Last but not least, adjust the legend so that it takes up as little space as pos
image::images/timelion-customize04.png[]
{nbsp}

Save your changes and continue on to the next section to learn about mathematical functions.
Continue on to the next section to learn about mathematical functions.
2 changes: 1 addition & 1 deletion docs/timelion/getting-started/timelion-math.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,4 @@ Utilizing the formatting functions `.title()`, `.label()`, `.color()`, `.lines()
image::images/timelion-math06.png[]
{nbsp}

Save your changes and continue on to the next section to learn about conditional logic and tracking trends.
Continue on to the next section to learn about conditional logic and tracking trends.
26 changes: 23 additions & 3 deletions docs/timelion/getting-started/timelion-save.asciidoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,29 @@
[[timelion-save]]
=== Add to dashboard
=== Save and add to dashboard

You’ve officially harnessed the power of Timelion to create time series visualizations. The final step of this tutorial is to add your new visualizations to a dashboard. Below, this section will show you how to save a visualization from your Timelion sheet and add it to an existing dashboard.
You’ve officially harnessed the power of Timelion to create time series visualizations. The final steps of this tutorial are to save your entire Timelion sheet and save an expression as a dashboard panel.

To save a Timelion visualization as a dashboard panel, follow the steps below.
[role="xpack"]
[[timelion-read-only-access]]
==== Read only access
When you have insufficient privileges to save Timelion sheets, the following indicator in Kibana will be
displayed and the *Save* button won't be visible. For more information on granting access to
Kibana see <<xpack-security-authorization>>.

[role="screenshot"]
image::images/timelion-read-only-badge.png[Example of Timelion's read only access indicator in Kibana's header]

==== Save entire Timelion sheet

Saving an entire Timelion sheet allows you to reload it in the Timelion application and make changes to any of the expressions:

. Click the `Save` option in the top menu
. Select `Save entire Timelion sheet`
. Name your sheet and click `Save`

==== Save as dashboard panel

To save a Timelion expression as a dashboard panel, follow the steps below.

. Select the visualization you’d like to add to one (or multiple) dashboards
. Click the `Save` option in the top menu
Expand Down
2 changes: 2 additions & 0 deletions docs/visualize.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,8 @@ For more information about working with sub aggregations, see
https://www.elastic.co/blog/kibana-aggregation-execution-order-and-you[Kibana,
Aggregation Execution Order, and You].

include::visualize/saving.asciidoc[]

include::visualize/xychart.asciidoc[]

include::visualize/controls.asciidoc[]
Expand Down
Binary file added docs/visualize/images/read-only-badge.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 24 additions & 0 deletions docs/visualize/saving.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
[[save-visualize]]
== Saving Visualizations
Saving visualizations enables you to reload them in Visualize and use them in
<<dashboard, dashboards>>.

[float]
[[visualize-read-only-access]]
=== [xpack]#Read only access#
When you have insufficient privileges to save visualizations, the following indicator in Kibana will be
displayed and the *Save* button won't be visible. For more information on granting access to
Kibana see <<xpack-security-authorization>>.

[role="screenshot"]
image::visualize/images/read-only-badge.png[Example of Visualize's read only access indicator in Kibana's header]

[float]
[[saving-a-visualization]]
=== Saving a Visualization
To save the current visualization:

. Click *Save* in the Kibana toolbar.
. Enter a name for the visualization and click *Save*.

You can import, export and delete saved visualizations from *Management/Kibana/Saved Objects*.

0 comments on commit a4ca6c6

Please sign in to comment.