Chapter 8. Upgrading Fuse Standalone on Karaf

• Updates any files, including bundle JARs, configuration files, and any static files.
• Patches both the current container instance (and its runtime storage under the data/ directory) and the underlying installation. Hence, patches are preserved after deleting a container instance.
• Updates all of the files related to Karaf features, including the features repository files and the features themselves. Hence, any features installed after the rollup patch will reference the correct patched dependencies.
• If necessary, updates configuration files (for example, files under etc/), automatically merging any configuration changes you have made with the configuration changes made by the patch. If merge conflicts occur, see the patch log for details of how they are handled.
• Most of the merge conflicts are resolved automatically. For example, the patch mechanism detects conflicts at property level for the property files. It detects whether it was a user or patch that changed any property. The change is preserved, if only one side changed the property.

• Tracks all of the changes made to the installation (including to static files), so that it is possible to roll back the patch.

  Note

  The rollup patching mechanism uses an internal git repository (located under patches/.management/history) to track the changes made.

Prerequisites

• Ensure you have a full backup of your Fuse on Apache Karaf installation before upgrading.
• Start the container, if it is not already running.

• Add the upgrade installer file to the container’s environment by invoking the patch:add command. For example, to add the fuse-karaf-7.13.0.fuse-7_13_0-00012-redhat-00001.zip upgrade installer file:

  patch:add file:///path/to/fuse-karaf-7.13.0.fuse-7_13_0-00012-redhat-00001.zip

  Note

  The patch:find command can only be used to find and add the latest hot fix patches to the container’s environment; it cannot be used to apply full upgrade patches.

  Procedure

  1. Run the patch:update command. There is no need to restart the container.

     karaf@root()> patch:update
     Current patch mechanism version: 7.1.0.fuse-710023-redhat-00001
     New patch mechanism version detected: 7.2.0.fuse-720035-redhat-00001
     Uninstalling patch features in version 7.1.0.fuse-710023-redhat-00001
     Installing patch features in version 7.2.0.fuse-720035-redhat-00001

  2. Invoke the patch:list command to display a list of upgrade installers. In this list, the entries under the [name] heading are upgrade IDs. For example:

     karaf@root()> patch:list
     [name]                                    [installed] [rollup] [description]
     fuse-karaf-7.2.0.fuse-720035-redhat-00001 false       true     fuse-karaf-7.2.0.fuse-720035-redhat-00001

  3. Simulate the upgrade by invoking the patch:simulate command and specifying the upgrade ID for the upgrade that you want to apply, as follows:

     karaf@root()> patch:simulate fuse-karaf-7.2.0.fuse-720035-redhat-00001
     INFO : org.jboss.fuse.modules.patch.patch-management (226): Installing rollup patch "fuse-karaf-7.2.0.fuse-720035-redhat-00001"
     ========== Repositories to remove (9):
      - mvn:io.hawt/hawtio-karaf/2.0.0.fuse-710018-redhat-00002/xml/features
     ...
     ========== Repositories to add (9):
      - mvn:io.hawt/hawtio-karaf/2.0.0.fuse-720044-redhat-00001/xml/features
     ...
     ========== Repositories to keep (10):
      - mvn:org.apache.activemq/artemis-features/2.4.0.amq-711002-redhat-1/xml/features
     ...
     ========== Features to update (100):
     [name]                         [version]                         [new version]
     aries-blueprint                4.2.0.fuse-710024-redhat-00002    4.2.0.fuse-720061-redhat-00001
     ...
     ========== Bundles to update as part of features or core bundles (100):
     [symbolic name]                                                [version]                         [new location]
     io.hawt.hawtio-log                                             2.0.0.fuse-710018-redhat-00002    mvn:io.hawt/hawtio-log/2.0.0.fuse-720044-redhat-00001
     ...
     ========== Bundles to reinstall as part of features or core bundles (123):
     [symbolic name]                                                [version]                         [location]
     com.fasterxml.jackson.core.jackson-annotations                 2.8.11                            mvn:com.fasterxml.jackson.core/jackson-annotations/2.8.11
     ...
     Simulation only - no files and runtime data will be modified.
     karaf@root()>

     This generates a log of the changes that will be made to the container when the upgrade is performed, but will not make any actual changes to the container. Review the simulation log to understand the changes that will be made to the container.

  4. Upgrade the container by invoking the patch:install command and specifying the upgrade ID for the upgrade that you want to apply. For example:

     karaf@root()> patch:install fuse-karaf-7.13.0.fuse-7_13_0-00012-redhat-00001

  5. Validate the upgrade, by searching for one of the upgrade artifacts. For example, if you had just upgraded Fuse 7.1.0 to Fuse 7.2.0, you could search for bundles with the build number, 7.2.0.fuse-720035-redhat-00001, as follows:

     karaf@root()> bundle:list -l | grep 7.2.0.fuse-720035-redhat-00001
      22 │ Active │  80 │ 7.2.0.fuse-720035-redhat-00001  │ mvn:org.jboss.fuse.modules/fuse-pax-transx-tm-narayana/7.2.0.fuse-720035-redhat-00001
     188 │ Active │  80 │ 7.2.0.fuse-720035-redhat-00001  │ mvn:org.jboss.fuse.modules.patch/patch-commands/7.2.0.fuse-720035-redhat-00001

Prerequisites

• You have recently upgraded Fuse on Karaf.
• You want to rollback the upgrade.