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 a JS7 Agent.
  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 .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_agent.<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_agent.2.2.3-PATCH.JS-1984.tar.gz, js7_agent.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:
    • agent/lib/patches

Patches for Agent On Premises

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

• Unix
  • /opt/sos-berlin.com/js7/agent/lib/patches
• Windows
  • C:\Program Files\sos-berlin.com\js7\agent\lib\patches

The paths noted above are specified during installation and can point to a different location. The lib/patches part of the path will be the same for all installations.

Download Patch

Find the following examples for a patch:

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

Effective download links for Agent 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 an Agent instance. If an Agent cluster is operated then these steps are to be performed for all Agent cluster members.

The example patch does not impact an Agent installation and is 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/agent/lib/patches

# download the patch archive
curl https://download.sos-berlin.com/patches/2.2.3-patch/js7_agent.2.2.3-PATCH.JS-1984.tar.gz -O

# extract the patch archive that includes .jar files
tar -xvzf js7_agent.2.2.3-PATCH.JS-1984.tar.gz

# remove the patch archive
rm js7_agent.2.2.3-PATCH.JS-1984.tar.gz

# navigate to the target directory for patches
cd /opt/sos-berlin.com/js7/agent/lib/patches

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

Apply Patch on Windows

@rem navigate to the target directory for patches
cd %ProgramFiles%\sos-berlin.com\js7\agent\lib\patches

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

@rem navigate to the target directory for patches
cd %ProgramFiles%\sos-berlin.com\js7\agent\lib\patches

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

@rem extract the patch archive that includes .jar files
tar.exe -xf js7_agent.2.2.3-PATCH.JS-1984.tar.gz
 
@rem remove the patch archive
del js7_agent.2.2.3-PATCH.JS-1984.tar.gz

Notes

Note: The Agent 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 an Agent release is installed using the JS7 - Agent - Installation Using the Windows Graphical Installer.

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

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

Apply Patch to Agent Containers

The Agent container expects Java .jar libraries for patches in the following location:

• /var/sos-berlin.com/js7/agent/config/patches
• The directory /var/sos-berlin.com/js7/agent typically is mounted to a var volume when running the container: for details see the JS7 - Agent Installation for Containers article.
• If the config/patches sub-directory does not exist then it should be created before storing the patch file.

Apply Patch

On start-up the Agent container checks the directory noted above for the existence of .jar files and applies the patches, for details see the 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/agent/config/patches sub-directory (typically mounted to the config/lib volume directory) as long as the patch is to be applied.

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

Remove Patch

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

Patch files are automatically removed when updating or upgrading the Agent.

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