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
AI Space
Workbooks
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.
From the Kyvos Repository pane, browse or search for the required entities (for example, datasets).
In the Connection field, select the required Git connection.
In the Branch field, select the target branch where the entities will be pushed.
Select the entities that you want to push. The selected entities are displayed in the Selected Entities to Push section. To remove the selected entities before pushing, click Clear Selection. You can also click Cancel to exit the process without pushing entities.
Review the selected entities and the target Git branch in the Push to Git Repository page.
Click Push Entities to push the selected entities to the Git repository. The Confirm to push dialog box is displayed.
In the Confirm to Push dialog box, verify the Target Branch.
Enter a meaningful description in the Commit Message box.
(Optional) Select Save to Kyvos Repository to save the changes to the Kyvos repository before pushing.
(Optional) Select Create tag to create a Git tag that should include some meaningful description for the commit. Kyvos recommends adding a tag whenever you push Kyvos entities.
Click Push to Git to push the selected entities to the Git repository. Click Cancel to close the dialog without pushing the changes.
In case you encounter conflicts, refer to Resolving Git Conflicts during Push.
Pushing to a new branch
You can create a new Git branch directly from the Kyvos UI during a push operation to organize and manage changes efficiently in the Git repository.
To create a new Git branch during push operation, perform the following steps.
Open the Push to Git Repository page.
From the Branch drop-down list, click Push to New Branch.
The New Branch dialog box is displayed.Select one of the following branch creation options:
Existing Branch: Create a new branch from an existing branch.
Empty Branch: Create a new empty branch.
If you select Existing Branch, choose the source branch from the From drop-down list.
In the Branch Name field, enter the name of the new branch.
Click Create Branch.
The new branch is created and selected for the push operation.
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
AI Space
Workbook
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.
If conflicts are detected, use one of the following actions:
Keep Git Version – Retains the version available in the Git repository.
Keep loca – Retains the version currently available in the Kyvos repository.
Merge – Opens the merge option to review and resolve the differences manually.
After resolving the conflicts, click Mark as Resolved to finalize the resolution.
Click Pull Entities to import the selected entities into the Kyvos repository. To uncheck the selected entities, click Clear Selection. You can also click Cancel to exit the process without pulling entities.
Resolving Git Conflicts
When conflicts are detected between the Kyvos repository and the selected Git branch, you must resolve them before completing the push or pull operation.
Select the entities that you want to push to the Git repository.
In the Selected Entities to Push section, review the entities marked with a conflict indicator (red warning icon).
Expand the conflicted entity to view the individual files that contain conflicts.
For each conflicted file, choose one of the following options:
Keep Local– Retains the version from the Kyvos repository.
Keep Git– Retains the version from the Git repository.
Merge – Opens the merge interface to manually review and merge changes from both versions and then click Mark as resolved. The tick icon
indicates the changes have been merged.
Repeat the conflict resolution process for all conflicted files.
To apply the same action to all conflicted files, click the Actions menu (…) and select:
Keep Local for All
Keep Git for All
Reset to clear previously selected conflict resolutions.
Verify that all conflict indicators are resolved and replaced with tick indicators
Once all conflicts are resolved, click Push Entities to complete the push operation.
Click Cancel to exit without pushing changes.
Note: The Push Entities button remains unavailable until all conflicts have been resolved.