Versions Compared

Key

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

...

The following applies to use of patch files:

  • Patches are offered from .tar.gz tarball from .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_agent.<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_agent.2.2.3-PATCH.JS-1984.tar.gzjar, js7_agent.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:
      • agent/lib/patches

...

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

...

ProductTypeFile ExtensionPatch Example Download URLHashSigTSR
JS7 Agenttarball Java archive.tar.gzjarhttps://download.sos-berlin.com/patches/2.2.3-patch/js7_agent.2.2.3-PATCH.JS-1984.tar.gzjarsha256sigtsr

Java tarball archive.jartar.gzhttps://download.sos-berlin.com/patches/2.2.3-patch/js7_agent.2.2.3-PATCH.JS-1984.tar.jargzsha256sigtsr

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

...

Apply the following steps for to an Agent instance. If an Agent cluster is operated then these the steps are have to be performed for all Agent cluster members.

The example patch does examples will not impact an Agent 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 jar file to an Agent for Unix
linenumberstrue
# navigate to the target directory for patches
cd /opt/sos-berlin.com/js7/agent/lib/patches

# download the patch archivefile
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.gzjar -O



Code Block
languagebash
titleExample how to apply a patch from a .jar tar.gz file to an Agent for Unix
linenumberstrue
# navigate to the target directory for patches
cd /opt/sos-berlin.com/js7/agent/lib/patches

# download the patch filearchive
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 -Ojs7_agent.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 an Agent for Windows
linenumberstrue
@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.gzjar
@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



Code Block
languagebash
titleExample how to apply a patch from a .jar file tar.gz archive to an Agent for Windows
linenumberstrue
@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.jartar.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.

...

Patches are automatically removed when an Agent release is installed using the JS7 - Agent - 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 archives.

Note: The Agent has to be restarted to apply removal of patchesstopped before patches are removed.

Anchor
docker_containers
docker_containers
Apply Patch to Agent Containers

The Agent container Agent container expects Java .jar libraries files 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-directorydoes 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 Agent container checks the directory noted above for the existence of .jar files and applies the patches, for details see the Patches for Agent On Premises section above.

Patches are not applied persistently to a container. Therefore patch Patch files remain in place in the the /var/sos-berlin.com/js7/agent/config/patches sub sub-directory (typically mounted to the config/lib a volume directory) as long as the patch is to be applied) for the lifetime of the Agent release in use. Patch files have to be removed if a newer release of the Agent is used.

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

Remove Patch

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

Patch files are not automatically removed when updating or upgrading the Agent image. If a newer Agent release is used then this includes any fixes provided by previous patches. Users have to remove patch files when applying new releases.

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

...