Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Bugs, vulnerabilities and availability of patches are communicated with the SOS SOS Change Management System.
  • Find below the information The article provides information about how to apply patches to a JS7 the Controller.
    Display feature availability
    StartingFromRelease2.3.0
  • The article explains how to manually apply patches. For automated patching see see JS7 - Automated Installation and Update.

The following applies to use of patch files:

  • Patches are offered from .tar.gz tarball archive files or from .jar Java archive files.
  • The same patch files are applied to Unix and Windows.
  • Patch file names follow the scheme:
    • Unix, Windows: js7_controller.<release>-PATCH.<issue-key>.[tar.gz|jar]
    • The following placeholders are used:
      • release: The JS7 release number, see Releases.
      • issue-key: The issue key in the SOS Change Management System, for example: JS-1984.
    • Example:
      • Unix, Windows: js7_controller.2.2.3-PATCH.JS-1984.tar.gz, js7_controller.2.2.3-PATCH.JS-1984.jar
  • Patch .tar.gz archive files
    • include one or more .jar files that hold patches.
    • include a directory hierarchy for .jar files:
      • controller/lib/patches

Anchor
on_premises
on_premises

...

Patch

...

for Controller On Premises

The Controller expects Java .jar libraries for holding patches in the following locations:

...

The first part of the path including <controller-id> is specified during installation and defaults to controller, this can point to a different location. The lib/patches part will be the same for all installations.

Download Patch

Find the following examples for a patch:

This patch does not impact a Controller installation and is used for instructional purposes only. For details see JS-1984.

Effective download links for Controller patches are indicated with the respective Change Management issue.

Before applying patches users might want to verify the integrity and authenticity of downloaded files, see JS7 - Verifying releases.

Apply Patch

Apply the following steps for a Controller instance. If a Controller cluster is being operated then these steps are to be performed for all Controller instances.

The following example makes use of a patch available from example patch does not impact a Controller installation and is used for instructional purposes only. For details see JS-1984.

Apply Patch on Unix

Code Block
languagebash
titleExample how to apply a patch from a .tar.gz archive to a Controller for Unix
linenumberstrue
# navigate to the target directory for patches
cd /opt/sos-berlin.com/js7/controller/lib/patches

# download the patch archive
curl https://download.sos-berlin.com/patches/2.2.3-patch

...

/js7_controller.2.2.3-PATCH.JS-1984.tar.gz-O

# extract the patch archive that includes .jar files
tar -xvzf js7_controller.2.2.3

...

-PATCH.JS-1984.tar.gz

# remove the patch archive
rm js7_controller.2.2.3-PATCH.JS-1984.tar.gz
Code Block
languagebash
titleExample how to apply a patch from a .jar file to a Controller for Unix
linenumberstrue
# navigate to the target directory for patches
cd /opt/sos-berlin.com/js7/controller/lib/patches

# download the patch archivefile
curl https://download.sos-berlin.com/patches/patch-20220331-JS-1984-2.2.3-patch/js7_controller.2.2.3-PATCH.JS-1984.jar -O

Apply Patch on Windows

Code Block
languagebash
titleExample how to apply a patch from a .tar.gz archive to a Controller for Windows
linenumberstrue
@rem navigate to the target directory for patches
cd %ProgramFiles%\sos-berlin.com\js7\controller\<controller-id>\lib\patches

@rem download from URL https://download.sos-berlin.com/patches/2.2.3-patchjs7_controller.2.2.3-PATCH.JS-1984.tar.gz
@rem copy from download location (could be different from this example)
copy %USERPROFILE%\Downloads\js7_controller.2.2.3-PATCH.JS-1984.tar.gz .

@rem extract the patch archive that includes .jar files
tar.exe -xf js7_controller.2.2.3-PATCH.JS-1984.tar.gz
 
@rem remove the patch archive
del js7_controller.2.2.3-PATCH.JS-1984.tar.gz
Code Block
languagebash
titleExample how to apply a patch from a .jar file to a Controller for Windows
linenumberstrue
@rem navigate to the target directory for patches
cd %ProgramFiles%\sos-berlin.com\js7\controller\<controller-id>\lib\patches

@rem download from URL https://download.sos-berlin.com/patches/2.2.3-patch/js7_controller.-20220331-JS-1984-2.2.3-PATCH.JS-1984.jar
@rem copy from download location (could be different from this example)
copy %USERPROFILE%\Downloads\patch-20220331-JS-1984-js7_controller.2.2.3-PATCH.JS-1984.jar .

Notes

Note: The Controller instance has to be restarted to apply patches.

...