Upgrade Data Catalog

Upgrading Pentaho Data Catalog ensures that you can take advantage of the latest features, improvements, and security updates while maintaining your existing configurations and data. This section provides step-by-step instructions to upgrade your Data Catalog deployment from earlier versions to newer releases.

Supported upgrades

Pentaho Data Catalog supports upgrades only across the next two versions. You can upgrade directly to the immediate next version or the version after that, but skipping more than two versions in a single upgrade is not supported. If your target version is more than two versions ahead, you must perform the upgrade in multiple stages by first upgrading to an intermediate supported version and then moving to the final target version.

The following matrix shows the supported upgrade paths:

From \ To	10.2.1	10.2.5	10.2.6	10.2.7	10.2.8	10.2.9
10.2.0	✅ Direct	❌	❌	❌	❌
10.2.1	—	✅ Direct	❌ via 10.2.5	❌ via 10.2.5 → 10.2.7	❌ via 10.2.5 → 10.2.8
10.2.5	—	—	✅ Direct	✅ Direct	❌	—
10.2.6	—	—	—	✅ Direct	✅ Direct	—
10.2.7	—	—	—	—	✅ Direct	✅ Direct
10.2.8	—	—	—	—	—	✅ Direct

To avoid problems, always back up configuration files and Docker volumes before upgrading, and review any custom changes in Docker compose files so they can be reapplied after extracting the new package.

Upgrade procedures

The topics in this section guide you through the specific upgrade paths supported for Pentaho Data Catalog 10.2.x:

• #Upgrade PDC 10.2.5 to 10.2.6, 10.2.7, 10.2.8, or 10.2.9: Follow this procedure if your current deployment is on version 10.2.5 and you want to upgrade to 10.2.6, 10.2.7, 10.2.8, or 10.2.9.

• #Upgrade PDC 10.2.1 to 10.2.5: Follow this procedure if your current deployment is on version 10.2.1 and you want to upgrade to 10.2.5.

• #Upgrade PDC 10.2.0 to 10.2.1: Follow this procedure if your current deployment is on version 10.2.0 and you want to upgrade to 10.2.1.

If you want to upgrade Data Catalog to a patch version, see Upgrade Data Catalog to a patch version.

Before starting, ensure you review the prerequisites, back up your configuration and data, and prepare the deployment environment as described in the respective upgrade topics.

Upgrade PDC 10.2.5 to 10.2.6, 10.2.7, 10.2.8, or 10.2.9

Upgrading Pentaho Data Catalog (PDC) to the latest version ensures access to new features, improved performance, and security updates.

Perform the following steps to upgrade from PDC 10.2.5 to PDC 10.2.6, 10.2.7, 10.2.8, or 10.2.9:

Prerequisites

Perform the following steps to upgrade from PDC 10.2.5 to PDC 10.2.6, 10.2.7, 10.2.8, or 10.2.9:

Prerequisites

Before you begin, make sure that:

• PDC 10.2.5 is installed. For the new installation of Data Catalog, see Installing Data Catalog.

• You have a backup of your configurations and data.

• You have administrative access to the server where Data Catalog is installed.

Data Catalog supports upgrades only across the next two versions. From version 10.2.5, you can upgrade directly to 10.2.6 or 10.2.7. Direct upgrade from 10.2.5 to 10.2.8 or 10.2.9 is not supported. To move to 10.2.9, you must first upgrade to 10.2.7 and then perform a second upgrade to 10.2.8 or 10.2.9. For details, see the #Supported upgrades section.

Procedure

1. Go to the Data Catalog installation folder, where PDC 10.2.5 is installed:

   cd /opt/pentaho/pdc-docker-deployment/

2. Stop the currently running PDC services.

   ./pdc.sh stop

3. Back up configuration files:

   1. Create a backup folder in /opt/ to store the container data and configuration backups:

      mkdir /opt/pdc_backup_10_2_5

   2. Copy the config folder to the backup folder you have created:

      cp -a /opt/pentaho/pdc-docker-deployment/conf/ /opt/ pdc_backup_10_2_5

   3. Copy the vendor folder to the backup folder you have created:

      cp -a /opt/pentaho/pdc-docker-deployment/vendor/ /opt/ pdc_backup_10_2_5

