Pentaho upgrade

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 Support Portal. After processing, the Pentaho Upgrade Installer interface opens 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:

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.

8. In the next Pentaho Upgrade Installer window, update the white_list.csv file by following the instructions in the Specify customized items to address after upgrading topic below. After finishing this procedure, click Next.

9. When prompted for the location of the hash files zip archive, specify the path to the archive, select the archive, and click Next.

   NoteYou can download the hash files zip archive from the Support Portal

Results

Parent Topic

• Using the Pentaho Upgrade Installer

Procedure

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

2. Verify items that you know have changed from the default Pentaho setup are listed in the white_list.csv including any drivers, plugins, and other software you added.

   NoteIf you do not know which items in the report have been modified, contact your system administrator or the Support Portal for help.
   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 a directory separator at the end. For example: directory,data-integration/your-directory-name.

3. After you have updated the white_list.csv file, click Next to proceed. When the environment check step has completed, review the preInstallConfigReport.txt file and verify that all your customizations are present.

   This report contains the following sections:
   • Files that you must manually merge because they were changed before the upgrade and were also changed in this Pentaho update
   • Files that were not able to be automatically mapped. You may need to manually merge these files after the upgrade.
   • Files that are handled automatically because they were changed pre-upgrade, but are not changed in this Pentaho update
   For example, in a standard Pentaho Server installation, you may have made the following changes:
   • Set up LDAP authentication, and edited the following files:
     • applicationContext-pentaho-security-ldap.xml
     • applicationContext-security-ldap.properties
     • applicationContext-spring-security-ldap.xml
   • Added a custom LDAP authentication solution under pentaho-solutions/system/my_ldap_solution.
   • Added a third-party DB driver named tomcat/webapps/pentaho/WEB-INF/lib/my_db_driver.jar.

4. After you have completed the environment check, open the preInstallConfigReport.txt file and verify that the applicationContext-pentaho-security-ldap.xml, applicationContext-security-ldap.properties, and applicationContext-spring-security-ldap.xml files appear in the Files that will be handled automatically because they were changed pre-upgrade, but are not changed in this Pentaho update section.

   Their presence means that your changes to these files will be present after the upgrade, and no further action is required. If changes in the upgrade have impacted these files, they will appear in the Files that will need manually merged because they were changed pre upgrade and changed in this Pentaho update section.

   You should not see your my_ldap_solution directory or any of its contents listed in that section, nor should you see the my_db_driver.jar listed. To preserve your LDAP solution and database driver after the upgrade, you should add the following lines to the <root installation directory>/Pentaho__Installation/white_list.csv file:

   • directory,my_ldap_solution
   • file,my_db_driver.jar

5. Click Previous in Environment Check window then click Next to return to the Environment Check window.

   When you re-run the environment check step, the installer reads the white_list.csv again. If any changes were made, the results in the preInstallConfigReport.txt will be different.

6. When the environment check is complete, open the <root installation directory>/Pentaho__Installation/preInstallConfigReport.txt file again, to verify that your custom code is now listed in the Files that could not be automatically mapped section. These files may need to be manually merged after installation section

Results

Parent Topic

• Using the Pentaho Upgrade Installer

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 customer 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:
   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, click 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 files 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

Parent Topic

• Using the Pentaho Upgrade Installer