Upgrade from 7.x or 8.x DI Server to 8.3
The upgrade process from version 7.x or 8.x Data Integration (DI) Server to version 8.3 Pentaho Server assumes that you installed your original DI Server using an archive installation. This process is similar whether you are upgrading the Pentaho Business Analytics (BA) Server or the Data Integration (DI) Server.
This upgrade documentation describes how to upgrade from Pentaho 7.x or 8.x DI Server to Pentaho 8.3. It assumes that you are upgrading to 8.3 on the same server as your current archive installation. We recommend that you read through this material completely before starting.
Get started with the 7.x or 8.x DI Server to 8.3 upgrade
To perform this upgrade process, you need to know how to access the DI Server as an Administrator from a command line.
Before you begin
Procedure
Verify your current version of the DI Server and PDI. Start with a working installation of at least DI Server 7.x or PDI 7.x.
Verify your system components are current. Ensure that your system components, such as web browsers, Java version, or repository databases, are up-to-date for Pentaho.
Create backups for all the following Pentaho DI databases:
- di_hibernate
- di_quartz
- di_jackrabbit
For Linux installations only, verify Info-ZIP has been installed and configured.
If needed, you can download, install, and configure Info-ZIP open source compression utility using the Info-ZIP documentation. Info-ZIP is available at http://www.info‐zip.org/. A BSD-style license is provided and used for most Linux and Unix variants. A Windows version of Info-ZIP is preconfigured and included in the Pentaho update package.Verify that no users are logged on to the server.
The upgrade process should be performed during off-business hours to minimize impact to your day-to-day operations.Make sure to obtain the correct version of Java for your system.
See Components Reference for more details.
Next steps
Get the Pentaho upgrade and utility files
The upgrade process involves utility and installation files that you must download from the Pentaho Customer Support Portal site.
Download the upgrade and utility files
Procedure
On the Customer Portal home page, sign in using the Pentaho support user name and password provided in your Pentaho Welcome Packet.
Click Downloads, then click Pentaho 8.3 GA Release in the 8.x list.
On the bottom of the Pentaho 8.3 GA Release page, browse the folders in the Box widget to find the files you need.
Available update files
The following files are required to perform a complete Pentaho 8.3 update:
Component | File Name |
DI Server Upgrade Utility | pentaho-upgrade-utility-8.3.x.yy-pdi |
Pentaho Server Installation | pentaho-server-ee-8.3.x.yy-dist |
PDI client | pdi-ee-client-8.3.x.yy-dist |
License Files | Pentaho [component] Enterprise Edition.lic |
Unzip the downloaded files
Procedure
If needed, move the downloaded files to a temporary location on your current server.
Unzip each downloaded file.
Results
Upgrade the Pentaho Data Integration Server
After you finish the prerequisite tasks located in Get Started section, then you are ready to upgrade to Pentaho 8.3.
These sections will guide you through the Pentaho DI upgrade process:
- Back up your DI Server configuration and solutions files
- Install the version 8.3 Pentaho Server
- Restore your DI Server configuration and solutions files
- Start and test the DI Server
Step 1: Back up your DI Server configuration and solutions files
Complete the following steps to back up your configuration and solutions files:
Procedure
Navigate to the directory where the upgrade utility (pentaho-upgrade-utility-8.3.x.yy-pdi) was unpacked and open a command line prompt.
At the prompt, run the DIServerConfigAndSolutionsBackup utility for your operating system as shown in the following examples:
- Windows:
DIServerConfigAndSolutionsBackup.bat <path to your 7.x or 8.x DI server>
NoteIf you are using Windows and the directory path you specified contains white spaces, then be sure to wrap it in double quotation marks (“). - Linux:
./DIServerConfigAndSolutionsBackup.sh <path to your 7.x or 8.x DI server>
pentaho_solutions_folder
Specifies the path to the pentaho-solutions directory if you manually installed it outside of the main pentaho directory structure.
pentaho_version
Specifies your DI version if a valid version cannot be automatically found during the backup process.
- Windows:
Next steps
Step 2: Install the 8.3 Pentaho Server
Make sure to install the new instance of Pentaho on the same server, but leave your Pentaho 7.x or 8.x instance "as is" and unpack Pentaho 8.3 into a new directory.
Perform the following steps to install the 8.3 version of the Pentaho Server:
Procedure
Verify Java 8 is installed on the server machine.
If you need to install Java 8, you can download a supported version of JRE or JDK.Verify the PENTAHO_JAVA_HOME environment variable is set to the path of your Java installation.
- If you need to set this variable, use the SET command in Windows or the export command in Linux.
- If you are using a JRE, verify the JRE_HOME environment variable is also set to the correct location.
Browse to the location where you unzipped the pentaho-server-ee-8.3.x.yy-dist file in the Available Update Files section.
Execute the supplied install.bat or install.sh file.
Agree to the end-user license agreement.
Select the pentaho/server/pentaho-server directory as the location to store the extracted files.
Step 3: Restore your DI Server configuration and solutions files
After you have unpacked your Pentaho 8.3 bundle, restore your custom data to your 8.3 instance with the restore utility.
Apply the restore utility
Procedure
Delete all the content in the Pentaho Server 8.3 pentaho-solutions/system/default-content directory.
Open a cmd prompt on the DI Server host machine.
In the prompt, run the DIServerConfigAndSolutionsRestore utility to restore your data from the ZIP files in your user home directory as shown below.
- Windows:
DIServerConfigAndSolutionsRestore.bat <path to your 8.3 pentaho server>
NoteIf you are using Windows and the directory path you specified contains white spaces, then be sure to wrap it in double quotation marks (“). - Linux:
./DIServerConfigAndSolutionsRestore.sh <path to your 8.3 pentaho server>
- Windows:
Review previous version upgrades and customizations
This section includes version specific and configuration changes that should be reviewed.
Verify spring security namespace header updates
Perform the following steps to verify the spring-security namespace headers:
Procedure
Stop the Pentaho Server.
Open the following three files:
/pentaho-server/pentaho-solutions/system/applicationContext-spring-security.xml
/pentaho-server/pentaho-solutions/system/applicationContext-spring-security-cas.xml
/pentaho-server/pentaho-solutions/system/repository.spring.xml
Locate the spring-security namespace in each file header. If it is not already updated, enter the following version:
http://www.springframework.org/schema/security/spring-security-4.2.xsd
Save and close the files.
Results
Karaf customizations
The Pentaho Server installs all the Karaf features upon installation. The system waits for these features to be installed before timing out. The default is to wait two minutes before timing out. If you modified any Karaf feature, you should consider changing the Karaf startup timeout setting.
Password encoding
- You are upgrading from version 8.1 to 8.3.
- You are using your own password encoding or you previously applied this version of encoding
If you wish to use this version of password encoding, perform the following steps:
Procedure
Navigate to the pentaho/server/pentaho-server/pentaho-solutions/system directory and open the pentahoObjects.spring.xml file with any text editor.
Locate the line that contains
bean id="IPasswordService"
Verify or modify the
class=<value>
with the following value:bean id="IPasswordService" class="org.pentaho.platform.util.KettlePasswordService" scope="singleton"/>
Save and close the file.
If you modified the
In the same pentaho/server/pentaho-server/pentaho-solutions/system directory, open the defaultUser.spring.properties file with any text editor.class=<value>
above, you must make the following modification to encrypt the Pentaho Admin password.Locate the following lines:
defaultAdminUserPassword=cGFzc3dvcmQ=
defaultNonAdminUserPassword=cGFzc3dvcmQ=
Replace the values in these lines with the following values:
defaultAdminUserPassword=Encrypted 2be98afc86aa7f2e4bb18bd63c99dbdde
defaultNonAdminUserPassword=Encrypted 2be98afc86aa7f2e4bb18bd63c99dbdde
Save and close the file.
Documentation version link
Procedure
Navigate to the pentaho/server/pentaho-server/pentaho-solutions/system directory and open the pentaho.xml file with any text editor.
Modify the following
<documentation-url>
line and replace the previous documentation value with the current documentation value:<documentation-url>https://help.pentaho.com/Documentation/8.3</documentation-url>
Save and close the file.
CORS (for embedding CTools)
Procedure
Navigate to the pentaho/server/pentaho-server/pentaho-solutions/system directory and open the pentaho.xml file with any text editor.
Modify or add the following CORS lines:
<!-- cors-requests-allowed: Flag indicating if cross-origin requests are allowed or not. accepted values are: true | false --> <cors-requests-allowed>false</cors-requests-allowed> <!-- cors-requests-allowed-domains: Comma separated list of domains allowed to do cross-origin requests to the server. Example: http://domainA.com, http://localhost:1337 --> <cors-requests-allowed-domains><!-- allowed domains here --></cors-requests-allowed-domains>
If you are embedding CTools, add the following line (as shown above) and set the value to true.
<cors-requests-allowed>true</cors-requests-allowed>
Save and close the file.
Previously customized files
If you have previously customized any of the following items, verify that your customizations have been carried forward:
- server.xml
- Startup and shutdown scripts
- System listeners
- Security configuration files
If your previous customizations have not been merged, incorporate them into their 8.3 files.
Step 4: Start and test the DI Server
You are now ready to Start the DI Server.
Test your server
Procedure
Clear your web browser cache and history.
Navigate to your Pentaho URL (the default URL is http://localhost:9080/pentaho-di) and ensure the login screen appears.
Navigate to the kettle/status page.
Log on to the PDI client (Spoon) and try to run your existing content.
Ensure that a repository connection can be made using the PDI client (Spoon).
Verify any scheduled items exist and are working properly.
Check your application server logs for any errors:
The Catalina and Pentaho logs are located at server/pentaho-server/tomcat/logs.
Next steps
For customers using Ops Mart
If you are interested in installing and using DI Ops Mart, see Install DI Operations Mart.
Update your design tool
Procedure
Exit the PDI client, if it is currently running.
Back up and rename the 7.x or 8.x existing data-integration directory in the pentaho/design-tools directory to a separate, temporary directory.
Browse to the location where you downloaded the pdi-ee-client-8.3.x.yy-dist file in the Available Update Files section.
If you have not already done so, unzip the new data-integration directory and install it into your existing pentaho/design-tools directory.
Start your new PDI client design tool to verify it has been upgraded to 8.3.
Test the functionality of the new PDI client design tool.
Results