Update Snapshot Bundles

Applies to: Kyvos Enterprise Kyvos Cloud (SaaS on AWS) Kyvos AWS Marketplace

Kyvos Azure Marketplace Kyvos GCP Marketplace Kyvos Single Node Installation (Kyvos SNI)

Note

From Kyvos 2024.1, the km_conf_snapshot.tar.gz bundle has been added.
From Kyvos 2023.3 onwards, you can see the last performed snapshot bundle operation details, including progress status and start time, by clicking the i icon located next to the Revert button. To view more comprehensive details, simply click the View Details link, which will take you to the Operations page, where you can view the operation information in detail.

Kyvos Manager creates snapshot bundles of configuration files and binaries of various Kyvos and Kyvos Manager services. These snapshots are used for various purposes like recovery during Disaster recovery and component state sync after scheduled cluster up. Engine components during their bootup ensure that the state of configuration and binary files are always in sync by downloading the latest state of snapshot bundles from the distributed file system (DFS). Whenever any change is made in configuration or binary files from the Kyvos Manager, then the Kyvos Manager automatically updates all those snapshot bundles in DFS that involve the change.

Additionally, Kyvos Manager allows you to perform on-demand updates of snapshot bundles. Using this functionality, you can explicitly push any such manual changes applied in files to their respective snapshot bundles stored on the DFS. The dedicated UI lets you specify the snapshot bundles that need to be created and updated in the DFS. All the update snapshot logs are also maintained in the operation logs and show information about the success/failure of each snapshot bundle update.

Snapshots are currently uploaded at the <ENGINE_WORK_DIR>/setup/ inside the conf or binary folder. The default value for ENGINE_WORK_DIR is user/engine_work/
This makes the resultant path in DFS as /user/engine_work/setup/conf/ or /user/engine_work/setup/binary/

To update a snapshot bundle, perform the following steps:

On the navigation bar, click Utilities > Update Snapshot Bundles.
On the Update Snapshots page, use the checkboxes to select the services for which you want to update snapshots, and click Update Selected.
Alternatively, to update the snapshot bundles for all the Kyvos and Kyvos Manager services, click the Update All button.
Use the Expand and Collapse button to see details of services that will be updated.
Use the i icon to see the details of the files that will be updated.
When prompted, provide your Password to continue.

You can view the execution status on the Operations page.

Operation Details

The Operation details page shows the execution status using the Show/Details button.

You can click the Refresh button to continually refresh the operations list.

To view the operation details of the updated snapshot logs, perform the following steps:

On the navigation bar, click Monitor and Alerts > Monitor. The Monitor page is displayed.
Click the Operations tab. The page contains the list of all operations.
Select the operation and click the Show Details button to view the Summary and Log details.
Use the Navigation to Configuration link to navigate to the Kyvos Cluster page to view the cluster details.