How to Update Matillion – Best Practices
In this blog, we look at the options available to you when it comes to keeping your Matillion software up to date. We recommend you update Matillion when a new release is available to take advantage of the latest features and performance enhancements.
There are two ways to update:
1. Create a new instance and migrate your work
2. In-place update
Note: The preferred, and safest, way to upgrade is option 1: to launch a new copy of your Matillion instance (running the latest version), and use the Migration Tool to copy your work onto the new instance.
When to update
How do you know when a new version is available? You will see a message in the Notices section at the bottom right of the screen in the main Matillion user interface. We always recommend updating to the latest version for full access to new connectors, features, and improvements.
Create a New Instance and Migrate
If you are using v1.37+ of Matillion this is the recommended method for updating your instance.
With this method of updating you create a new, second instance of Matillion (at the latest version), and copy your existing work onto it.
You can start to use the new instance immediately. Alternatively, you may prefer to do your own performance and functionality testing on the new instance before switching over.
Matillion has a built-in Server Migration Tool which you can use to copy your work between instances. There are two ways to use the Server Migration Tool:
The Server Migration Tool is a “push” utility. You must permit the original Matillion instance to access the new one over the network, or else it won’t be able to copy your work.
If you have made customizations within your current Matillion instance such as installing Python libraries, it is advised to create a reproducible set of scripts that can be run to install those customizations on your new Matillion instance.
Server Migration Tool – Graphical User Interface
1. Launch a new instance by following the same steps that you took to create your original Matillion instance. A reminder of how to do this can be found here: Matillion ETL for Amazon Redshift, Matillion ETL for Snowflake, or Matillion ETL for BigQuery
2. Open the original Matillion instance in a browser
3. Select Migrate from the Project menu
4. Enter the Target URL of the new instance
5. Enter the Username and Password
6. Select the Projects or Jobs to migrate
7. Select OK
You now have two copies of your work, on two Matillion instances. Best practice is:
- Ensure the new instance is running correctly.
- Enable your schedules on the new instance and disable them on the old one.
- Stop the old instance. It might be useful as a backup, and you have the option of restarting it again later. While the instance is stopped, Matillion license fees do not apply and there is only a minimal cost associated with it.
Note: You may later decide to terminate the old instance, in which case it will be permanently destroyed.
For more information on the Migration Tool, refer to tour Migrate article.
Server Migration Tool – Command Line
The principles here are exactly the same as for the GUI version, except this time the migration is performed by a built-in script from the command line.
For full details please refer to the Server Migration Tool article.
This will be the method of updating for those using a version of Matillion v1.36 or earlier. With this method of updating you simply update your existing instance of Matillion to the latest version.
|Warning: This method is deprecated and may be removed in a future release|
The first step of an in-place upgrade is to take a snapshot of your Matillion Instance. You must do this via your cloud console.
Do not omit this step. It’s very important in case you find any issues after updating and decide to revert to the old version.
Having a snapshot will give you an easy option of rolling back if needed.
Matillion comes pre-configured with an internet software repository where updates are published. You must permit outbound internet access for Matillion otherwise it won’t be able to perform the software update.
There are two ways to perform an in-place upgrade:
In-place Update Using the Graphical User Interface
Start by navigating to your Matillion instance in your web browser.
1. Select the Matillion ETL Updates option from the Admin menu to open a new dialog box. You may check for software updates using the Check for Updates button.
2. Available updates are listed in the console and the Update button will become available if these can be installed.
3. Selecting Update will download any updated packages and apply them. Once applied, the server will be restarted.
Note: This will disconnect any active users and abort any running tasks.
If you are using a version prior to 1.28.7, please see the Software Updates section of Administering Matillion ETL for final steps.
In-place Update via the Command Line
A ‘sudo yum update‘ is all that is required to update the software on the AMI.
1. SSH to your Matillion Instance
2. Once connected issue the following: sudo yum update matillion-*
3. Restart Matillion using the following command: sudo service tomcat8 restart
4. Exit out of your session
If you later decide to revert to the original version, you can restore from the snapshot taken before the update.
Check out our latest release notes here, and don’t forget to subscribe to our YouTube Channel for Release update and tutorial videos.