4. Back up Docker volumes:

   1. Identify PDC Docker volumes:

      docker volume ls | grep pdc*

   2. Go to the Docker volumes path:

      cd /var/lib/docker/volumes/

   3. Copy PDC Docker volumes to the backup folder:

      cp -a pdc* /opt/pdc_backup_10_2_5/

5. Verify that all configuration files and Docker volumes are backed up correctly in the backup folder.

6. Remove the vendor folder of PDC 10.2.5 build:

   rm –rf /opt/pentaho/pdc-docker-deployment/vendor

7. Load the new images (choose either 10.2.6, 10.2.7, 10.2.8, or 10.2.9) into the Docker repository:

   docker load -i pdc-<version>-images.tgz

   Replace <version> with 10.2.6, 10.2.7, 10.2.8, or 10.2.9 depending on the upgrade target.

8. Extract the contents of the new package and overwrite the existing files in the deployment folder (/opt/pentaho/pdc-docker-deployment/):

   Important: Before overriding the files, review any custom configurations made in the Docker compose files and ensure those changes are noted and applied to the new files.

   tar -xzvf pdc-<DEPLOYMENT_PACKAGE_TYPE>-<version>-compose.tgz -C /opt/

   The <DEPLOYMENT_PACKAGE_TYPE> placeholder corresponds to the type of PDC service you want to deploy. For example, in the case of PDC 10.2.6:

   • For PDC full services, use: pdc-full-10.2.6-compose.tgz

   • For PDC with Pentaho Data Optimizer services, use: pdc-pdo-10.2.6-compose.tgz

   • For PDC with Pentaho Data Mastering services, use: pdc-pdm-10.2.6-compose.tgz .

   Similarly, for PDC 10.2.7, replace it with 10.2.7, for PDC 10.2.8, replace it with 10.2.8, or for PDC 10.2.9, replace it with 10.2.9. If you are unsure which deployment package to use, contact Pentaho Support for guidance.

9. Start PDC services with the new version:

   ./pdc.sh up

Result

Pentaho Data Catalog is upgraded to version 10.2.5 to 10.2.6, 10.2.7, 10.2.8, or 10.2.9.

You have successfully upgraded Pentaho Data Catalog version 10.2.5 to 10.2.6, 10.2.7, 10.2.8, or 10.2.9.

Upgrade PDC 10.2.1 to 10.2.5

Upgrading Pentaho Data Catalog (PDC) to the latest version ensures access to new features, improved performance, and security updates.

Perform the following steps to upgrade from PDC 10.2.1 to PDC 10.2.5:

Perform the following steps to upgrade from PDC 10.2.1 to PDC 10.2.5:

Prerequisites

Before you begin, make sure that:

• PDC 10.2.1 is installed. For the new installation of Data Catalog, see Installing Data Catalog.

• You have a backup of your configurations and data.

• You have administrative access to the server where Data Catalog is installed.

Procedure

1. Go to the Data Catalog installation folder, where PDC 10.2.1 is installed:

   cd /opt/pentaho/pdc-docker-deployment/

2. Stop the currently running PDC services.

   ./pdc.sh stop

3. Back up configuration files:

   1. Create a backup folder in /opt/ to store the container data and configuration backups:

      mkdir /opt/pdc_backup_10_2_1

   2. Copy the config folder to the backup folder you have created:

      cp -a /opt/pentaho/pdc-docker-deployment/conf/ /opt/ pdc_backup_10_2_1

   3. Copy the vendor folder to the backup folder you have created:

      cp -a /opt/pentaho/pdc-docker-deployment/vendor/ /opt/ pdc_backup_10_2_1

