All Products
Search
Document Center

Dataphin:Zero-downtime upgrade for Dataphin

Last Updated:Jun 22, 2026

You can perform a zero-downtime upgrade for Dataphin in Dataphin Manager to keep services running during the upgrade.

Limits

A zero-downtime upgrade is supported only when the first three segments of the current and target version numbers are the same. For example, you can upgrade from V5.1.2.02 to V5.1.2.04.

Prerequisites

  • You understand the impact of the version upgrade. For more information, see Impact of version upgrades.

  • No configurations or upgrades are in progress. If an upgrade is in progress, wait for it to complete, or force stop it if necessary before you try again.

Background information

A zero-downtime upgrade consists of two steps: selecting the version and upgrade mode, and performing the upgrade. Users can continue to log on to Dataphin during the upgrade. Applications are updated through a rolling upgrade. The following figures show the complete flow:

image

Procedure

Step 1: Select the version and upgrade mode

  1. Append /opsconsole/v2 to the logon URL of Dataphin to go to the Dataphin Manager logon page.

  2. On the Dataphin Manager logon page, enter your Username and Password, and then click Log on. Contact Dataphin O&M personnel to obtain the username and password.

  3. On the Upgrade Record page, click Upgrade Dataphin.

  4. On the Upgrade Dataphin page, select the version and upgrade mode. The following table describes the parameters.

    Parameter

    Description

    Target version

    Select the target version from the version list.

    If the target version is not in the list, click Upload Version Configuration to upload the configuration file for the target version.

    After the upload, the system validates the configuration file. If the content is incorrect, validation fails and the system reports the failure reason. If validation passes and no configuration file exists for this version, the version configuration is imported. If a configuration file already exists, the upload overwrites the existing configuration.

    Configuration file

    • Standard configuration: Click Upload File to upload a configuration file in YAML or ZIP format. After the upload, you can download the configuration file.

      After the upload is complete, the system validates the configuration file. If the file is missing any configuration items, the system reports an error. Click View Details in the error message to see a list of the missing configuration items.

    • Non-standard configuration: Before you upload the file, contact the Dataphin O&M team to obtain the required configuration file in ZIP format. Click Upload File to upload the file. After the upload is complete, the system automatically performs the following checks:

      • Checks whether the standard configuration template for the version (product/dataphin/...) in the configuration file is the same as the uploaded version configuration (MD5 validation). If they are not the same, the system displays a message: The configuration template in the configuration file is not compatible with the selected version. Confirm with the Dataphin O&M team before you continue the upgrade.

      • Checks whether the overlay file and the values.yaml file in the configuration file are compatible with the standard configuration template for the version (product/dataphin/...). If they are not compatible, the system blocks the upgrade and displays a message: The configuration information in the configuration file is not compatible with the selected version. The upgrade cannot continue. Confirm with the Dataphin O&M team.

      • Checks whether the values.yaml file in the configuration file is the same as the values.yaml file running in your current production environment. If they are not the same, the system displays a message: The configuration information in the configuration file is not consistent with the current online configuration of the environment. If you continue, the upgrade will proceed with the new configuration file.

      Note

      Do not use a non-standard configuration unless necessary.

    Upgrade mode

    Select Zero-downtime upgrade. During the upgrade, the data service remains active, and data service API calls remain available. This includes synchronous and asynchronous invocations.

    The system checks the compatibility between the current and target versions to determine if a zero-downtime upgrade is supported. If it is not supported, the system defaults to a downtime upgrade.

  5. Select the risk disclaimer checkbox, and then click Start Upgrade.

Step 2: Start the upgrade

A progress bar shows the upgrade progress. During the upgrade, click View Log to view detailed upgrade logs.