Skip to main content
Pentaho Documentation

Upgrade the Pentaho Server

Parent article

This guide describes how to upgrade the Pentaho Server from an archive installation of Pentaho version 7.1.x or 8.x to version 9.0 using the Pentaho Server Upgrade Installer. The upgrade installer works for both a Pentaho Server and a DI server. This upgrade documentation assumes that you are upgrading to 9.0 on the same server as your current archive installation.

To use this method, verify that you are currently running one of the following supported versions:

  • 7.1.0.0 with server patch releases 1 through 32
  • 8.0.0.0 with server patch releases 1 through 6
  • 8.1.0.0 with server patch releases 1 through 6
  • 8.2.0.0 with server patch releases 1 through 7
  • 8.3.0.0 with server patch releases 1 through 7

NoteThe upgrade installer supports all the releases identified in the list above. If you attempt to run the upgrade installer on a version that is not supported, the upgrade process halts and displays a list of the currently supported versions. If you are currently running a base version with a server patch that is not supported, for example 8.3.0.8, you can remain on version 8.3 until the next update of the upgrade installer. Server patches are updated monthly.
  • If you are currently running a base version below 7.1.x, there is a two-stage upgrade process. First, upgrade to version 8.3 by running the 8.3 Pentaho Upgrade Utility file. After you upgrade to 8.3, you can then upgrade to version 9.0 using the Upgrade Installer.
  • If you are currently running a base version of 7.1.x or higher, use the upgrade installer to upgrade to version 9.0.

The upgrade installer does not include upgrades for the client tools.

Before you begin

To perform this upgrade process, you need to know how to access the Pentaho Server as an administrator from a command line.

You must also perform the following tasks before running the Pentaho Server Upgrade Installer.

Procedure

  1. Log in with the same user account that originally installed the Pentaho Server.

    Most likely, this is the pentaho user or the Pentaho administrator account that is assigned administrative privileges.
  2. Verify your current version of Pentaho. Start with a supported working installation of Pentaho Server 7.1.x or 8.x.

  3. Verify that your system components are current. Your system components, such as web browsers or repository databases, must be up-to-date for Pentaho.

  4. Stop the Pentaho Server prior to performing backups and installation.

    For instructions, see Start and stop the Pentaho Server for configuration.
  5. Back up your entire Pentaho environment, including the karaf cache and the Tomcat log files, so you can recover your environment in the event of an error.

    NoteThe server upgrade removes the Karaf cache and all the files in the Tomcat/work and Tomcat/temp folders from the Pentaho Server folder structure. Removing these files avoids conflicts when you restart the Pentaho Server.
  6. Backup the following Pentaho Server databases or DI server databases:

    Pentaho ServerDI Server
    hibernatedi_hibernate
    quartzdi_quartz
    jackrabbitdi_jackrabbit
  7. Review your current spring security configuration. For your convenience, the upgrade process makes revisions to the spring configuration files. For more information, see Spring security files.

  8. Verify that no users are logged on to the server.

    You should perform the upgrade process during off-business hours to minimize the impact to your day-to-day operations.

Next steps

Get the Pentaho upgrade and utility files

The upgrade process includes utility and installation files that you must download from the Pentaho Customer Support Portal.

Download the upgrade and utility files

Perform the following steps to download these files:

Procedure

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

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

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

Available update files

The following files are required to perform a Pentaho Server 9.0 upgrade:
ComponentFile Name
Pentaho Server Upgrade Installer for Windows environments.PentahoServer-UP-9.0.x.yy-Windows.zip
Pentaho Server Upgrade Installer for Linux environments.PentahoServer-UP-9.0.x.yy-Linux.zip

Unzip the downloaded files

Perform the following steps to unzip the downloaded file:

Procedure

  1. If needed, move the downloaded file to a temporary location on your current server.

  2. Unzip the downloaded file.

Next steps

You are now prepared to begin your 7.1.x or 8.x to 9.0 upgrade.

Using the Pentaho Server Upgrade Installer

The following instructions open a user interface that guides you through the upgrade process. To use this method, see Use the Pentaho Server Upgrade Installer.

If you are upgrading a headless server which does not support the display of a graphical interface, there are two other methods to run the upgrade installer by including different parameters at the command line. For more information, see Using the Pentaho Server Upgrade Installer with command line parameters.

Use the Pentaho Server Upgrade Installer

Follow these steps to run the Pentaho Server Upgrade Installer.

Procedure

  1. Log in with the same user account that originally installed the Pentaho Server.

    Most likely, this is the pentaho user or the Pentaho administrator account that is assigned administrative privileges.
  2. Stop the Pentaho Server.

    For instructions, see Start and stop the Pentaho Server for configuration.
  3. Open a command line terminal. At the prompt, run the Pentaho Server Upgrade Installer as shown below:

    • Windows: .\PentahoServer-UP-9.0.0.0-bld.exe -i swing
    • Linux: ./PentahoServer-UP-9.0.0.0-bld.bin -i swing
    The installer opens a new window with interactive prompts to guide you through the upgrade process.
  4. Accept the end-user license agreement and click Next.

  5. On the next screen, provide the directory path of the current home installation for either the Pentaho Server or the DI server.

    The installer works for both a Pentaho Server and a DI server. The web app name for the Pentaho Server is pentaho and the DI server web app name is pentaho-di.
  6. Click Install to start the server upgrade process.

    When the server upgrade process is complete, a status window displays success, warnings, or errors.
  7. If there are errors, examine the log files for details on how to resolve the error. Depending on the error, you may need to contact Support for help.

    The default location of the log file is: <installation directory>/pentaho-sever/.patch_archive
  8. If there are no errors, restart the Pentaho Server.

Next steps

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