4. Back up Docker volumes:

   1. Identify PDC Docker volumes:

      docker volume ls | grep pdc*

   2. Go to the Docker volumes path:

      cd /var/lib/docker/volumes/

   3. Copy PDC Docker volumes to the backup folder:

      cp -a pdc* /opt/pdc_backup_10_2_1/

5. Verify that all configuration files and docker volumes are backed up correctly in the backup folder.

6. Remove the vendor folder of PDC 10.2.1 build:

   rm –rf /opt/pentaho/pdc-docker-deployment/vendor

7. Load the PDC 10.2.5 images into the Docker repository:

   docker load –i pdc-10.2.5-images.tgz

8. Extract the contents of the PDC 10.2.5 package and overwrite the existing files in the deployment folder (/opt/pentaho/pdc-docker-deployment/):

   Important: Before overriding the files, review any custom configurations made in the Docker compose files and ensure those changes are noted and applied to the new files.

   tar -xzvf pdc-<DEPLOYMENT_PACKAGE_TYPE>-10.2.5-compose.tgz -C /opt/

   The <DEPLOYMENT_PACKAGE_TYPE> placeholder corresponds to the type of PDC service you want to deploy. For example:

   • For PDC full services, use: pdc-full-10.2.5-compose.tgz

   • For PDC with Pentaho Data Optimizer services, use: pdc-pdo-10.2.5-compose.tgz

   • For PDC with Pentaho Data Mastering services, use: pdc-pdm-10.2.5-compose.tgz If you are unsure which deployment package to use, contact Pentaho Support for guidance.

9. Start PDC services with the new version:

   ./pdc.sh up

Result

Pentaho Data Catalog is upgraded to version 10.2.1 to 10.2.5.

You have successfully upgraded Pentaho Data Catalog version 10.2.1 to 10.2.5.

Upgrade PDC 10.2.0 to 10.2.1

Upgrading Pentaho Data Catalog (PDC) to the latest version ensures access to new features, improved performance, and security updates.

Perform the following steps to upgrade from PDC 10.2.0 to PDC 10.2.1:

Prerequisites

Perform the following steps to upgrade from PDC 10.2.0 to PDC 10.2.1:

Prerequisites

Before you begin, make sure you have a backup of your configurations and data, and you have administrative access to the server where Data Catalog is installed.

Procedure

1. Go to the Data Catalog installation directory, where PDC 10.2.0 is installed (/opt/pentaho/pdc-docker-deployment/).

2. Stop the currently running PDC services:

   ./pdc.sh stop

3. Back up configuration files:

   1. Create a backup folder in /opt/ to store the container data and configuration backups:

      mkdir pdc_backup_10_2_0

   2. Copy the config directory to the backup folder you have created:

      cp -a /opt/pentaho/pdc-docker-deployment/conf/ /opt/pdc_backup_10_2_0/

4. Back up Docker volumes:

   1. Identify PDC Docker volumes:

      docker volume ls | grep pdc*

   2. Go to the Docker volumes directory:

      cd /var/lib/docker/volumes/

   3. Copy PDC Docker volumes to the backup folder:

      cp -a pdc* /opt/pdc_backup_10_2_0/

5. Verify that all configuration files and docker volumes are backed up correctly in the backup folder.

6. Extract the contents of the PDC 10.2.1 package and overwrite the existing files in the deployment directory (/opt/pentaho/pdc-docker-deployment/):

   Important: Before overriding the files, review any custom configurations made in the Docker-compose files and ensure those changes are noted and applied to the new files.

   tar -xzvf pdc-10.2.0.tar.gz -C /opt/

7. Open the .env file located in the /opt/pentaho/pdc-docker-deployment/conf/ path and add or update the licensing URL in a line such as the following and save the .env file:

   LICENSING_SERVER_URL=<your_license_server_url>

8. After updating the configurations, load the Docker images for PDC 10.2.1:

   ./pdc.sh load-images

9. Start PDC services with the new version:

   ./pdc.sh up

Result

Pentaho Data Catalog is upgraded from version 10.2.0 to 10.2.1.

You have successfully upgraded PDC from 10.2.0 to 10.2.1.