Gateway Upgrade Process

In this Article

• Detailed Steps for Gateway Upgrade
  1. Preparation
  2. Configuration
  3. Installation
  4. Verify the Upgrade
• Notes on Certificate Handling

Detailed Steps for Gateway Upgrade

1. Preparation

Step 1: Download the New Gateway Version

Download the latest gateway version. DvSum Gateway Installer Links.

.\dvsum_gateway_setup.bat uninstall

./dvsum_gateway_setup.sh uninstall

.\dvsum_gateway_setup.bat status

./dvsum_gateway_setup.sh status

Before proceeding, create a backup of your existing Gateway installation folder.

Windows

Rename or move the existing Gateway installation folder to a backup location.

Example:

dvsum_gateway
↓
dvsum_gateway_2.1.0

Linux

mv dvsum_gateway/ dvsum_gateway_2.1.0/

2. Configuration

Windows

Step 1: Set up a New Folder for the Latest Gateway

Create a new folder for the latest gateway files.

Step 2: Extract the Gateway Files

Extract the downloaded .zip file to the new folder. Avoid using the Downloads folder.

Step 3: Migrate Previous Configuration

Copy the following files from the previous Gateway installation folder to the new Gateway folder:

• configuration.properties
• ssl_config.properties

If you are using a CA-signed certificate, also copy your existing keystore or certificate files (for example, my_domain.jks) to the new Gateway folder.

copy dvsum_gateway_2.1.0\my_domain.jks dvsum_gateway_2.1.1\

Step 4: Migrate Existing Scan and Chat Information

If available, copy the following folders from the previous Gateway installation:

• data_analysis
• dq_analysis
• scan_output

Note: Not all Gateway installations contain these folders. Copy only the folders that exist in your environment.

Linux

Step 1: Set up a New Folder for the Latest Gateway

Create a new folder for the latest gateway installation:

mkdir dvsum_gateway

Step 2: Extract the Gateway Files

Extract the .tar.gz file into the newly created folder:

tar -xzf dvsum_gateway_latest.tar.gz -C dvsum_gateway/

Step 3: Migrate Previous Configuration

Copy the following files from the previous Gateway installation folder to the new Gateway folder:

• configuration.properties
• ssl_config.properties

If you are using a CA-signed certificate, also copy your existing keystore or certificate files.

Example:

cp dvsum_gateway_2.1.0/my_domain.jks dvsum_gateway_2.1.1/my_domain.jks

Step 4: Migrate Existing Scan and Chat Information

Copy the following folders, if available:

• data_analysis
• dq_analysis
• scan_output

Not all installations contain these folders. Copy only the folders that are present.

3. Installation

Windows

After setting up the new Gateway and transferring the required files:

1. Open PowerShell as Administrator.
2. Navigate to the new Gateway installation folder.

cd <New Gateway Installation Folder>

Option 1: Non-Interactive Installation (Recommended)

Run the following command to install the Gateway using the existing SSL configuration:

.\dvsum_gateway_setup.bat install --ssl-option=4 --non-interactive

Option 2: Interactive Installation

If you want to review or modify the installation settings during the upgrade, run:

.\dvsum_gateway_setup.bat install

Note: Use either Option 1 or Option 2 to complete the installation. You do not need to run both commands.

./dvsum_gateway_setup.sh install --ssl-option=4 --non-interactive

Verify the Upgrade

After completing the upgrade:

• Verify that the Gateway service is running.
• Confirm that the Gateway status is Online in the DvSum application.
• Test an existing data source connection by clicking Authenticate.
• Run a metadata scan or Data Quality scan to ensure the Gateway is functioning correctly.
• Review the Gateway logs (SAWS.log) for any startup or configuration errors.

If all the above checks are successful, the Gateway upgrade has completed successfully.

Notes on Certificate Handling

For self-signed certificates, if you do not need to retain the previous SSL configuration, you can follow the standard steps in the Gateway Installation article.

For CA-signed certificates, it is recommended to reuse the existing keystore to avoid reconfiguring the private key and SSL settings. Copy the existing keystore to the new Gateway installation folder before installing the Gateway.

Final Remarks

• Ensure that configuration.properties and ssl_config.properties are correctly migrated and configured.
• Keep a backup of the previous Gateway installation until the upgraded Gateway has been successfully validated.
• For CA-signed certificates, reusing the existing keystore simplifies the upgrade and avoids the need to recreate SSL configurations.