docs: partial snapshot download docs (#5622)

* docs: partial snapshot download docs Signed-off-by: SimoneFiorani <[email protected]> * Update snapshot-management.md * Update snapshot-management.md * Update docs/administration/snapshot-management.md Co-authored-by: Mattia Dal Ben <[email protected]> --------- Signed-off-by: SimoneFiorani <[email protected]> Co-authored-by: Mattia Dal Ben <[email protected]>
eclipse-kura · Dec 17, 2024 · 8eb31b8 · 8eb31b8
1 parent f37d3c1
commit 8eb31b8
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/docs/administration/images/snapshotsDownload.png b/docs/administration/images/snapshotsDownload.png
diff --git a/docs/administration/snapshot-management.md b/docs/administration/snapshot-management.md
@@ -20,7 +20,11 @@ Starting from Kura 5.1, the snapshot can be downloaded in two formats:
 * **XML**: The original XML snapshot format.
 * **JSON**: The JSON format used by the [Configuration v2 REST APIs and CONF-V2 request handler](../references/rest-apis/rest-configuration-service-v2.md). For example the downloaded snapshot can be used as is as a body for the [PUT/configurableComponents/configurations/_update](../references/rest-apis/rest-configuration-service-v2.md) request. The `takeSnapshot` parameter specified by the CONF-V2 request is missing from the downloaded JSON file, if that parameter is not specified, a new snapshot will be created by default.
 
-Pressing the **Download** button will trigger a dialog that allows choosing the desired format.
+Starting with Kura 6.0, it is possible to download _a partial_ version of the snapshot. This allows the user to download a subset of the entire Kura configuration.
+
+In the snapshot download popup, a list of checkboxes is shown, representing the list of all the service configurations that can be downloaded. By default, all configurations (represented by the component PIDs) are selected. The user can remove from the downloaded snapshot the configuration they're not interested in by deselecting the related PIDs checkboxes. The snapshot can be then downloaded in XML or JSON format thorough the dedicated button.
+
+Pressing the **Download** button will trigger a dialog that allows choosing the desired configurations and format.
 
 ![](images/snapshotsDownload.png)