Update Snapshot Bundles
This documentation is for Kyvos 2026.8.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This section explains how to update snapshot bundles in Kyvos Manager to synchronize configuration files and binaries of Kyvos and Kyvos Manager services by pushing the latest updates to the distributed file system (DFS), ensuring consistent configuration across cluster components and supporting recovery or service synchronization.
Note
The km_conf_snapshot.tar.gz bundle has been added.
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.
On this page:
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/
Upload a Snapshot Bundle
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.
Snapshot Bundles
Name and location to find snapshot bundles in DFS
# | Bundle Name | DFS folder Location inside Engine Work directory specified for cluster | Purpose / Contents |
biserver_conf_snapshot.tar.gz | setup/conf/ | BI configurations (bin, conf) | |
biserver_lib_snapshot.tar.gz | setup/binaries/ | BI Binaries/lib (jars) | |
biserver_connections_snapshot.tar.gz | setup/conf/ | BI Connections (Hadoop, DataLake, DBRepo) | |
queryengine_conf_snapshot.tar.gz | setup/conf/ | QE Conf (bin, conf) | |
kyvos_webapp_conf_snapshot.tar.gz | setup/conf/ | Kyvos WebApp Conf | |
kyvos_webapp_binaries_snapshot.tar.gz | setup/binaries/ | Kyvos WebApp binaries (tomcat & Kyvos WebApp) | |
hadoop_connection_conf_snapshot.tar.gz | setup/conf/ | Hadoop conf | |
hadoop_connection_lib_snapshot.tar.gz | setup/binaries/ | Hadoop lib | |
kyvos_commons_snapshot.tar.gz | setup/conf/ | Kyvos commons (Includes Acknowledgement & SanitySuite) | |
kyvos_commons_library.tar.gz | setup/conf/ | Kyvos Commons libraries (jars) | |
jre_snapshot.tar.gz | setup/binaries/ | Jre folder | |
postgres_snapshot.tar.gz | setup/binaries/ | Postgres bundle | |
13. | postgres16_snapshot.tar.gz | setup/binaries/ | Postgres 16 bundle |
km_agent_conf_snapshot.tar.gz | setup/conf/ | Kyvos Manager agent conf | |
km_agent_lib_snapshot.tar.gz | setup/binaries/ | Kyvos Manager agent lib | |
km_agent_mode_conf_snapshot.tar.gz | setup/conf/ | Kyvos Manager agent mode conf | |
km_snapshot.tar.gz | setup/binaries/ | Kyvos Manager snapshot (Kyvos manager application) | |
km_data_snapshot.tar.gz | setup/conf/ | Kyvos Manager Data | |
km_db_snapshot.tar.gz | setup/binaries/ | Kyvos Manager Repo | |
km_conf_snapshot.tar.gz | setup/conf/ | Kyvos Manager configuration | |
dialogsbot_conf_snapshot.tar.gz | setup/conf/ | Dialogs Bot Conf (bin, conf) | |
dialogsbot_lib_snapshot.tar.gz | setup/binaries/ | Dialogs Bot libraries (src, node_modules) | |
dialogsagent_conf_snapshot.tar.gz | setup/conf/ | Dialogs Agent Conf (bin, conf, app) | |
codeexecutor_conf_snapshot.tar.gz | setup/conf/ | Code Executor Conf (bin, conf, app) | |
spark_distribution_snapshot.tar.gz | setup/conf/ | Spark Distribution | |
disaster-recovery-kyvosmanager.sh | setup/scripts/ | Kyvos Manager Disaster Recovery script | |
complete-disaster-recovery.sh | setup/scripts/ | Kyvos Manager Complete Disaster Recovery script | |
kyvosmanager-instance-setup-script.sh | setup/scripts/ | Kyvos Manager Instance Setup script |
Note
Any manual changes that need to be included in snapshots must be applied on the active Kyvos Manager node (the node with the Web Portal role and, when the bundled repository is used, the Postgres role).
Executing start scripts of BI Server and Query Engine has behavior that those download snapshot bundles from DFS to sync their state. If any manual changes were made on the node and not part of the snapshot bundle yet, then executing the start script of BI Server and Query Engine will sync bundles in their startup, and any changes made locally in the same-named files that already exist in the bundle will get lost.
For Web Portal, there are two scripts, start-dc.sh and start-sc_sync.sh in the jakarta/bin folder. When Web Portal service started from Kyvos Manager UI normally, the start-dc.sh will be executed. However, for Services HA or disaster recovery-based Web Portal start, Kyvos Manager will execute the start-dc_sync.sh script.
In different operations that are being performed from Kyvos Manager, those bundles will be uploaded, which contain files that may change during that particular operation.