Migration Guide From Data Viz 2.0 to 3.0

This guide will help you migrate from the old Data Viz 2.0 to the new Data Viz 3.0.

There are several changes that are introduced in Data Viz 3.0. This guide will help you migrate from the old Data Viz 2.0 to the new Data Viz 3.0.

Prerequisites

• Node.js version 22 or above (which can be checked by running node -v).
• PNPM version 9 or above (which can be checked by running pnpm -v).
• Docker version 24 or above (which can be checked by running docker --version).
• Intellij IDEA version 2024.1 or above (which can be checked by running idea --version).
• VSCode version 1.80 or above (which can be checked by running code --version).
• Git version 2.40 or above (which can be checked by running git --version).

Changes

1. Data Viz Admin

• The Data Viz Admin is now a standalone project and it is highly recommended to use the Docker image to run the Data Viz Admin rather than using submodules.
• You can upgrade the Data Viz Admin by running the following command:

git rm data-viz-admin

• Upgrade Your docker compose file to use the new Data Viz Admin image.

Docker Compose (New)

  data-viz-admin:
    image: registry.developmentgateway.org/data-viz-admin:latest

Docker Compose (Old)

  data-viz-admin:
    image: ${REPO}/tcdi-admin:${TAG}
    build:
      context: ../tcdi-admin/forms
      dockerfile: Dockerfile

2. Data Viz API

• This is a Java Based project with several modules.
  • api-registry - This is the main module that contains the API registry.
  • api-gateway - This is the API gateway that routes the requests to the appropriate API.
  • api-security - This is the API security module that contains the security configuration for the API.
  • superset-proxy - This connects Data Viz to Superset.
  • commons - This is the commons module that contains the common utilities for the API.
• You are recommended to use all these modules as Docker images instead of using the api-commons submodule.
• You can find the upgrade guide for the Data Viz API here.

3. Data Viz Wordpress

• This is a Wordpress Based project with several modules.
• The Data Viz Wordpress is now a standalone project and it is highly recommended to use the Docker image to run the Data Viz Wordpress rather than using submodules.
• Upgrade Your docker compose file to use the new Data Viz Wordpress image.

Docker Compose (New)

  wordpress:
    image: registry.developmentgateway.org/data-viz/wordpress:latest

Docker Compose (Old)

  wordpress:
    image: ${REPO}/wordpress:${TAG}
    build:
      context: ../front
      dockerfile: wordpress.Dockerfile

4. Data Viz UI

• This is a replacement for the UI-Customizer project.
• You can find the upgrade guide for the Data Viz UI here.