This document covers some best practices on upgrading Pentaho software. You will learn the upgrade steps including what to have ready before you begin, and what to back up and restore.
Our intended audience is Pentaho administrators.
The Components Reference in Pentaho Documentation has a complete list of supported software and hardware.
Before You Begin
This document assumes that you know specifics of your Pentaho installation and usage, including what environments you have configured (development, test, production, and so on), your server’s operating system and version, the user information for the user running Pentaho processes, any customizations, and other details.
Best Practices for Upgrading - Step By Step
Upgrading to Pentaho 8.1 is a complicated process, but it does not have to be difficult. You will need to have all the necessary information and software available to you, and then it will be a simple matter of following your upgrade path from its beginning to its end.
You can find details on these topics in the following sections:
- Determine Upgrade Path
- Check System Environment
- Back Up Databases/Custom Configurations
- Install New Version of Pentaho
- Restore Backups/Custom Configurations
- Update Pentaho Design Tools
- Start and Test Pentaho
Determine Upgrade Path
The first thing you’ll need to do when you are tasked with upgrading is to figure out which upgrade path to take. Your upgrade path is dependent on a few things, mainly your current version of Pentaho and which version you want to upgrade to.
If you don’t see your current version listed in this document, please check here and/or contact Support for assistance.
What Version Am I Currently On?
To find out which version of Pentaho you have installed, open the PDI Client (Spoon) or the Pentaho User Console (PUC), and click on Help, and then About.
If you need release notes for any Pentaho version, check the Pentaho Customer Portal.
What's New in Pentaho Documentation
- What’s New in Pentaho 7.0
- What’s New in Pentaho 7.1
- What’s New in Pentaho 8.0
- What’s New in Pentaho 8.1
Which Path Will Get Me to 8.1?
If you are currently running version 6.1, 7.0, 7.1, or 8.0, your process will be straightforward. You will be able to upgrade directly to Pentaho 8.1 from your current version.
Figure 1: Upgrading to 8.1 from 6.0 - 8.1
Check System Environment
To upgrade as smoothly as possible, you will need to know all the relevant details about your Pentaho installation and environment(s). The Pentaho Upgrade Checklist will help you with these details.
Once you have all this information, make sure that your current specifications meet the requirements for your new version of Pentaho. The Components Reference for 8.1 has a complete list of specifications.
Back Up Databases/Custom Configurations
Once you have verified that your system can run the new version of Pentaho, you need to make sure that all your data and custom configurations are backed up. Back Up and Restore Pentaho Repositories and Import and Export PDI Content have the information you need to accomplish this for users and roles, files such as dashboards and reports, schedules, data connections, Mondrian schemas, and metadata entries.
Install New Version of Pentaho
After all of your data and configuration files are backed up, you are ready to install Pentaho. Remember to refer to your upgrade path if you need to do incremental upgrades to reach Pentaho 8.1 (for example, if you are on 6.0 and therefore need to upgrade to 7.1 first and then to 8.1).
We recommend that you use the archive method for installing Pentaho.
Restore Backups/Custom Configurations
After you have installed Pentaho 8.1, you need to restore your data and custom configurations.
If you have custom configurations, contact your CSM, then Support, and let them know before upgrading.
Back Up and Restore Pentaho Repositories and Import and Export PDI Content have the information you need to accomplish this for users and roles, files such as dashboards and reports, schedules, data connections, Mondrian schemas, and metadata entries.
Update Pentaho Design Tools
The Pentaho Design Tools, also known as Pentaho Client Tools, are available for reinstallation either with the or manually. Installation of the Pentaho Design Tools takes you through this process.
Start and Test Pentaho
Once you have upgraded your software, restored your data and configurations, and updated your Pentaho Design Tools, all that remains is to start and test your new Pentaho server software:
- Begin with Starting the Pentaho Server after an Archive Installation.
- Once you have successfully restarted your Pentaho Server, move on to the steps to Test Your Server.
For troubleshooting, refer to Installation and Upgrade Issues.
Here are some links to information that you may find helpful while using this best practices document:
- Pentaho Training Courses
- Back Up and Restore Pentaho Repositories
- Import and Export PDI Content
- Installation and Upgrade Issues
- Installation of the Pentaho Design Tools
- Pentaho Components Reference
- Pentaho Customer Portal
- Starting the Pentaho Server after an Archive Installation
- What’s New in Pentaho