diff --git a/docs/setup/embedding.asciidoc b/docs/setup/embedding.asciidoc index 1b20baf66913a..0c48aeefc9557 100644 --- a/docs/setup/embedding.asciidoc +++ b/docs/setup/embedding.asciidoc @@ -3,10 +3,18 @@ Once you create a dashboard or a visualization, you might want to share it with your colleagues or friends. The easiest way to do this is to share a direct link to your dashboard or visualization. However, some users might not have access to your {kib}. -With the {kib} embedding functionality, you can display the content you created in {kib} to an internal company website or a personal web page. From *Dashboard* or *Visualize*, open the *Share > Embed code* menu, and then click *Copy iFrame code* to generate an HTML code snippet. You can embed this snippet in your web page, and then add analysis, images, and links to give more context to the object you're sharing. +With the {kib} embedding functionality, you can display the content you created in {kib} to an internal company website or a personal web page. -image::images/embed-kibana.png[Generate an HTML snippet to embed {kib}, align=center] +. Open the main menu, then click *Dashboard* or *Visualize Library*. + +. Open the dashboard or visualization you want to embed. +. To generate the HTML code snippet, open the *Share* menu, then click *Embed code > Copy iFrame code*. ++ +You can embed this snippet in your web page, and then add analysis, images, and links to give more context to the object you're sharing. ++ +image::images/embed-kibana.png[Generate an HTML snippet to embed {kib}, align=center] ++ NOTE: Embedding of any other part of {kib} is also generally possible, but you might need to craft the proper HTML code manually. [float] diff --git a/docs/setup/images/embed-kibana.png b/docs/setup/images/embed-kibana.png index f3b0f542361fd..09fa093623e82 100644 Binary files a/docs/setup/images/embed-kibana.png and b/docs/setup/images/embed-kibana.png differ diff --git a/docs/user/dashboard/dashboard.asciidoc b/docs/user/dashboard/dashboard.asciidoc index d65fef9a512d7..75589ad74724c 100644 --- a/docs/user/dashboard/dashboard.asciidoc +++ b/docs/user/dashboard/dashboard.asciidoc @@ -100,7 +100,7 @@ Choose the type of panel you want to create, then save the panel to the dashboar .. Click *Save and return*. -TIP: To access your saved panels, open the main menu, then click *Visualize*. +TIP: To access your saved panels, open the main menu, then click *Visualize Library*. [float] [[arrange-panels]] @@ -182,7 +182,7 @@ dashboard. [role="screenshot"] image:images/clone_panel.gif[clone panel] + -{kib} automatically saves the cloned panel in *Visualize*. To access the cloned panel, open the main menu, then click *Visualize*. +To access the cloned panel, open the main menu, then click *Visualize Library*. [float] [[explore-the-underlying-data]] diff --git a/docs/user/introduction.asciidoc b/docs/user/introduction.asciidoc index 50eb81279fc16..8ab29f375484c 100644 --- a/docs/user/introduction.asciidoc +++ b/docs/user/introduction.asciidoc @@ -203,7 +203,7 @@ so you can tailor it to your specific needs without impacting others. image::images/select-your-space.png[Space selector view] Most of {kib}’s entities are space-aware, including dashboards, visualizations, index patterns, -Canvas workpads, Timelion visualizations, graphs, tags, and machine learning jobs. +*Canvas* workpads, graphs, tags, and machine learning jobs. In addition: @@ -245,7 +245,7 @@ see <>. [float] ==== Log in -Kibana supports several <>, +{kib} supports several <>, allowing you to login using {es}’s built-in realms, or by your own single sign-on provider. [role="screenshot"] diff --git a/docs/user/reporting/automating-report-generation.asciidoc b/docs/user/reporting/automating-report-generation.asciidoc index 4c5a87782618e..6c86da8e214c1 100644 --- a/docs/user/reporting/automating-report-generation.asciidoc +++ b/docs/user/reporting/automating-report-generation.asciidoc @@ -21,7 +21,7 @@ To create the POST URL for PDF reports: . Click *Copy POST URL*. + [role="screenshot"] -image::images/report-automate-pdf.png[Generate Visualize and Dashboard reports] +image::images/report-automate-pdf.png[Automatically generate *Dashboard* and *Visualize Library* reports] To create the POST URL for CSV reports: @@ -51,15 +51,15 @@ include::script-example.asciidoc[] include::response-codes.asciidoc[] [float] -== Deprecated report URLs +=== Deprecated report URLs -The following POST URL paths were once supported but are now deprecated. If there are -any problems with using these paths after upgrading {kib}, use +The following POST URL paths are deprecated. If there are +any problems with using these paths after you upgrade {kib}, use {kib} to regenerate the POST URL for a particular report. -* Dashboard Reports: `/api/reporting/generate/dashboard/` -* Visualization Reports: `/api/reporting/generate/visualization/` -* Saved Search Reports: `/api/reporting/generate/search/` +* Dashboard reports: `/api/reporting/generate/dashboard/` +* Visualize reports: `/api/reporting/generate/visualization/` +* Saved Search reports: `/api/reporting/generate/search/` [IMPORTANT] =================== diff --git a/docs/user/reporting/response-codes.asciidoc b/docs/user/reporting/response-codes.asciidoc index 50a27766f37fb..24a12a3de93a5 100644 --- a/docs/user/reporting/response-codes.asciidoc +++ b/docs/user/reporting/response-codes.asciidoc @@ -1,4 +1,4 @@ -The Reporting APIs use HTTP response codes to give feedback. In automation, +The reporting APIs use HTTP response codes to give feedback. In automation, this helps external systems track the various possible job states: - **`200` (OK)**: As expected, Kibana returns `200` status in the response for diff --git a/docs/user/security/authentication/index.asciidoc b/docs/user/security/authentication/index.asciidoc index 022d1dd47f7ef..b2d85de91b9fc 100644 --- a/docs/user/security/authentication/index.asciidoc +++ b/docs/user/security/authentication/index.asciidoc @@ -382,14 +382,19 @@ xpack.security.authc.providers: [[anonymous-access-and-embedding]] ===== Anonymous access and embedding -One of the most popular use cases for anonymous access is when you embed {kib} into other applications and don't want to force your users to log in to view it. If you configured {kib} to use anonymous access as the sole authentication mechanism, you don't need to do anything special while embedding {kib}. - -If you have multiple authentication providers enabled, and you want to automatically log in anonymous users when embedding dashboards and visualizations, then toggle *Public URL* in the *Share > Embed code* menu in *Dashboard* or *Visualize*. - -You can also use the *Public URL* toggle when you're generating permanent links to dashboards, visualizations, and saved searches. - -NOTE: The *Public URL* toggle is only available if anonymous access is properly configured and your anonymous service account has privileges to access what you want to embed or share. - +One of the most popular use cases for anonymous access is when you embed {kib} into other applications and don't want to force your users to log in to view it. +If you configured {kib} to use anonymous access as the sole authentication mechanism, you don't need to do anything special while embedding {kib}. + +If you have multiple authentication providers enabled, and you want to automatically log in anonymous users when embedding dashboards and visualizations: + +. Open the main menu, then click *Dashboard* or *Visualize Library*. +. Open then dashboard or visualization you want to embed. +. Open the *Share* menu, then click *Embed code > Public URL*. ++ +You can also use *Public URL* when you're generating permanent links to dashboards, visualizations, and saved searches. ++ +NOTE: *Public URL* is available only when anonymous access is configured and your anonymous service account has privileges to access what you want to embed or share. ++ For more information, refer to <>. [[http-authentication]] diff --git a/docs/user/security/authorization/kibana-privileges.asciidoc b/docs/user/security/authorization/kibana-privileges.asciidoc index 21fcb9bdccb87..bbc8ec226fa7c 100644 --- a/docs/user/security/authorization/kibana-privileges.asciidoc +++ b/docs/user/security/authorization/kibana-privileges.asciidoc @@ -1,11 +1,11 @@ [role="xpack"] [[kibana-privileges]] -=== Kibana privileges +=== {kib} privileges {kib} privileges grant users access to features within {kib}. Roles have privileges to determine whether users have write or read access. ==== Base privileges -Assigning a base privilege grants access to all available features in Kibana (Discover, Visualize, Dashboard, and so on). +Assigning a base privilege grants access to all {kib} features, such as *Discover*, *Dashboard*, *Visualize Library*, and *Canvas*. [[kibana-privileges-all]] `all`:: Grants full read-write access. `read`:: Grants read-only access. diff --git a/docs/user/security/images/role-space-visualization.png b/docs/user/security/images/role-space-visualization.png index 0de94d81065fe..36f83f09f064b 100644 Binary files a/docs/user/security/images/role-space-visualization.png and b/docs/user/security/images/role-space-visualization.png differ diff --git a/docs/user/security/rbac_tutorial.asciidoc b/docs/user/security/rbac_tutorial.asciidoc index 2088110f6de21..6324539c3c10a 100644 --- a/docs/user/security/rbac_tutorial.asciidoc +++ b/docs/user/security/rbac_tutorial.asciidoc @@ -74,16 +74,18 @@ should use the index patterns for your indices. image::security/images/role-index-privilege.png["Index privilege"] [float] -==== Give the role permission to create visualizations and dashboards +==== Give the role permissions to {kib} apps -By default, roles do not give Kibana privileges. Click **Add space -privilege** and associate this role with the `Dev Mortgage` space. +To enable users to create dashboards, visualizations, and saved searches, add {kib} privileges to the `dev-mortgage` role. -To enable users with the `dev-mortgage` role to create visualizations -and dashboards, click *All* for *Visualize* and *Dashboard*. Also -assign *All* for *Discover* because it is common for developers -to create saved searches while designing visualizations. +. On the *{kib} privileges* window, select *Dev Mortgage* from the *Space* dropdown. +. Click **Add space privilege**. + +. For *Dashboard*, *Visualize Library*, and *Discover*, click *All*. ++ +It is common to create saved searches in *Discover* while creating visualizations. ++ [role="screenshot"] image::security/images/role-space-visualization.png["Associate space"]