XRAY: Offline DB sync steps in Helm installation

XRAY: Offline DB sync steps in Helm installation

Products
JFrog_Xray
Content Type
Installation_Setup
AuthorFullName__c
David Kahan
articleNumber
000006457
FirstPublishedDate
2025-05-29T06:48:33Z
lastModifiedDate
2025-05-27
VersionNumber
1
Introduction 

This article provides a step-by-step guide for updating database synchronization in JFrog Xray when using Helm charts in offline installations. It outlines the necessary procedures to ensure a smooth transition from Docker Compose to Helm deployments.


Steps for Updating Database Sync in Helm Deployments


To perform an offline database sync for JFrog Xray installed via Helm, follow these steps:


1. Download Offline Data: Use the JFrog CLI to download the offline data required for synchronization. The JFROG CLI command is presented in the UI navigate to Administration -> Xray Settings -> Database Sync -> select Offline mode. Ensure that you have the necessary permissions and access to the data source.

2. Copy Data to Xray Server Container: After downloading the offline data, copy it into the Xray server container in the Xray pod. This can be achieved using the kubectl cp command. Below is the example syntax:

kubectl cp <local_offline_data_path> xray/xray-0:/var/opt/jfrog/xray/work/server/updates/v3 -c xray-server

Replace <local_offline_data_path> with the path of the downloaded offline data on your local system.

3. Start the Offline Sync: Once the data is copied, initiate the offline sync process. This can be done either through the Xray UI or programmatically using the REST API or JFrog CLI. For a detailed guide on this process, refer to this knowledge base article.


Recommendations

1. It is advisable to manually run the above steps during your initial setup to validate the process.
2. Once you are confident in the execution of these steps, consider creating a script and scheduling a job to automate the process for regular DB sync updates.