Skip to main content
Hitachi Vantara Lumada and Pentaho Documentation

Pentaho upgrade

You can upgrade your Pentaho products from version 8.3 or later to version 9.3 using the Pentaho Upgrade Installer.

Parent article

The upgrade installer checks your environment for version 8.3 or later Pentaho products, creates a backup of these products, then upgrades them to version 9.3. The Pentaho Upgrade Installer works for any Pentaho products you have installed on your server or workstations, including your Pentaho Server and your Pentaho client tools.

NoteYou can use the Pentaho Upgrade Installer to upgrade your Pentaho 8.3 or later client tools on macOS workstations. However, the Pentaho Server is not supported on macOS.

This upgrade documentation assumes you are an IT administrator upgrading all your Pentaho products from 8.3 or later to 9.3. If any or all of your Pentaho products is a version earlier than 8.3, the Pentaho Upgrade Installer will not proceed with the upgrade process.

If you need to upgrade your Pentaho products from a version earlier than 8.3, such as 7.1 or higher, you must upgrade your products to version 8.3, then use the Pentaho Upgrade Installer to move from version 8.3 to 9.3. See Upgrade the Pentaho Server for instructions on upgrading from 7.1 or higher to version 8.3.

Before you begin

Before you can run the Pentaho Upgrade Installer, you must also perform the following tasks:

Procedure

  1. Verify that your system components are current.

    Your system components, such as web browsers or repository databases, must be up-to-date. See Components Reference to verify the system requirements.
    NoteThe Pentaho Upgrade Installer requires 22 GB of free space to perform the upgrade process.
  2. If you are upgrading an environment that includes the Pentaho Server, stop the server prior to performing backups and installation.

    For instructions, see Start and stop the Pentaho Server for configuration.
  3. Review your customizations.

    During the upgrade process, you can help the upgrade installer specify which items contain your customizations. See Specify customized items to to address after upgrading for details. Then, after upgrading your Pentaho products to 9.3, you can merge your previous customizations into post-upgrade versions of the Pentaho files. See the Apply customizations post-upgrade task for instructions.
  4. If you are using Hadoop clusters with your Pentaho products, review and back up your site.xml files.

    The upgrade process does not retain the drivers for your Hadoop clusters. You will need to re-install your drivers after completing the upgrade process. See the Install drivers for your Hadoop clusters post-upgrade task for details.
  5. If you are using plugins with your Pentaho products, review and back up your plugins to a separate directory structure.

    The upgrade process does not retain your plugins. You will need to re-apply your plugins after completing the upgrade process. See the Apply your plugins post-upgrade task for details.
  6. If you are upgrading the Pentaho Server, verify that no users are logged on to the server.

    As a best practice, perform the upgrade process of the Pentaho Server during off-business hours to minimize the impact to your day-to-day operations.

Next steps

Get the Pentaho upgrade file

The upgrade process includes the platform file that you must download from the Hitachi Vantara Lumada and Pentaho Support Portal before running the upgrade installer.

Perform the following steps to download the file:

Procedure

  1. On the Customer Portal home page, sign in using the Pentaho support username and password provided in your Pentaho Welcome Packet.

  2. Click Downloads, then click Pentaho 9.3 GA Release in the 9.x list.

  3. On the bottom of the Pentaho 9.3 GA Release page, browse the folders in the Box widget to find the Utilities and Tools folder.

  4. Depending on your platform, download one of the following files:

    • Linux

      pentaho-update-9.3.0.0-428.bin

    • macOS

      pentaho-update-9.3.0.0-428.zip

    • Windows

      pentaho-update-9.3.0.0-428.exe

    If needed, move the downloaded file to a temporary location on your machine.

  5. If you are upgrading on macOS, unzip the downloaded file.

Results

You are now prepared to begin your upgrade to Pentaho 9.3.

Using the Pentaho Upgrade Installer

The Pentaho Upgrade Installer is a step-by-step user interface that opens and guides you through the upgrade process. If you are upgrading in an environment that does not support the display of a graphical interface, then you may want to upgrade in silent mode from a command line. For more information, see Using the Pentaho Upgrade Installer in silent mode.

NoteVerify that the JAVA_HOME environment variable is set to the current version of Java you have installed on your machine before starting the Pentaho Upgrade Installer. See Components Reference to verify Java version requirements.

The documentation guides you through the following process:

  1. The Pentaho Upgrade Installer checks your environment to ensure your earlier Pentaho products are compatible for upgrade.
  2. In separate files, you will help the upgrade installer determine which items from the default Pentaho install you customized and how to address these items.
  3. The Pentaho Upgrade Installer creates a backup of your earlier Pentaho products in case you prefer to restore them later, then installs the Pentaho 9.3 versions of the products found during the environment check.

Get started by checking your environment

Perform the following steps to start the Pentaho Upgrade Installer and check your environment.

Procedure

  1. Exit out of any Pentaho products you currently have running.

    If you are upgrading your Pentaho Server, stop the server. For instructions, see Start and stop the Pentaho Server for configuration.
  2. Run the update executable file you downloaded from the Lumada and Pentaho Support Portal. After processing, the Pentaho Upgrade Installer interface opens to the Introduction window.

  3. Click Next.

  4. In the License Terms window, read through the license agreement and select the check box at the end of the agreement to acknowledge the terms, as shown in the following example:

    License Terms in the Pentaho Upgrade Installer
  5. Click Next.

  6. In the Welcome window, select Upgrade to upgrade your Pentaho products and click Next.

    If you would like to restore a backup of an original installation before upgrading, select Restore and see Restoring a Pentaho Upgrade Installer backup for instructions.
  7. In the Choose Folder window, specify the root directory of your Pentaho installation in the Folder text box, then click Next.

    For example, if you originally installed your Pentaho products in the default location on Windows, then you would specify C:\Pentaho for Folder. You can also use Choose to browse to the root directory. Restore Default Folder returns the value in the Folder text box to the default specified by the Pentaho Upgrade Installer.

