Introduction
SOS provides JS7 - Patch Management in the event of severe bugs or Vulnerabilities.
- Bugs, vulnerabilities and availability of patches are communicated with the SOS Change Management System.
- The article provides information about how to apply patches to the Controller.
FEATURE AVAILABILITY STARTING FROM RELEASE 2.3.0 - The article explains how to manually apply patches. For automated patching see JS7 - Automated Installation and Update.
The following applies to use of patch files:
- Patches are offered from .jar Java archive files or from .tar.gz tarball 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>.[jar|tar.gz]
- The following placeholders are used:
- Example:
- Unix, Windows:
js7_controller.2.2.3-PATCH.JS-1984.jar
,js7_controller.2.2.3-PATCH.JS-1984.tar.gz
- Unix, Windows:
- Unix, Windows:
- Patch .tar.gz archive files
- include one or more .jar files that hold patches.
- include a directory hierarchy for .jar files:
controller/lib/patches
Patch for Controller On Premises
The Controller expects Java .jar files holding patches in the following locations:
- Unix
/opt/sos-berlin.com/js7/controller/lib/patches
- Windows
C:\Program Files\sos-berlin.com\js7\controller\lib\patches
The paths noted above are specified during installation and can point to a different location. The lib/patches
part is the same for any installation of a Controller.
Download Patch
Find the following examples for a patch:
Product | Type | File Extension | Patch Example Download URL | Hash | Sig | TSR |
---|---|---|---|---|---|---|
JS7 Controller | Java archive | .jar | https://download.sos-berlin.com/patches/2.2.3-patch/js7_controller.2.2.3-PATCH.JS-1984.jar | sha256 | sig | tsr |
tarball archive | .tar.gz | https://download.sos-berlin.com/patches/2.2.3-patch/js7_controller.2.2.3-PATCH.JS-1984.tar.gz | sha256 | sig | tsr |
The patch examples will not impact a Controller installation and are 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 to a Controller instance. If a Controller cluster is operated then the steps have to be performed for all Controller instances.
The patch examples will not impact a Controller installation and are used for instructional purposes only. For details see JS-1984.
Apply Patch on Unix
# navigate to the target directory for patches cd /opt/sos-berlin.com/js7/controller/lib/patches # download the patch file curl https://download.sos-berlin.com/patches/2.2.3-patch/js7_controller.2.2.3-PATCH.JS-1984.jar -O
# 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
Apply Patch on Windows
@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.2.2.3-PATCH.JS-1984.jar @rem copy from download location (could be different from this example) copy %USERPROFILE%\Downloads\js7_controller.2.2.3-PATCH.JS-1984.jar .
@rem navigate to the target directory for patches cd %ProgramFiles%\sos-berlin.com\js7\controller\lib\patches @rem download from URL https://download.sos-berlin.com/patches/2.2.3-patch/js7_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
Notes
Note: The Controller instance has to be restarted to apply patches.
Hint: For automated rollout of patches see JS7 - Automated Installation and Update.
Remove Patch
Patches are automatically removed when a Controller instance is updated or upgraded using the JS7 - Controller - Installation Using the Windows Graphical Installer or the installation scripts as indicated with JS7 - Automated Installation and Update.
Patches can be manually removed by dropping the files in the patches
sub-directory which holds the patch files.
Note: The Controller instance has to be stopped before patches are removed.
Apply Patch to Controller Containers
The Controller container expects Java .jar files for patches in the following location:
/var/sos-berlin.com/js7/controller/config/patches
- The
/var/sos-berlin.com/js7/controller
directory is typically mounted to avar
volume when running the container: for details see the JS7 - Controller Installation for Containers article. - If the sub-directory
config/patches
does not exist then it should be created before storing the patch file. - If a patch is provided from a .tar.gz archive file then users should extract the archive and store the .jar files included to the
config/patches
sub-directory.
Apply Patch
On start-up the Controller container checks the directory noted above for the existence of .jar files and applies the patches - for details see the Patch for Controller On Premises section above.
Patches are not applied persistently to a container. Patch files remain in place in the /var/sos-berlin.com/js7/controller/config/patches
sub-directory (typically mounted to a volume) for the lifetime of the Controller release in use. Patch files have to be removed if a newer release of the Controller is used.
Note: The Controller container has to be restarted to apply patches.
Remove Patch
Patches are removed by dropping the files in the config/patches
sub-directory.
Patch files are not automatically removed when updating or upgrading the Controller image. If a newer Controller release is used then this includes any fixes provided by previous patches. Users have to remove patch files when applying new releases.
Note: The Controller container has to be restarted to apply removal of patches.