mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 17:28:26 -04:00
* [DOCS] Updates saved objects doc
* [DOCS] Edtis tags doc
* [DOCS] Removes video from discover docs
* Update docs/management/managing-saved-objects.asciidoc
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
* Update docs/management/managing-saved-objects.asciidoc
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
* Update docs/management/managing-saved-objects.asciidoc
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
* Update docs/management/managing-saved-objects.asciidoc
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
* Update docs/management/managing-saved-objects.asciidoc
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
* Update docs/management/managing-tags.asciidoc
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
* Update docs/management/managing-tags.asciidoc
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
* Update docs/management/managing-saved-objects.asciidoc
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
* Update docs/management/managing-tags.asciidoc
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
* Update docs/management/managing-tags.asciidoc
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
* Update docs/management/managing-tags.asciidoc
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
* Update docs/management/managing-saved-objects.asciidoc
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
* Update docs/management/managing-saved-objects.asciidoc
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
* Update docs/management/managing-saved-objects.asciidoc
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
* Update docs/management/managing-saved-objects.asciidoc
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
* Update docs/management/managing-saved-objects.asciidoc
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
* Update docs/management/managing-saved-objects.asciidoc
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
* Update docs/management/managing-saved-objects.asciidoc
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
* Update docs/management/managing-saved-objects.asciidoc
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
* [DOCS] Incorporates review comments
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
(cherry picked from commit e4c7bbf75e)
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
This commit is contained in:
Kibana Machine
GitHub
parent
8c4e2f42e5
commit
4d2b1f6d45
4 changed files with 96 additions and 86 deletions
|
|
@ -3,23 +3,11 @@
|
|||
|
||||
|
||||
*Discover* displays your documents in table format, so you can
|
||||
best explore your data.
|
||||
Use the document table to resize columns, set row height,
|
||||
best explore your data. Resize columns, set row height,
|
||||
perform multi-column sorting, compare data, and more.
|
||||
|
||||
++++
|
||||
<script type="text/javascript" async src="https://play.vidyard.com/embed/v4.js">
|
||||
</script>
|
||||
<img
|
||||
style="width: 100%; margin: auto; display: block;"
|
||||
class="vidyard-player-embed"
|
||||
src="https://play.vidyard.com/KbZQP6Y7msjevAm1JGbKeG.jpg"
|
||||
data-uuid="KbZQP6Y7msjevAm1JGbKeG"
|
||||
data-v="4"
|
||||
data-type="inline"
|
||||
/>
|
||||
</br>
|
||||
++++
|
||||
[role="screenshot"]
|
||||
image:images/customer.png[Customer last name, first initial in the document table]
|
||||
|
||||
[float]
|
||||
[[document-explorer-columns]]
|
||||
|
|
|
|||
|
|
@ -1,11 +1,10 @@
|
|||
[[managing-saved-objects]]
|
||||
== Saved Objects
|
||||
== Manage saved objects
|
||||
|
||||
The *Saved Objects* UI helps you keep track of and manage your saved objects. These objects
|
||||
store data for later use, including dashboards, visualizations, maps, data views,
|
||||
Canvas workpads, and more.
|
||||
Edit, import, export, and copy your saved objects. These objects include
|
||||
dashboards, visualizations, maps, {data-sources}, *Canvas* workpads, and other saved objects.
|
||||
|
||||
To get started, open the main menu, then click *Stack Management > Saved Objects*.
|
||||
To get started, open the main menu, and then click *Stack Management > Saved Objects*.
|
||||
|
||||
[role="screenshot"]
|
||||
image::images/management-saved-objects.png[Saved Objects]
|
||||
|
|
@ -13,23 +12,24 @@ image::images/management-saved-objects.png[Saved Objects]
|
|||
[float]
|
||||
=== Required permissions
|
||||
|
||||
The `Saved Objects Management` {kib} privilege is required to access the *Saved Objects* UI.
|
||||
To access *Saved Objects*, you must have the required `Saved Objects Management` {kib} privilege.
|
||||
|
||||
To add the privilege, open the menu, then click *Stack Management > Roles*.
|
||||
To add the privilege, open the main menu, and then click *Stack Management > Roles*.
|
||||
|
||||
NOTE:
|
||||
Granting access to Saved Objects Management will authorize users to manage all saved objects in {kib}, including objects that are managed by applications they may not otherwise be authorized to access.
|
||||
NOTE: Granting access to `Saved Objects Management` authorizes users to
|
||||
manage all saved objects in {kib}, including objects that are managed by
|
||||
applications they may not otherwise be authorized to access.
|
||||
|
||||
|
||||
[float]
|
||||
[[managing-saved-objects-view]]
|
||||
=== View and delete
|
||||
|
||||
* To view and edit an object in its associated application, click the object title.
|
||||
* To view and edit a saved object in its associated application, click the object title.
|
||||
|
||||
* To show objects that use this object, so you know the
|
||||
impact of deleting it, click the actions icon image:images/actions_icon.png[Actions icon]
|
||||
and select *Relationships*.
|
||||
and then select *Relationships*.
|
||||
|
||||
* To delete one or more objects, select their checkboxes, and then click *Delete*.
|
||||
|
||||
|
|
@ -37,21 +37,57 @@ and select *Relationships*.
|
|||
[[managing-saved-objects-export-objects]]
|
||||
=== Import and export
|
||||
|
||||
Using the import and export actions, you can move objects between different
|
||||
{kib} instances. This action is useful when you
|
||||
have multiple environments for development and production.
|
||||
Import and export also work well when you have a large number
|
||||
of objects to update and want to batch the process.
|
||||
Use import and export to move objects between different {kib} instances.
|
||||
These actions are useful when you have multiple environments for development and production.
|
||||
Import and export also work well when you have a large number of objects to update and want to batch the process.
|
||||
|
||||
In addition to the user interface, {kib} provides beta <<saved-objects-api-import, import>> and <<saved-objects-api-export, export>> APIs if
|
||||
you want to automate this process.
|
||||
{kib} also provides <<saved-objects-api-import, import>> and
|
||||
<<saved-objects-api-export, export>> APIs to automate this process.
|
||||
|
||||
|
||||
[float]
|
||||
==== Import
|
||||
|
||||
Import multiple objects in a single operation.
|
||||
|
||||
. In the toolbar, click *Import*.
|
||||
. Select the NDJSON file that
|
||||
includes the objects you want to import.
|
||||
. Select the import options. By default,
|
||||
saved objects already in {kib} are overwritten.
|
||||
. Click *Import*.
|
||||
|
||||
NOTE: The <<savedObjects-maxImportExportSize, `savedObjects.maxImportExportSize`>> configuration setting
|
||||
limits the number of saved objects to include in the file. The
|
||||
<<savedObjects-maxImportPayloadBytes, `savedObjects.maxImportPayloadBytes`>> setting limits the overall
|
||||
size of the file that you can import.
|
||||
|
||||
|
||||
[float]
|
||||
==== Export
|
||||
|
||||
Export objects by selection or type.
|
||||
|
||||
* To export specific objects, select them in the table, and then click *Export*.
|
||||
* To export objects by type, click *Export objects* in the toolbar.
|
||||
|
||||
{kib} creates an NDJSON with all your saved objects. By default, the NDJSON includes child objects related to the saved
|
||||
objects. Exported dashboards include their associated {data-sources}.
|
||||
|
||||
NOTE: The <<savedObjects-maxImportExportSize, `savedObjects.maxImportExportSize`>> configuration setting
|
||||
limits the number of saved objects that you can export.
|
||||
|
||||
[float]
|
||||
==== Compatibility across versions
|
||||
|
||||
With each release, {kib} introduces changes to the way saved objects are stored. When importing a saved object, {kib} will run the necessary migrations to ensure that the imported saved objects are compatible with the current version.
|
||||
With each release, {kib} introduces changes to the way saved objects are stored.
|
||||
When importing a saved object, {kib} runs the necessary migrations to ensure
|
||||
that the imported saved objects are compatible with the current version.
|
||||
|
||||
However, saved objects can only be imported into the same version, a newer minor on the same major, or the next major. Exported saved objects are not backwards compatible and cannot be imported into an older version of {kib}. See the table below for compatibility examples:
|
||||
However, saved objects can only be imported into the same version,
|
||||
a newer minor on the same major, or the next major.
|
||||
Exported saved objects are not backward compatible and cannot be imported
|
||||
into an older version of {kib}. For example:
|
||||
|
||||
|=======
|
||||
| Exporting version | Importing version | Compatible?
|
||||
|
|
@ -62,33 +98,6 @@ However, saved objects can only be imported into the same version, a newer minor
|
|||
| 6.8.1 | 8.0.0 | No
|
||||
|=======
|
||||
|
||||
[float]
|
||||
==== Import
|
||||
|
||||
You can import multiple objects in a single operation. Click *Import* and
|
||||
navigate to the NDJSON file that
|
||||
represents the objects to import. By default,
|
||||
saved objects already in {kib} are overwritten.
|
||||
|
||||
NOTE: The <<savedObjects-maxImportExportSize, `savedObjects.maxImportExportSize`>> configuration setting
|
||||
limits the number of saved objects which may be included in this file. Similarly, the
|
||||
<<savedObjects-maxImportPayloadBytes, `savedObjects.maxImportPayloadBytes`>> setting limits the overall
|
||||
size of the file that can be imported.
|
||||
|
||||
|
||||
[float]
|
||||
==== Export
|
||||
|
||||
You have two options for exporting saved objects.
|
||||
|
||||
* Select the checkboxes of objects that you want to export, and then click *Export*.
|
||||
* Click *Export x objects*, and export objects by type.
|
||||
|
||||
This action creates an NDJSON with all your saved objects. By default, the NDJSON includes child objects that are related to the saved
|
||||
objects. Exported dashboards include their associated data views.
|
||||
|
||||
NOTE: The <<savedObjects-maxImportExportSize, `savedObjects.maxImportExportSize`>> configuration setting
|
||||
limits the number of saved objects which may be exported.
|
||||
|
||||
|
||||
[float]
|
||||
|
|
@ -96,12 +105,16 @@ limits the number of saved objects which may be exported.
|
|||
[[managing-saved-objects-copy-to-space]]
|
||||
=== Copy to other {kib} spaces
|
||||
|
||||
To copy a saved object to another space, click the actions icon image:images/actions_icon.png[Actions icon]
|
||||
and select *Copy to spaces*. From here, you can select the spaces in which to copy the object.
|
||||
You can also select whether to automatically overwrite any conflicts in the target spaces, or
|
||||
resolve them manually.
|
||||
Copy saved objects and their related objects between spaces.
|
||||
|
||||
WARNING: The copy operation automatically includes child objects that are related to the saved objects. If you don't want this behavior, use
|
||||
. Click the actions icon image:images/actions_icon.png[Actions icon].
|
||||
. Click *Copy to spaces*.
|
||||
. Select the spaces in which to copy the object.
|
||||
. Specify whether to automatically overwrite any objects that already exist
|
||||
in the target spaces, or resolve them on a per-object basis.
|
||||
+
|
||||
The copy operation automatically includes child objects that are related to
|
||||
the saved object. If you don't want this behavior, use
|
||||
the <<spaces-api-copy-saved-objects, copy saved objects to space API>> instead.
|
||||
|
||||
[float]
|
||||
|
|
@ -109,13 +122,18 @@ the <<spaces-api-copy-saved-objects, copy saved objects to space API>> instead.
|
|||
[[managing-saved-objects-share-to-space]]
|
||||
=== Share to other {kib} spaces
|
||||
|
||||
To share a saved object to another space -- which makes a single saved object available in multiple spaces -- click the actions icon
|
||||
image:images/actions_icon.png[Actions icon] and select *Share to spaces*. From here, you can select the spaces in which to share the object,
|
||||
or indicate that you want the object to be shared to _all spaces_, which includes those that exist now and any created in the future.
|
||||
Make a single saved object available in multiple spaces.
|
||||
|
||||
Not all saved object types are shareable. If an object is shareable, the Spaces column shows which spaces it exists in. You can also click
|
||||
. Click the actions icon
|
||||
image:images/actions_icon.png[Actions icon].
|
||||
. Select *Share to spaces*.
|
||||
. Select the spaces in which to share the object.
|
||||
Or, indicate that you want the object to be shared to _all spaces_,
|
||||
which includes those that exist now and any created in the future.
|
||||
+
|
||||
Not all saved object types are shareable. If an object is shareable, the *Spaces* column shows where the object exists. You can click
|
||||
those space icons to open the Share UI.
|
||||
|
||||
WARNING: The share operation automatically includes child objects that are related to the saved objects.
|
||||
+
|
||||
The share operation automatically includes child objects that are related to the saved objects.
|
||||
|
||||
include::saved-objects/saved-object-ids.asciidoc[]
|
||||
|
|
|
|||
|
|
@ -2,8 +2,10 @@
|
|||
[[managing-tags]]
|
||||
== Tags
|
||||
|
||||
Tags enable you to categorize your saved objects.
|
||||
You can then filter for related objects based on shared tags.
|
||||
Use tags to categorize your saved objects,
|
||||
then filter for related objects based on shared tags.
|
||||
|
||||
To get started, open the main menu, and then click *Stack Management > Tags*.
|
||||
|
||||
[role="screenshot"]
|
||||
image::images/tags/tag-management-section.png[Tags management]
|
||||
|
|
@ -29,7 +31,6 @@ from the global search.
|
|||
|
||||
Create a tag to assign to your saved objects.
|
||||
|
||||
. Open the main menu, and then click *Stack Management > Tags*.
|
||||
. Click *Create tag*.
|
||||
|
||||
. Enter a name and select a color for the new tag.
|
||||
|
|
@ -41,23 +42,21 @@ The name cannot be longer than 50 characters.
|
|||
[[settings-assign-tag]]
|
||||
=== Assign a tag to an object
|
||||
|
||||
To assign and remove tags from saved objects, you must have `write` permission
|
||||
To assign and remove tags, you must have `write` permission
|
||||
on the objects to which you assign the tags.
|
||||
|
||||
. In the *Tags* view, find the tag you want to assign.
|
||||
. Click the action menu (...) in the tag row,
|
||||
and then select the *Manage assignments* action.
|
||||
. Find the tag you want to assign.
|
||||
. Click the actions icon
|
||||
image:images/actions_icon.png[Actions icon],
|
||||
and then select *Manage assignments*.
|
||||
|
||||
. Select the objects to which you want to assign or remove tags.
|
||||
+
|
||||
[role="screenshot"]
|
||||
image::images/tags/manage-assignments-flyout.png[Assign flyout]
|
||||
image::images/tags/manage-assignments-flyout.png[Assign flyout, width=75%]
|
||||
|
||||
. Click *Save tag assignments*.
|
||||
|
||||
TIP: To assign, delete, or clear multiple tags at once,
|
||||
select their checkboxes in the *Tags* view, and then select
|
||||
the desired action from the *selected tags* menu.
|
||||
|
||||
[float]
|
||||
[[settings-delete-tag]]
|
||||
|
|
@ -65,6 +64,11 @@ the desired action from the *selected tags* menu.
|
|||
|
||||
When you delete a tag, you remove it from all saved objects that use it.
|
||||
|
||||
. Click the action menu (...) in the tag row, and then select the *Delete* action.
|
||||
. Click the actions icon
|
||||
image:images/actions_icon.png[Actions icon], and then select *Delete*.
|
||||
|
||||
. Click *Delete tag*.
|
||||
|
||||
TIP: To assign, delete, or clear multiple tags,
|
||||
select them in the *Tags* view, and then select
|
||||
the action from the *selected tags* menu.
|
||||
|
|
|
|||
|
|
@ -95,7 +95,7 @@ a field, select *Edit Settings*, and change *Terms per hop*.
|
|||
Documents that match a blocked term are not allowed in the graph.
|
||||
To block a term, select its vertex and click
|
||||
the block icon
|
||||
image:user/graph/images/graph-block-button.png[Block selection]
|
||||
image:user/graph/images/graph-block-button.png[Block list]
|
||||
in the control panel.
|
||||
For a list of blocked terms, go to *Settings > Blocked terms*.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue