Chapter 5. Upgrading Server to Newer Version
General Notes on Upgrade
Upgrade of CloverETL Server requires down time; plan a maintenance window.
Successful upgrade requires about 30 minutes; rollback requires 30 minutes.
Perform the below steps in development/testing environment first before moving onto production one.
Upgrade Prerequisites
Having a new CloverETL Server web application archive (
clover.warappropriate for the application server used) & license files available.Having release notes for the particular CloverETL version available (and all versions between current and intended version to be upgraded to).
Having the graphs and jobs updated and tested with regards to Known Issues & Compatibility for the particular CloverETL version.
Having the CloverETL Server configuration properties file externalized from default location, see Chapter 6, Configuration Sources and Their Priorities.
Standalone database schema where CloverETL Server stores configuration, see Chapter 8, Examples of DB Connection Configuration.
Having a separate sandbox with a test graph that can be run at any time to verify that CloverETL Server runs correctly and allows for running jobs.
Upgrade Instructions
Suspend all sandboxes, wait for running graphs to finish processing.
Shutdown the CloverETL Server application (or all servers, if they run in a cluster mode).
Backup the existing CloverETL database schema (if any changes to the database schema are necessary, the new server will automatically make them when you start it for the first time).
Backup the existing CloverETL web application archive (
clover.war) & license files (on all nodes).Backup the existing CloverETL sandboxes (on all nodes).
Re-deploy the CloverETL Server web application. Instructions how to do that are application server dependent - see Production Server for installation details on all supported application servers. After the re-deployment, your new server will be configured based on the previous version's configuration.
Replace old license files by the valid one (or you can later use the web GUI form to upload new license). The license file is shipped as a text containing a unique set of characters. If you:
received the new license as a file (
*.dat), then simply use it as new license file.have been sent the license text, e.g. inside an e-mail, then copy the license contents (i.e. all text between
CompanyandEND LICENSE) into a new file calledclover-license.dat. Next, overwrite the old license file with the new one or upload it in the web GUI.
See CloverETL Server Activation for details on license installation.
Start the CloverETL Server application (on all nodes).
Review that contents of all tabs in the CloverETL Server Console, especially scheduling and event listeners looks OK.
Update graphs to be compatible with the particular version of CloverETL Server (this should be prepared and tested in advance).
Resume the test sandbox and run a test graph to verify functionality.
Resume all sandboxes.
Rollback Instructions
Shutdown the CloverETL Server application.
Restore the CloverETL Server web application (
clover.war) & license files (on all nodes).Restore the CloverETL Server database schema.
Restore the CloverETL sandboxes (on all nodes).
Start the CloverETL Server application (on all nodes).
Resume the test sandbox and run a test graph to verify functionality.
Resume all sandboxes.
![[Important]](figures/important.png) | Important |
|---|---|
Evaluation Version - a mere upgrade of your license is not sufficient. When moving from evaluation to production server, you should not use the default configuration and database. Instead, take some time to configure CloverETL Server so that it best fits your production environment. |