In these steps, you move updates to production by extracting the updates into a ZIP file, testing the updates, and then manually merging them to the existing product distribution. You do not replace the existing production setup with the WUM-updated setup.
If you are new to WUM, first see Getting Started with WUM to update your prodructs. If you have already used WUM, follow the steps given below.
Before you begin, do you have a proxy server/firewall? Then, grant access to the endpoints mentioned below.
WUM gets updates by connecting to the
https://cdn.updates.wso2.com endpoints in the WSO2 Update service. If your system connects to the Update service through a proxy server/firewall, grant access to these endpoints.
Since WUM is a command-line tool, the proxy should be configured from your command-line as follows:
Run the following commands to check whether there are updates available:
If an update is available, run the following command to start updating your product:
Your local product repository should now contain the latest and the previous WUM-updated distributions. Let's extract the updates in the latest WUM-updated distribution to a ZIP file.
Execute the following command to identify the previous WUM-updated pack for this product.
Execute the following command:
Note that the diff ZIP is created in the location from where you executed the diff command.
Next, let's apply the WUM updates that you extracted to the ZIP file to the distribution pack that is currently running in your environment.
Open the summary PDF that you get inside this ZIP file (also via email). It contains information about the:
New configurations introduced with the update.
Existing files/artifacts that are affected due to the update.
If you do not have any customizations in the existing distribution, simply copy the changed configuration files mentioned in the ZIP to the corresponding directories in your product distribution.
If you have customizations in the existing distribution, there might be conflicts between that and the WUM-updated distribution.Click to read how to resolve conflicts...
A conflict happens when a customized configuration file or artifact has changed in the WUM updates. As the file/artifact has your customizations in it, it is not recommended to completely replace this file with the file that comes with the update.
Given below is how to resolve conflicts manually in different types of files/artifacts:
File Type How to Merge the Conflicts Binary files
Copy all the binary files (.jar, .jks, .car, .war) to the relevant directories in your existing product distribution. If you have made any customizations to .car and .war files, manually merge those changes.
Note: If there are .war files in the WUM update, be sure to delete all extracted .war files in your existing product distribution.
This is because all deployed .war files get extracted at the server startup and if there are already extracted .war files by that same name, the server will not extract the .war files in the WUM update.
You cannot replace the Jaggery artifacts in your existing product distribution with the WUM-updated Jaggery artifacts because your existing Jaggery artifacts may contain customizations. Here's how to merge the files:
- Check the summary PDF to identify how the Jaggery files have changed because of the WUM updates.
- Apply the changes to the same files in your existing product distribution.
Apply the updated configuration files
Identify the configuration updates in the summary PDF and apply them (by merging) to the relevant configuration files in the
<PRODUCT_HOME>/repository/conffolder of your existing product distribution.
Note: Be sure to merge the configuration files in your environment with the new files. It is not recommended to replace them.
Redundant files If there are artifacts/files that are removed by the WUM updates, remove them from your existing product distribution. Newly added files If there are newly added files listed in the PDF, create the same folder structure (if it doesn't exist) in your existing product distribution and add the file.
Do you have additional WSO2 features installed in your product distribution? If so,Click to read on...
Please note that WSO2 does not recommend installing new features to standard products. If you already have features installed, you need to install the same features in the new product distribution and apply the patches. Please contact team WSO2 as this needs to be handled on a case-by-case basis.
Test the updated product distribution and deploy it in your production environment.