Chapter 2. Applying Patches to JBoss Data Grid

2.1. Patching Existing Server Instances

Micro releases for the JBoss Data Grid server are distributed as a patch. This is for your convenience, as the new version will not completely replace the installation. The base version to be patched is the x.y.0 release, and the patches x.y.# (micro release or cumulative patch) may be applied to that instance. The patch can be rolled back (including the configuration) if there is any issue during the patching process, and any subsequent patches may be applied in the same way.

This process is similar to the already known procedure in JBoss Enterprise Application Platform (EAP).

Applying the JBoss Data Grid 7.1.2 patch

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

2) Connect to the running instance to be patched using the JBoss CLI: 

$JDG_HOME/bin/cli.sh --connect --controller=127.0.0.1:9990

3) Ensure there are no active connections to the server, and then apply the patch: 

patch apply /path/to/jboss-datagrid-7.1.2-server-patch.zip

4) Restart the server: 

shutdown --restart=true

All other distributions, such as the EAP modules, clients, and standalone library mode are provided as a full release. Due to this there is no possibility to patch existing archives for these distributions.

2.2. Rolling Back the Server Version

You can roll back patches to revert the 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.