How do I apply individual or cumulative patches for zip-based installations of JBoss EAP 6.2 and later?

Solution Verified - Updated 29 Jul 2024

Environment

Red Hat JBoss Enterprise Application Platform (EAP)
- 7.x
- 6.2+

Issue

How do I apply individual or cumulative patches?
How to use --host attribute while applying patch?
How to use CLI patch command for managed domain?
How to upgrade EAP to the latest version?
Cumulative patch to go from scratch to 6.4.22
Failed to apply patch

WFLYPAT0018: copied content does not match expected hash for item: MiscContentItem{bin/client/jboss-cli- 
client.jar}

Resolution

To facilitate patch management with zip-based installations, Red Hat has added a new patch command in the JBoss CLI. User can use this command to apply patches patch apply /<patch_download_url>/<patch_name>.zip.
The JBoss EAP Patching and Upgrading Guide contains detailed information related to the application of individual and cumulative patches to your system. This guide also includes information on updating JBoss EAP server instances across managed domains.

Examples

Interactive examples

**Note:** "``" is the complete pathname to the patch distribution obtained from Red Hat.

For standalone mode:

[standalone@localhost:9999 /] patch apply /<patch_download_url>/<patch_name>.zip
{
    "outcome" : "success",
    "result" : {}
}
[standalone@localhost:9999 /]

For domain mode specify the --host attribute as follows:

[domain@localhost:9999 /] patch apply --host=$HOST  /<patch_download_url>/<patch_name>.zip
{
    "outcome" : "success",
    "result" : {}
}
[domain@localhost:9999 /]

Non-Interactive example

    $JBOSS_HOME/bin/jboss-cli.sh --command="patch apply /<patch_download_url>/<patch_name>.zip"

    {
    "outcome" : "success",
    "result" : {}
    }

Notes

If there is not a connection to a JBoss EAP server (the CLI console is reporting disconnected as illustrated below), the patch will be applied to the EAP installation jboss-cli is running from. Otherwise, the patch will be applied to the EAP installation the jboss-cli is currently connected to.
```
[admin@admin bin]$ ./jboss-cli.sh 
You are disconnected at the moment. Type 'connect' to connect to the server or 'help' for the list of supported commands.
[disconnected /] patch apply /<patch_download_url>/<patch_name>.zip
```
Patch information for JBoss EAP 6.x and 7.x is respectivelly maintained in <JBOSS_HOME>/.installation/identity.conf and <JBOSS_HOME>/.installation/JBoss EAP.conf files. Do not delete those hidden directories.
When a CLI command is listed on the jboss-cli.sh command line it must be in a single argument. Use quotes around it if it contains any white space or special characters:
```
./jboss-cli.sh 'patch apply /opt/jBoss/to/jboss-eap-7.2.3-patch.zip'
```
After applying the patch, it is necessary to restart JBoss EAP.
- This restart can be done with jboss-cli.sh
  - Standalone Mode
```
./jboss-cli.sh --connect -c "shutdown --restart=true"
```
  - Domain Mode
```
./jboss-cli.sh --connect -c "shutdown --restart=true --host=master"
```
- Depending on the content of the Patch applied, it may be necessary to restart via Startup Script, so that it is possible to recreate the PID and perform the update.
  *Access the Release Notes to learn about the content of the JBoss EAP Patch
  - Standalone Mode
```
./standalone.sh
```
  - Domain Mode
```
./domain.sh
```

Cumulative Patch (or Update) Downloads

JBoss Version	Cumulative Patch Downloads Link
JBoss EAP 7.4	This content is not included.JBoss EAP 7.4 Cumulative Patch Downloads
JBoss EAP 7.3	This content is not included.JBoss EAP 7.3 Cumulative Patch Downloads
JBoss EAP 7.2	This content is not included.JBoss EAP 7.2 Cumulative Patch Downloads
JBoss EAP 7.1	This content is not included.JBoss EAP 7.1 Cumulative Patch Downloads
JBoss EAP 7.0	This content is not included.JBoss EAP 7.0 Cumulative Patch Downloads
JBoss EAP 6.4*	This content is not included.JBoss EAP 6.4 Cumulative Patch Downloads
JBoss EAP 6.4*	JBoss EAP 6.4 Update 10 - requires Update 09 be applied.
JBoss EAP 6.4*	JBoss EAP 6.4 Update 20 and later - requires Update 19 be applied.
JBoss EAP 6.3	This content is not included.JBoss EAP 6.3 Cumulative Patch Downloads
JBoss EAP 6.2	This content is not included.JBoss EAP 6.2 Cumulative Patch Downloads

*Starting in JBoss EAP 6.4, the installation of the patches can be done using the Management Console.

Note: Some changes at the Management Console may require to clean the browser cache to be visualized.

[Main article with overview and links Updated Patch Management with EAP 6.2+](https://access.redhat.com/node/547673)
[JBoss EAP Footprint too Large after Applying an Update](https://access.redhat.com/solutions/1269123)

Diagnostic Steps

If you faceWFLYPAT0018, check the md5sum of downloaded patch. Compare it with md5sum sum mentioned on customer portal.

SBR

JBoss Base AS

Product(s)

Red Hat JBoss Enterprise Application Platform

Components

jbossas

Category

Upgrade

Tags

This solution is part of Red Hat’s fast-track publication program, providing a huge library of solutions that Red Hat engineers have created while supporting our customers. To give you the knowledge you need the instant it becomes available, these articles may be presented in a raw and unedited form.