-
Notifications
You must be signed in to change notification settings - Fork 8.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[DOCS] Updates Saved objects docs #45310
Merged
Merged
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,81 +1,81 @@ | ||
[[managing-saved-objects]] | ||
== Managing Saved Objects | ||
== Saved objects | ||
|
||
You can view, edit, delete, import, and export saved objects from | ||
*Management > Saved Objects*. A saved object can be a search, visualization, | ||
dashboard, or index pattern. | ||
A saved object stores your data for use at a later time. A saved object | ||
can be a visualization, dashboard, map, Canvas workpad, and more. | ||
|
||
With *Management > Kibana > Saved Objects*, you can: | ||
|
||
* <<managing-saved-objects-view, View, edit, and delete saved objects>> | ||
* <<managing-saved-objects-export-objects, Import and export saved objects>> | ||
* <<managing-saved-objects-object-definition, Edit the object definition>> | ||
|
||
To narrow the list of saved objects, enter a search term or select an object | ||
type. | ||
|
||
[role="screenshot"] | ||
image::images/management-saved-objects.png[] | ||
image::images/management-saved-objects.png[Saved Objects] | ||
|
||
[float] | ||
[[managing-saved-objects-view]] | ||
=== View, edit, and delete objects | ||
=== View, edit, and delete | ||
|
||
Each object listed in *Saved Objects* has an *Actions* menu with two items: | ||
* To view and edit an object in its associated application, click the object title. | ||
|
||
* *In app* opens the object in its associated application so you can view and | ||
edit it. | ||
* *Relationships* shows other objects that use this object so you know the | ||
impact of deleting it. | ||
* 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*. | ||
|
||
To delete a saved object, select its checkbox and click *Delete*. | ||
* To delete one or more objects, select their checkboxes, and then click *Delete*. | ||
|
||
[float] | ||
[[managing-saved-objects-object-definition]] | ||
=== Edit an object definition | ||
[[managing-saved-objects-export-objects]] | ||
=== Import and export | ||
|
||
*Saved Objects* offers an advanced *Edit* page for modifying the object definition. | ||
To open the page, click the object name in the list of objects. You can change | ||
the object title, add a description, and modify the JSON that defines the | ||
object properties. | ||
Using the import and export commands, 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. | ||
|
||
If you access an object whose index has been deleted, you can: | ||
|
||
* Recreate the index so you can continue using the object. | ||
* Delete the object and recreate it using a different index. | ||
* Change the index name referenced in the object's `kibanaSavedObjectMeta.searchSourceJSON` to point to an existing | ||
index pattern. This is useful if the index you were working with has been renamed. | ||
[float] | ||
==== Import | ||
|
||
WARNING: Validation is not performed for object properties. Submitting an invalid | ||
change will render the object unusable. A more failsafe approach is to use the | ||
*Discover*, *Visualize*, or *Dashboard* pages to create new objects instead of | ||
directly editing an existing one. | ||
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. | ||
|
||
[float] | ||
[[managing-saved-objects-export-objects]] | ||
=== Export and import objects | ||
==== 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 select which object types to export. | ||
|
||
In some cases you might want to export and import a set of save objects. | ||
For example: | ||
This action creates an NDJSON with all your saved objects. By default, | ||
the NDJSON includes related objects. Exported dashboards include their associated index patterns. | ||
|
||
* You might have multiple environments for development and production. The export | ||
and import commands allow you to move objects between different {kib} instances. | ||
* You have a large number of objects to update and want to batch this process. | ||
You can export the objects to JSON, make the JSON modification, and re-import | ||
the objects. | ||
|
||
[float] | ||
==== Export objects | ||
[[managing-saved-objects-object-definition]] | ||
=== Advanced editing | ||
|
||
Select the checkboxes of the objects you want to export, and click *Export*. | ||
Or, to export objects by type: | ||
Some objects offer an advanced *Edit* page for modifying the object definition. | ||
To open the page, click the actions icon image:images/actions_icon.png[Actions icon] | ||
and select *Inspect*. | ||
You can change the object title, add a description, and modify | ||
the JSON that defines the object properties. | ||
|
||
. Click *Export everything*. | ||
. Select the object types you want to export. | ||
. Click *Export All*. | ||
If you access an object whose index has been deleted, you can: | ||
|
||
WARNING: Exported dashboards do not include their associated index patterns. | ||
Re-create the index patterns manually before importing saved dashboards to a | ||
{kib} instance running on another {es} cluster. | ||
* Recreate the index so you can continue using the object. | ||
* Delete the object and recreate it using a different index. | ||
* Change the index name in the object's `reference` array to point to an existing | ||
index pattern. This is useful if the index you were working with has been renamed. | ||
|
||
[float] | ||
==== Import objects | ||
WARNING: Validation is not performed for object properties. Submitting an invalid | ||
change will render the object unusable. A more failsafe approach is to use | ||
*Discover*, *Visualize*, or *Dashboard* to create new objects instead of | ||
directly editing an existing one. | ||
|
||
. Click *Import*. | ||
. Navigate to the JSON file that represents the objects to import. | ||
. Indicate whether to overwrite objects already in {kib}. | ||
. Click *Import*. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: we could rename the file and related image file to remove
management
in its name.