Versions Compared

Key

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

...

  • Patches are offered from .tar.gz tarball jar Java archive files or from .tar.jar Java 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|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.gzjar, js7_controller.2.2.3-PATCH.JS-1984.jartar.gz
  • Patch .tar.gz archive files
    • include one or more .jar files that hold patches.
    • include a directory hierarchy for .jar files:
      • controller/lib/patches

...

  • Unix
    • /opt/sos-berlin.com/js7/controller/lib/patches
  • Windows
    • C:\Program Files\sos-berlin.com\js7\controller\<controller-id>\lib\patches

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

Download Patch

Find the following examples for a patch:

ProductTypeFile ExtensionPatch Example Download URLHashSigTSR
JS7 Controller
tarball
Java archive.
tar.gz
jarhttps://download.sos-berlin.com/patches/2.2.3-patch/js7_controller.2.2.3-PATCH.JS-1984.
tar.gz
jarsha256sigtsr
Java

tarball archive.
jar
tar.gzhttps://download.sos-berlin.com/patches/2.2.3-patch/js7_controller.2.2.3-PATCH.JS-1984.
jar
tar.gzsha256sigtsr

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

...

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

The example patch does examples will not impact a Controller installation and is are used for instructional purposes only. For details see JS-1984.

...

Code Block
languagebash
titleExample how to apply a patch from a .tar.gz archive 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/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-O
Code Block
languagebash
titleExample how to apply a patch from a .jar file 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 filearchive
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

# -Oremove the patch archive
rm js7_controller.2.2.3-PATCH.JS-1984.tar.gz

Apply Patch on Windows

Code Block
languagebash
titleExample how to apply a patch from a .tar.gz archive 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-patchjs7patch/js7_controller.2.2.3-PATCH.JS-1984.tar.gzjar
@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 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-patch/js7_controller.2.2.3-PATCH.JS-1984.jartar.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.

...

Patches are automatically removed when a Controller release is installed updated using the the JS7 - Controller - Installation Using the Windows Graphical Installer or installation scripts as indicated with JS7 - Automated Installation and Update.

Patches can be manually removed by dropping the files in the patches sub sub-directory which holds the patch archivesfiles.

Note: The Controller instance has to be restarted stopped before patches are removed.

...

  • /var/sos-berlin.com/js7/controller/config/patches
  • The /var/sos-berlin.com/js7/controller directory is typically mounted to a var 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. Therefore patch files remain in place in the /var/sos-berlin.com/js7/controller/config/patches sub sub-directory (typically mounted to the config/patches volume directorya volume) as long as the patch is to be applied.

Note: The Controller container has to be restarted before to apply patches are applied.

Remove Patch

Patches are removed by dropping the files in the the config/patches sub-directory.

Patch files are automatically removed when updating or upgrading the Controller image.

Note: The Controller container has to be restarted to apply removal of patches.

...