|
1 | 1 | [[managing-saved-objects]]
|
2 |
| -== Saved Objects |
| 2 | +== Manage saved objects |
3 | 3 |
|
4 |
| -The *Saved Objects* UI helps you keep track of and manage your saved objects. These objects |
5 |
| -store data for later use, including dashboards, visualizations, maps, data views, |
6 |
| -Canvas workpads, and more. |
| 4 | +Edit, import, export, and copy your saved objects. These objects include |
| 5 | +dashboards, visualizations, maps, {data-sources}, *Canvas* workpads, and other saved objects. |
7 | 6 |
|
8 |
| -To get started, open the main menu, then click *Stack Management > Saved Objects*. |
| 7 | +To get started, open the main menu, and then click *Stack Management > Saved Objects*. |
9 | 8 |
|
10 | 9 | [role="screenshot"]
|
11 | 10 | image::images/management-saved-objects.png[Saved Objects]
|
12 | 11 |
|
13 | 12 | [float]
|
14 | 13 | === Required permissions
|
15 | 14 |
|
16 |
| -The `Saved Objects Management` {kib} privilege is required to access the *Saved Objects* UI. |
| 15 | +To access *Saved Objects*, you must have the required `Saved Objects Management` {kib} privilege. |
17 | 16 |
|
18 |
| -To add the privilege, open the menu, then click *Stack Management > Roles*. |
| 17 | +To add the privilege, open the main menu, and then click *Stack Management > Roles*. |
19 | 18 |
|
20 |
| -NOTE: |
21 |
| -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. |
| 19 | +NOTE: Granting access to `Saved Objects Management` authorizes users to |
| 20 | +manage all saved objects in {kib}, including objects that are managed by |
| 21 | +applications they may not otherwise be authorized to access. |
22 | 22 |
|
23 | 23 |
|
24 | 24 | [float]
|
25 | 25 | [[managing-saved-objects-view]]
|
26 | 26 | === View and delete
|
27 | 27 |
|
28 |
| -* To view and edit an object in its associated application, click the object title. |
| 28 | +* To view and edit a saved object in its associated application, click the object title. |
29 | 29 |
|
30 | 30 | * To show objects that use this object, so you know the
|
31 | 31 | impact of deleting it, click the actions icon image:images/actions_icon.png[Actions icon]
|
32 |
| -and select *Relationships*. |
| 32 | +and then select *Relationships*. |
33 | 33 |
|
34 | 34 | * To delete one or more objects, select their checkboxes, and then click *Delete*.
|
35 | 35 |
|
36 | 36 | [float]
|
37 | 37 | [[managing-saved-objects-export-objects]]
|
38 | 38 | === Import and export
|
39 | 39 |
|
40 |
| -Using the import and export actions, you can move objects between different |
41 |
| -{kib} instances. This action is useful when you |
42 |
| -have multiple environments for development and production. |
43 |
| -Import and export also work well when you have a large number |
44 |
| -of objects to update and want to batch the process. |
| 40 | +Use import and export to move objects between different {kib} instances. |
| 41 | +These actions are useful when you have multiple environments for development and production. |
| 42 | +Import and export also work well when you have a large number of objects to update and want to batch the process. |
45 | 43 |
|
46 |
| -In addition to the user interface, {kib} provides beta <<saved-objects-api-import, import>> and <<saved-objects-api-export, export>> APIs if |
47 |
| -you want to automate this process. |
| 44 | +{kib} also provides <<saved-objects-api-import, import>> and |
| 45 | +<<saved-objects-api-export, export>> APIs to automate this process. |
48 | 46 |
|
49 |
| -[float] |
50 |
| -==== Compatibility across versions |
51 |
| - |
52 |
| -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. |
53 |
| - |
54 |
| -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: |
55 |
| - |
56 |
| -|======= |
57 |
| -| Exporting version | Importing version | Compatible? |
58 |
| -| 6.7.0 | 6.8.1 | Yes |
59 |
| -| 6.8.1 | 7.3.0 | Yes |
60 |
| -| 7.3.0 | 7.11.1 | Yes |
61 |
| -| 7.11.1 | 7.6.0 | No |
62 |
| -| 6.8.1 | 8.0.0 | No |
63 |
| -|======= |
64 | 47 |
|
65 | 48 | [float]
|
66 | 49 | ==== Import
|
67 | 50 |
|
68 |
| -You can import multiple objects in a single operation. Click *Import* and |
69 |
| -navigate to the NDJSON file that |
70 |
| -represents the objects to import. By default, |
| 51 | +Import multiple objects in a single operation. |
| 52 | + |
| 53 | +. In the toolbar, click *Import*. |
| 54 | +. Select the NDJSON file that |
| 55 | +includes the objects you want to import. |
| 56 | +. Select the import options. By default, |
71 | 57 | saved objects already in {kib} are overwritten.
|
| 58 | +. Click *Import*. |
72 | 59 |
|
73 | 60 | NOTE: The <<savedObjects-maxImportExportSize, `savedObjects.maxImportExportSize`>> configuration setting
|
74 |
| -limits the number of saved objects which may be included in this file. Similarly, the |
| 61 | +limits the number of saved objects to include in the file. The |
75 | 62 | <<savedObjects-maxImportPayloadBytes, `savedObjects.maxImportPayloadBytes`>> setting limits the overall
|
76 |
| -size of the file that can be imported. |
| 63 | +size of the file that you can import. |
77 | 64 |
|
78 | 65 |
|
79 | 66 | [float]
|
80 | 67 | ==== Export
|
81 | 68 |
|
82 |
| -You have two options for exporting saved objects. |
| 69 | +Export objects by selection or type. |
83 | 70 |
|
84 |
| -* Select the checkboxes of objects that you want to export, and then click *Export*. |
85 |
| -* Click *Export x objects*, and export objects by type. |
| 71 | +* To export specific objects, select them in the table, and then click *Export*. |
| 72 | +* To export objects by type, click *Export objects* in the toolbar. |
86 | 73 |
|
87 |
| -This action creates an NDJSON with all your saved objects. By default, the NDJSON includes child objects that are related to the saved |
88 |
| -objects. Exported dashboards include their associated data views. |
| 74 | +{kib} creates an NDJSON with all your saved objects. By default, the NDJSON includes child objects related to the saved |
| 75 | +objects. Exported dashboards include their associated {data-sources}. |
89 | 76 |
|
90 | 77 | NOTE: The <<savedObjects-maxImportExportSize, `savedObjects.maxImportExportSize`>> configuration setting
|
91 |
| -limits the number of saved objects which may be exported. |
| 78 | +limits the number of saved objects that you can export. |
| 79 | + |
| 80 | +[float] |
| 81 | +==== Compatibility across versions |
| 82 | + |
| 83 | +With each release, {kib} introduces changes to the way saved objects are stored. |
| 84 | +When importing a saved object, {kib} runs the necessary migrations to ensure |
| 85 | +that the imported saved objects are compatible with the current version. |
| 86 | + |
| 87 | +However, saved objects can only be imported into the same version, |
| 88 | +a newer minor on the same major, or the next major. |
| 89 | +Exported saved objects are not backward compatible and cannot be imported |
| 90 | +into an older version of {kib}. For example: |
| 91 | + |
| 92 | +|======= |
| 93 | +| Exporting version | Importing version | Compatible? |
| 94 | +| 6.7.0 | 6.8.1 | Yes |
| 95 | +| 6.8.1 | 7.3.0 | Yes |
| 96 | +| 7.3.0 | 7.11.1 | Yes |
| 97 | +| 7.11.1 | 7.6.0 | No |
| 98 | +| 6.8.1 | 8.0.0 | No |
| 99 | +|======= |
| 100 | + |
92 | 101 |
|
93 | 102 |
|
94 | 103 | [float]
|
95 | 104 | [role="xpack"]
|
96 | 105 | [[managing-saved-objects-copy-to-space]]
|
97 | 106 | === Copy to other {kib} spaces
|
98 | 107 |
|
99 |
| -To copy a saved object to another space, click the actions icon image:images/actions_icon.png[Actions icon] |
100 |
| -and select *Copy to spaces*. From here, you can select the spaces in which to copy the object. |
101 |
| -You can also select whether to automatically overwrite any conflicts in the target spaces, or |
102 |
| -resolve them manually. |
| 108 | +Copy saved objects and their related objects between spaces. |
103 | 109 |
|
104 |
| -WARNING: The copy operation automatically includes child objects that are related to the saved objects. If you don't want this behavior, use |
| 110 | +. Click the actions icon image:images/actions_icon.png[Actions icon]. |
| 111 | +. Click *Copy to spaces*. |
| 112 | +. Select the spaces in which to copy the object. |
| 113 | +. Specify whether to automatically overwrite any objects that already exist |
| 114 | +in the target spaces, or resolve them on a per-object basis. |
| 115 | ++ |
| 116 | +The copy operation automatically includes child objects that are related to |
| 117 | +the saved object. If you don't want this behavior, use |
105 | 118 | the <<spaces-api-copy-saved-objects, copy saved objects to space API>> instead.
|
106 | 119 |
|
107 | 120 | [float]
|
108 | 121 | [role="xpack"]
|
109 | 122 | [[managing-saved-objects-share-to-space]]
|
110 | 123 | === Share to other {kib} spaces
|
111 | 124 |
|
112 |
| -To share a saved object to another space -- which makes a single saved object available in multiple spaces -- click the actions icon |
113 |
| -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, |
114 |
| -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. |
| 125 | +Make a single saved object available in multiple spaces. |
115 | 126 |
|
116 |
| -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 |
| 127 | +. Click the actions icon |
| 128 | +image:images/actions_icon.png[Actions icon]. |
| 129 | +. Select *Share to spaces*. |
| 130 | +. Select the spaces in which to share the object. |
| 131 | +Or, indicate that you want the object to be shared to _all spaces_, |
| 132 | +which includes those that exist now and any created in the future. |
| 133 | ++ |
| 134 | +Not all saved object types are shareable. If an object is shareable, the *Spaces* column shows where the object exists. You can click |
117 | 135 | those space icons to open the Share UI.
|
118 |
| - |
119 |
| -WARNING: The share operation automatically includes child objects that are related to the saved objects. |
| 136 | ++ |
| 137 | +The share operation automatically includes child objects that are related to the saved objects. |
120 | 138 |
|
121 | 139 | include::saved-objects/saved-object-ids.asciidoc[]
|
0 commit comments