Chapter 2. Patching Red Hat JBoss Data Grid Server Instances

2.1. Applying Patches to Red Hat JBoss Data Grid Server Instances

Red Hat JBoss Data Grid server uses the patching functionality in JBoss Enterprise Application Platform (EAP) so that you can apply changes from errata releases without the need to completely replace an existing installation.

Patches are distributed for cumulative updates within a release version. The base version for this release is 7.2.0. You can apply 7.2.x patches to the base version or on top of other patches.

You cannot apply 7.2.x patches to any other JBoss Data Grid release version. Likewise you cannot apply patches from other release versions to the 7.2 release.

JBoss Data Grid provides patches for server instances only (Remote Client-Server mode). All other distributions, such as EAP modules, clients, and JBoss Data Grid Library mode, are provided as full releases.

Important

A known issue exists with the patch for JBoss Data Grid 7.2.2. You should not apply this patch to your JBoss Data Grid deployment. Use the patch for JBoss Data Grid 7.2.3 or later instead. See Known Issues for more information.

To apply a patch to JBoss Data Grid, do the following:

  1. Download the patch from the Red Hat Customer Portal at https://access.redhat.com/downloads/

  2. Stop the server instance that you want to patch if it is running.

    To avoid issues with classloading, you should not apply patches to JBoss Data Grid while the server is running.

    Either use the Administration Console to stop the server or enter Ctrl-C in the terminal where JBoss Data Grid is running.

  3. Open a terminal and change to the JDG_HOME directory. 

    $ cd JDG_HOME

  4. Apply the patch as follows: 

    $ bin/cli.sh "patch apply /path/to/jboss-datagrid-7.2.x-server-patch.zip"

  5. Start the server with either the standalone.sh or domain.sh script, for example: 

    $ bin/standalone.sh -c clustered.xml

2.2. Reverting Patches

You can roll back patches to revert the Red Hat JBoss Data Grid server to the previously installed version.

Important

You should roll back patches only after applying a patch that results in unexpected behavior or undesirable effects. Rolling back patches is not intended for general uninstall functionality.

To revert a JBoss Data Grid patch, do the following:

  1. Stop the server instance that you want to roll back if it is running.

    Either use the Administration Console to stop the server or enter Ctrl-C in the terminal where JBoss Data Grid is running.

  2. Open a terminal and change to the JDG_HOME directory. 

    $ cd JDG_HOME

  3. Find the ID of the patch that you want to roll back. 

    $ bin/cli.sh "patch history"

  4. Roll back the server version as follows: 

    $ bin/cli.sh "patch rollback --patch-id=PATCH_ID --reset-configuration=false"
    Warning

    Use caution when specifying the reset-configuration option.

    --reset-configuration=false does not revert the server configuration. Because applying patches can change the server configuration, it is possible that the server does not restart if you roll back the patch but do not roll back the configuration. In this case, you should verify the server configuration and manually adjust it as needed before starting the server.

    --reset-configuration=true reverts the server configuration to the pre-patch state. Any changes to the server configuration after the patch was applied are removed.

    If conflicts exist when you attempt to roll back the patch, the operation fails and warnings occur. Enter patch --help to list available arguments that you can use to resolve the conflicts.

  5. Start the server with either the standalone.sh or domain.sh script.