Using Git in Kyvos
Overview
This section explains how to use a Git-based versioning and backup framework within Kyvos. The feature enables you to systematically manage entity versions, preserve milestone states, restore historical versions, and promote stable configurations across Kyvos environments, using Git as the transport and version-control layer.
By integrating Git, Kyvos enhances backup reliability, traceability, collaboration control, and environment migration, enabling customers to manage and track changes to analytical artifacts more effectively.
The primary objective of this framework is to introduce structured version governance while maintaining the Kyvos repository as the system of record.
Pushing entities from the Kyvos repository to the Git repository
To push entities from the Kyvos repository to the Git repository, perform the following steps.
Click the Toolbox and select Utilities > Push to Git Repository. The Push to Git Repository dialogs box is displayed.
In the Kyvos Repository pane, select the type of entity that you want to push to the Git repository. The available entity types include:
Dataset
Relationships
Semantic Models
After selecting the entity type, the corresponding entities available in Kyvos are displayed. For example, if you select Semantic Models, all semantic models created in Kyvos are listed.
Select the required entity or entities that you want to push to the Git repository. You can select one or multiple entities as needed. The same procedure applies when selecting Datasets or Relationships.
In the Connection field, select the required Git connection.
In the Branch field, select the target branch where the entities will be pushed.
From the Kyvos Repository pane, browse or search for the required entities (for example, datasets).
Select the entities that you want to push. The selected entities are displayed in the Selected Entities to Push section.
Click Check for Conflicts to identify any conflicts between the Kyvos repository and the Git repository.
Review and resolve any detected conflicts, if required.
Click Push Entities to push the selected entities to the Git repository. To remove the selected entities before pushing, click Clear Selection. You can also click Cancel to exit the process without pushing entities.
Pulling Entities from the Git Repository
You can retrieve entities from a Git repository and import them into the Kyvos repository. This allows users to restore entities, synchronize environments, or retrieve previously committed versions.
To pull entities from a Git repository and import them into the Kyvos repository, perform the following steps.
Click the Toolbox and select Utilities > Pull from Git Repository. The Pull from Git Repository dialogs box is displayed.
In the Connection field, select the required Git connection.
In the Source Type field, select either Branch or Tag, depending on the source from which you want to pull entities.
In the Branch (or Tag) field, select the required branch or tag from the Git repository.
Click Fetch Files to load the repository contents. The available entities from the selected branch or tag are displayed.
In the Git Repository pane, select the type of entity that you want to pull from the Git repository. The available entity types include:
Dataset
Relationships
Semantic Models
After selecting the entity type, the corresponding entities available in Git are displayed. For example, if you select Semantic Models, all semantic models available in Git are listed.
Select the required entity or entities that you want to pull from the Git repository. You can select one or multiple entities as needed. The same procedure applies when selecting Datasets or Relationships. The selected entities appear in the Selected Entities to Pull section.
Click Check for Conflicts to detect any conflicts between the Git repository version and the Kyvos repository version.
If conflicts are detected, use one of the following actions:
Keep Git Version – Retains the version available in the Git repository.
Keep Kyvos Version – Retains the version currently available in the Kyvos repository.
Resolve Conflicts – Opens the merge option to review and resolve the differences manually.
After resolving the conflicts, click Merge to finalize the resolution.
Click Pull Entities to import the selected entities into the Kyvos repository. To remove the selected entities before pulling, click Clear Selection. You can also click Cancel to exit the process without pulling entities.