JBoss EAP XP upgrade and migration guide
Guidance for upgrading and migrating from JBoss EAP XP 1.0.x to JBoss EAP XP 2.0.0
Abstract
Chapter 1. JBoss EAP XP upgrades
JBoss EAP XP 2.0.0 introduces new features. Upgrade JBoss EAP XP 1.0.x to JBoss EAP XP 2.0.0 to add these features and capabilities to your installation:
- Bootable JAR creation: a bootable JAR contains the server, a packaged application, and the runtime required to launch the server.
Additional server health probes:
-
server-status
: Indicates whether the server is running. -
boot-errors
: Indicates whether boot errors were detected. -
deployment-status
: Indicates the status of deployments.
-
1.1. Upgrading JBoss EAP XP 1.0.x to 2.0.0
Upgrade JBoss EAP XP 1.0.x to 2.0.0 using the upgrade
command that is provided in JBoss EAP XP manager.
JBoss EAP XP 2.0.0 is certified with JBoss EAP 7.3.4 and 7.3.z versions.
Prerequisites
- The base JBoss EAP server is updated to patch 7.3.4 or a later patch.
- You have downloaded the JBoss EAP XP 2.0.0 patch from the Product download page.
Procedure
Verify that your server is on the correct patch and has JBoss EAP XP 1.0.x installed:
$ java -jar jboss-eap-xp-manager.jar status --jboss-home=__<path_to_eap>__ ... You are currently on JBoss EAP XP 1. You are using an old version of JBoss EAP XP. The current version is 2, please upgrade. Enabled patch streams and their cumulative patch ids: - Patch stream: 'JBoss EAP'; Cumulative patch id: 'jboss-eap-7.3.4' - Patch stream: 'jboss-eap-xp-1.0'; Cumulative patch id: 'jboss-eap-xp-1.0.0.CP' Available commands in this state are: [remove, upgrade]
This output indicates that your server is ready for upgrade to JBoss EAP XP 2.0.0.
If you see other output, refer to the troubleshooting recommendations.
Use the
upgrade
command to upgrade JBoss EAP XP 1.0.x to 2.0.0 and apply the JBoss EAP XP 2.0.0 patch.$ java -jar jboss-eap-xp-manager.jar upgrade --jboss-home=__<path_to_eap>__ --xp-patch=__<path_to_patch>__/jboss-eap-xp-2.0.0-patch.zip
Accept the support policy prompt by entering
yes
.Your server is ready to manage the JBoss EAP XP 2.0.0 patch stream and is updated with the JBoss EAP XP 2.0.0 patch.
Additional resources
1.2. JBoss EAP XP 2.0.0 upgrade troubleshooting
If the JBoss EAP XP manager status
command returns an error output, consult the following troubleshooting recommendations.
Incompatible version of JBoss EAP
The JBoss EAP XP manager setup
command returns an error such as the following:
JBoss EAP version 7.3.1 is incompatible with the JBoss EAP XP stream. To run this manager, please upgrade to at least JBoss EAP 7.3.4.
This message indicates JBoss EAP is not on the correct patch for JBoss EAP XP 2.0.0. Download and apply patch 7.3.4.
Existing patch in an inconsistent state
The JBoss EAP XP manager status
command returns an error such as the following:
The JBoss EAP XP patch stream setup in the JBoss EAP server seems broken.
This message indicates that JBoss EAP XP is in an inconsistent state. This state might occur if a user modified a file in JBoss EAP XP or if problem occurred in the previous installation. Remove the existing patch and install JBoss EAP XP 2.0.0.
More than one JBoss EAP XP patch stream installed
The JBoss EAP XP manager status
command returns an error such as the following:
You have more than one JBoss EAP XP patch stream set up in the JBoss EAP server.
This message indicates that patches from different versions of JBoss EAP XP exist on JBoss EAP. This state might occur if you installed an older patch after installing a more recent patch. Remove the existing patches and install JBoss EAP XP 2.0.0.
Additional resources
1.2.1. Removing and reinstalling JBoss EAP XP
You must remove and reinstall JBoss EAP XP to solve some status errors.
Procedure
Remove the JBoss EAP XP patch stream by using the
remove
command of JBoss EAP XP manager 2.0.0:$ java -jar jboss-eap-xp-manager.jar remove --jboss-home=__<path_to_eap>__
- Reinstall JBoss EAP XP 2.0.0.
Additional resources
- For information about installing JBoss EAP XP 2.0.0, see Installing JBoss EAP XP 2.0.0 on JBoss EAP 7.3.x.
- For a list of status command errors, see JBoss EAP XP 2.0.0 upgrade troubleshooting.
1.3. Patching JBoss EAP XP 2.0.0
If Red Hat releases a patch for JBoss EAP XP, use the JBoss EAP XP manager patch-apply
command to apply it.
Procedure
- Download the patch from the Product downloads page.
Run the following command:
$ java -jar jboss-eap-xp-manager.jar patch-apply --jboss-home=__<path_to_eap>__ --patch=__<path_to_eap_patch>__/jboss-eap-xp-2.0.1-patch.zip
Replace placeholder
eap_home_path
with the path to the JBoss EAP installation directory. Replacepath_to_eap_patch
with the path to the location where you downloaded the JBoss EAP XP. Replacejboss-eap-xp-2.0.0-patch.zip
with the name of the patch file that you downloaded.Your server is updated with the specified patch.
Additional resources