Results

The upgrade installer performs an environment check to determine what Pentaho products are installed in the root directory you specified and whether your environment is compatible for upgrading these products to Pentaho 9.3.

For example, if you are upgrading a server, the Environment Check may appear similar to the following sample:Enviroment check while upgrading a Pentaho Server

If you are upgrading a workstation, the Environment Check may appear similar to the following sample:Environment check while upgrading Pentaho client tools

NoteThe Pentaho Upgrade Installer is designed to work for the Pentaho 8.3 or later products you have installed in a specified root directory and all the related subdirectories. If you have installed Pentaho products in a root directory separate from the one specified, you also need to apply the Pentaho Upgrade installer to that separate root directory to upgrade those other products.

Specify customized items to to address after upgrading

While checking your environment for Pentaho products and compatibility, the Pentaho Upgrade Installer generates a pre-install report text file and a CSV file in the <root installation directory>/Pentaho__Installation directory. If you have changed items in the default Pentaho setup to apply customizations, you must make sure these items are specified in the CSV file before you can proceed with the upgrade process. If you have not applied any customizations, you can proceed to Back up of your existing Pentaho products and install Pentaho 9.3.

The upgrade installer uses your updated CSV file to generate post-upgrade versions of the listed items separately from your existing versions of these items. After the upgrade process, you may need to merge content from both versions to retain your customizations.

NoteCustom directories at the <root installation directory> level of your Pentaho distributions are ignored by the Pentaho Upgrade Installer. Custom directories are directories that you created and are not included in the default Pentaho installation.

Perform the following steps to verify the items specified in the CSV file and adjust as needed:

Procedure

  1. Navigate to the <root installation directory>/Pentaho__Installation directory.

  2. Open the preInstallConfigReport.txt file in an editor application.

    This report contains the following sections:
    • Files that will need manually merged because they were changed pre upgrade and changed in this Pentaho update
    • Files that were not able to be automatically mapped, these files may need to be manually merged after install
    • Files that will be handled automatically because they were changed pre-upgrade, but are not changed in this Pentaho update
  3. Verify items you know have changed from the default Pentaho setup are listed in the pre-install report.

    NoteIf you do not know which items in the report have been modified, contact your system administrator or the Hitachi Vantara Lumada and Pentaho Support Portal for help.
  4. If you modified items from the default Pentaho setup yet those items do not appear in the pre-install report, open the white_list.csv file in an editor application that supports the CSV file type and add them.

    The CSV file contains the following two comma-separated columns:
    • Item type

      The item can be a script, configuration file, JDBC driver, directory, KTR file, KJB file, or a license file.

    • File or directory path

      The location and file name (if the item is a file) within your Pentaho distribution. The File or directory path value can contain regular expressions.

      NoteIf the item you want to include is a directory, specify the directory name without appending a directory separator at the end. For example: directory,data-integration/your-directory-name.
  5. If you had to update the CSV file, perform the following steps:

    1. Save the CSV file.

    2. In the Pentaho Upgrade Installer, use Previous in Environment Check to return to Choose Folder.

    3. Click Next to run the environment check again. Re-running the environment check updates the preInstallConfigReport.txt file.

Results

The CSV file is used to generate post-upgrade versions of the listed items separately from your existing versions of these items. After the upgrade process, you may need to merge content from both versions to retain your customizations.

Back up of your existing Pentaho products and install Pentaho 9.3

Perform the following steps in the Pentaho Upgrade Installer to back up your existing installation and apply the new Pentaho 9.3 installation:

Procedure

  1. After you verify the items in the CSV file if you have any customizations, return to the Pentaho Upgrade installer and click Next to back up your existing Pentaho installation.

    NoteContact support if your expected Pentaho products do not appear in the list. The Pentaho Upgrade Installer backs up your existing versions of the Pentaho products if you decide to restore the earlier version after upgrading to version 9.3. If you decide to restore the backup, see Restoring a Pentaho Upgrade Installer backup for instructions.
  2. After the backup completes to 100% in the Backup window, click Next.

    The Pre-Installation Summary window appears, as shown in the following example:Pre-Installation Summary in Pentaho Upgrade Installer
    NoteIf you cancel the upgrade process after the backup of your environment is created but before the 9.3 installation, this backup will not be used by the Pentaho Upgrade Installer in any future upgrade process. To remove this backup ZIP file, navigate to the ~/.pentaho/backup directory and delete the ZIP file related to the date when the backup was performed.
  3. Verify the information in the pre-installation summary, then click Install.

    If the summary information is not what you expected, use Previous to modify any previous settings.
  4. After the installation and configuration updates complete in the Installing Pentaho window, click Next.

    If errors occur, examine the log files for details about how to resolve the error. Depending on the error, you may need to contact customer support for help. The default location of the log file is <root installation directory>/Pentaho__Installation/logs.

    After the installation part of the upgrade process, a post-install report is generated to specify which files may have been modified from the default Pentaho setup for customizations.

  5. In the Install Complete window, click Done to exit the Pentaho Upgrade Installer.

  6. Apply the version 9.3 licenses to your upgraded Pentaho products.

    See Manage Pentaho licenses for instructions.
  7. (Optional) If you have modified any items from the default Pentaho setup for customizations, use the post-install report to determine which items need to be merged.

    Seen the Apply customizations post-upgrade task for instructions.
  8. If you are upgrading your Pentaho Server, restart the Pentaho Server.

Next steps

After you upgrade your Pentaho products, complete these Post-upgrade tasks to verify that your Pentaho configuration is ready to use.