Chapter 3. Applying patch updates and minor release upgrades to Red Hat Process Automation Manager
Chapter 3. Applying patch updates and minor release upgrades to Red Hat Process Automation Manager Automated update tools are often provided with both patch updates and new minor versions of Red Hat Process Automation Manager to facilitate updating certain components of Red Hat Process Automation Manager, such as Business Central, KIE Server, and the headless Process Automation Manager controller. Other Red Hat Process Automation Manager artifacts, such as the decision engine and standalone Business Central, are released as new artifacts with each minor release and you must reinstall them to apply the update. You can use the same automated update tool to apply both patch updates and minor release upgrades to Red Hat Process Automation Manager 7.13. Patch updates of Red Hat Process Automation Manager, such as an update from version 7.13 to 7.13.5, include the latest security updates and bug fixes. Minor release upgrades of Red Hat Process Automation Manager, such as an upgrade from version 7.12.x to 7.13, include enhancements, security updates, and bug fixes. Note Only updates for Red Hat Process Automation Manager are included in Red Hat Process Automation Manager update tools. Updates to Red Hat JBoss EAP must be applied using Red Hat JBoss EAP patch distributions. For more information about Red Hat JBoss EAP patching, see the Red Hat JBoss EAP patching and upgrading guide . Prerequisites Your Red Hat Process Automation Manager and KIE Server instances are not running. Do not apply updates while you are running an instance of Red Hat Process Automation Manager or KIE Server. Procedure Navigate to the Software Downloads page in the Red Hat Customer Portal (login required), and select the product and version from the drop-down options. If you are upgrading to a new minor release of Red Hat Process Automation Manager, such as an upgrade from version 7.12.x to 7.13, first apply the latest patch update to your current version of Red Hat Process Automation Manager and then follow this procedure again to upgrade to the new minor release. Click Patches , download the Red Hat Process Automation Manager [VERSION] Update Tool , and extract the downloaded rhpam-USDVERSION-update.zip file to a temporary directory. This update tool automates the update of certain components of Red Hat Process Automation Manager, such as Business Central, KIE Server, and the headless Process Automation Manager controller. Use this update tool first to apply updates and then install any other updates or new release artifacts that are relevant to your Red Hat Process Automation Manager distribution. If you want to preserve any files from being updated by the update tool, navigate to the extracted rhpam-USDVERSION-update folder, open the blacklist.txt file, and add the relative paths to the files that you do not want to be updated. When a file is listed in the blacklist.txt file, the update script does not replace the file with the new version but instead leaves the file in place and in the same location adds the new version with a .new suffix. If you block files that are no longer being distributed, the update tool creates an empty marker file with a .removed suffix. You can then choose to retain, merge, or delete these new files manually. Example files to be excluded in blacklist.txt file: The contents of the blocked file directories after the update: In your command terminal, navigate to the temporary directory where you extracted the rhpam-USDVERSION-update.zip file and run the apply-updates script in the following format: Important Make sure that your Red Hat Process Automation Manager and KIE Server instances are not running before you apply updates. Do not apply updates while you are running an instance of Red Hat Process Automation Manager or KIE Server. On Linux or Unix-based systems: On Windows: The USDDISTRO_PATH portion is the path to the relevant distribution directory and the USDDISTRO_TYPE portion is the type of distribution that you are updating with this update. The following distribution types are supported in Red Hat Process Automation Manager update tool: rhpam-business-central-eap7-deployable : Updates Business Central ( business-central.war ) rhpam-kie-server-ee8 : Updates KIE Server ( kie-server.war ) Note The update tool will update and replace Red Hat JBoss EAP EE7 to Red Hat JBoss EAP EE8. Red Hat JBoss EAP EE7 is used for WebLogic and WebSphere, whereas version EE8 is used for Red Hat JBoss EAP. Make sure that KIE Server on WebLogic and WebSphere is not updated by the update tool. rhpam-kie-server-jws : Updates KIE Server on Red Hat JBoss Web Server ( kie-server.war ) rhpam-controller-ee7 : Updates the headless Process Automation Manager controller ( controller.war ) rhpam-controller-jws : Updates the headless Process Automation Manager controller on Red Hat JBoss Web Server ( controller.war ) Example update to Business Central and KIE Server for a full Red Hat Process Automation Manager distribution on Red Hat JBoss EAP: Example update to headless Process Automation Manager controller, if used: The update script creates a backup folder in the extracted rhpam-USDVERSION-update folder with a copy of the specified distribution, and then proceeds with the update. After the update tool completes, return to the Software Downloads page of the Red Hat Customer Portal where you downloaded the update tool and install any other updates or new release artifacts that are relevant to your Red Hat Process Automation Manager distribution. For files that already exist in your Red Hat Process Automation Manager distribution, such as .jar files for the decision engine or other add-ons, replace the existing version of the file with the new version from the Red Hat Customer Portal. If you use the standalone Red Hat Process Automation Manager 7.13.5 Maven Repository artifact ( rhpam-7.13.5-maven-repository.zip ), such as in air-gap environments, download Red Hat Process Automation Manager 7.13.5 Maven Repository and extract the downloaded rhpam-7.13.5-maven-repository.zip file to your existing ~/maven-repository directory to update the relevant contents. Example Maven repository update: Note You can remove the /tmp/rhbaMavenRepoUpdate folder after you complete the update. Optional: If you are changing Red Hat Process Automation Manager from using property-based user storage to file-based user storage, complete the following steps: Navigate to the USDJBOSS_HOME directory and run one of the following commands: On Linux or Unix-based systems: On Windows: Run the following command: On Linux or Unix-based systems: On Windows: Navigate to the directory where you extracted the rhpam-USDVERSION-update.zip file and run one of the following commands to apply the kie-fs-realm patch: On Linux or Unix-based systems: On Windows: After you finish applying all relevant updates, start Red Hat Process Automation Manager and KIE Server and log in to Business Central. Verify that all project data is present and accurate in Business Central, and in the top-right corner of the Business Central window, click your profile name and click About to verify the updated product version number. If you encounter errors or notice any missing data in Business Central, you can restore the contents in the backup folder within the rhpam-USDVERSION-update folder to revert the update tool changes. You can also reinstall the relevant release artifacts from your version of Red Hat Process Automation Manager in the Red Hat Customer Portal. After restoring your distribution, you can try again to run the update.
WEB-INF/web.xml // Custom file styles/base.css // Obsolete custom file kept for record ls WEB-INF web.xml web.xml.new ls styles base.css base.css.removed ./apply-updates.sh USDDISTRO_PATH USDDISTRO_TYPE .\apply-updates.bat USDDISTRO_PATH USDDISTRO_TYPE ./apply-updates.sh ~EAP_HOME/standalone/deployments/business-central.war rhpam-business-central-eap7-deployable ./apply-updates.sh ~EAP_HOME/standalone/deployments/kie-server.war rhpam-kie-server-ee8 ./apply-updates.sh ~EAP_HOME/standalone/deployments/controller.war rhpam-controller-ee7 unzip -o rhpam-7.13.5-maven-repository.zip 'rhba-7.13.5.GA-maven-repository/maven-repository/*' -d /tmp/rhbaMavenRepoUpdate mv /tmp/rhbaMavenRepoUpdate/rhba-7.13.5.GA-maven-repository/maven-repository/ USDREPO_PATH/ ./bin/standalone.sh --admin-only -c standalone-full.xml ./bin/jboss-cli.sh --connect --file=rhpam-USDVERSION-update/elytron/add-kie-fs-realm.cli ./bin/standalone.bat --admin-only -c standalone-full.xml ./bin/jboss-cli.bat --connect --file=rhpam-USDVERSION-update/elytron/add-kie-fs-realm.cli ./bin/elytron-tool.sh filesystem-realm --users-file standalone/configuration/application-users.properties --roles-file standalone/configuration/application-roles.properties --output-location standalone/configuration/kie-fs-realm-users --filesystem-realm-name kie-fs-realm-users ./bin/elytron-tool.bat filesystem-realm --users-file standalone/configuration/application-users.properties --roles-file standalone/configuration/application-roles.properties --output-location standalone/configuration/kie-fs-realm-users --filesystem-realm-name kie-fs-realm-users ./elytron/kie-fs-realm-patch.sh ~/USDJBOSS_HOME/standalone/configuration/kie-fs-realm-users/ ./elytron/kie-fs-realm-patch.bat ~/USDJBOSS_HOME/standalone/configuration/kie-fs-realm-users/