diff --git a/docs/dashboard.asciidoc b/docs/dashboard.asciidoc index 5e855fdb85d0..48189465bc3e 100644 --- a/docs/dashboard.asciidoc +++ b/docs/dashboard.asciidoc @@ -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 <>. + +[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*. diff --git a/docs/discover/images/read-only-badge.png b/docs/discover/images/read-only-badge.png new file mode 100644 index 000000000000..b46b9576fa3f Binary files /dev/null and b/docs/discover/images/read-only-badge.png differ diff --git a/docs/discover/search.asciidoc b/docs/discover/search.asciidoc index 4511264278df..9286b3ce31ba 100644 --- a/docs/discover/search.asciidoc +++ b/docs/discover/search.asciidoc @@ -60,6 +60,16 @@ Saving searches enables you to reload them into Discover and use them as the bas for <>. 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 <>. + +[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: diff --git a/docs/graph/configuring-graph.asciidoc b/docs/graph/configuring-graph.asciidoc index 78ac70ea1a0f..e012e5a30566 100644 --- a/docs/graph/configuring-graph.asciidoc +++ b/docs/graph/configuring-graph.asciidoc @@ -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. @@ -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 +<>. + +[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 diff --git a/docs/graph/images/graph-read-only-badge.png b/docs/graph/images/graph-read-only-badge.png new file mode 100644 index 000000000000..a4d517cd5fe7 Binary files /dev/null and b/docs/graph/images/graph-read-only-badge.png differ diff --git a/docs/images/dashboard-read-only-badge.png b/docs/images/dashboard-read-only-badge.png new file mode 100644 index 000000000000..b61d587f7ef1 Binary files /dev/null and b/docs/images/dashboard-read-only-badge.png differ diff --git a/docs/images/management-index-read-only-badge.png b/docs/images/management-index-read-only-badge.png new file mode 100644 index 000000000000..54e685894f5e Binary files /dev/null and b/docs/images/management-index-read-only-badge.png differ diff --git a/docs/images/settings-read-only-badge.png b/docs/images/settings-read-only-badge.png new file mode 100644 index 000000000000..449d5199ccb1 Binary files /dev/null and b/docs/images/settings-read-only-badge.png differ diff --git a/docs/images/timelion-read-only-badge.png b/docs/images/timelion-read-only-badge.png new file mode 100644 index 000000000000..19ffbfed6335 Binary files /dev/null and b/docs/images/timelion-read-only-badge.png differ diff --git a/docs/management/advanced-options.asciidoc b/docs/management/advanced-options.asciidoc index ccf1d3428f17..6fa0c1d8da97 100644 --- a/docs/management/advanced-options.asciidoc +++ b/docs/management/advanced-options.asciidoc @@ -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 <>. + +[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 diff --git a/docs/management/index-patterns.asciidoc b/docs/management/index-patterns.asciidoc index 29182b85ec26..efd2968aad27 100644 --- a/docs/management/index-patterns.asciidoc +++ b/docs/management/index-patterns.asciidoc @@ -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 <>. + +[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 diff --git a/docs/timelion/getting-started/timelion-conditional.asciidoc b/docs/timelion/getting-started/timelion-conditional.asciidoc index 87cd18fb7ee6..754d97aa332e 100644 --- a/docs/timelion/getting-started/timelion-conditional.asciidoc +++ b/docs/timelion/getting-started/timelion-conditional.asciidoc @@ -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. diff --git a/docs/timelion/getting-started/timelion-create.asciidoc b/docs/timelion/getting-started/timelion-create.asciidoc index 8d63ce0761a0..5725a99927b3 100644 --- a/docs/timelion/getting-started/timelion-create.asciidoc +++ b/docs/timelion/getting-started/timelion-create.asciidoc @@ -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. diff --git a/docs/timelion/getting-started/timelion-customize.asciidoc b/docs/timelion/getting-started/timelion-customize.asciidoc index 617cc55cd0fd..198a4e27513f 100644 --- a/docs/timelion/getting-started/timelion-customize.asciidoc +++ b/docs/timelion/getting-started/timelion-customize.asciidoc @@ -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. diff --git a/docs/timelion/getting-started/timelion-math.asciidoc b/docs/timelion/getting-started/timelion-math.asciidoc index 561278db07e2..67c336b71696 100644 --- a/docs/timelion/getting-started/timelion-math.asciidoc +++ b/docs/timelion/getting-started/timelion-math.asciidoc @@ -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. diff --git a/docs/timelion/getting-started/timelion-save.asciidoc b/docs/timelion/getting-started/timelion-save.asciidoc index feaeb5468d8d..b8269ae008a5 100644 --- a/docs/timelion/getting-started/timelion-save.asciidoc +++ b/docs/timelion/getting-started/timelion-save.asciidoc @@ -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 <>. + +[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 diff --git a/docs/visualize.asciidoc b/docs/visualize.asciidoc index 893b6f336380..61c409726b5f 100644 --- a/docs/visualize.asciidoc +++ b/docs/visualize.asciidoc @@ -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[] diff --git a/docs/visualize/images/read-only-badge.png b/docs/visualize/images/read-only-badge.png new file mode 100644 index 000000000000..8970105f7443 Binary files /dev/null and b/docs/visualize/images/read-only-badge.png differ diff --git a/docs/visualize/saving.asciidoc b/docs/visualize/saving.asciidoc new file mode 100644 index 000000000000..855555794a6f --- /dev/null +++ b/docs/visualize/saving.asciidoc @@ -0,0 +1,24 @@ +[[save-visualize]] +== Saving Visualizations +Saving visualizations enables you to reload them in Visualize and use them in +<>. + +[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 <>. + +[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*.