Versions Compared

Key

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

...

  • The JS7 Agent can be installed and operated in any Unix and Windows environments that meet the prerequisites.
  • The Agent is installed on Unix systems without use of an installer by extracting a .tar.gz archive.
  • The Agent can be installed on Windows systems
    • without use of an installer by extracting a .zip archive. This allows a portable installation that requires no administrative privileges or
    • by running the Agent installer in headless mode.
    • by running the Agent graphical installer, see JS7 - Agent - Use of Using the Windows Graphical Installer.

...

The update of the JS7 Agent is performed from the same download archive as used for a fresh installation.

  • When extracting files to the same location a location that has already been used then existing files with the same name will be overwritten. Files added by the user will remain in place.
    • This is particularly true for the Agent Start Script ./bin/agent.sh|cmd, which should not be modified by users. Instead, apply changes to a new Agent Instance Start Script file  ./bin/agent_<http-port>.sh|cmd. This script is used to configure a number of environment variables and to finally execute before executing the Agent Start Script.
  • The .tar.gz/.zip archive includes Java libraries in the ./lib directory that ship with unique file names per Agent release.
    • Therefore, before extracting files, rename or remove an existing ./lib directory in order to store libraries from the current Agent release only to this directory.

...

Installation

After extraction of the installer .zip archive the directory structure includes:

...

  • Stop any running JS7 Agent instances. Note that more than one Agent instance can be launched from a single Agent installation.
  • Prepare to rollback in case the update of the JS7 Agent is not successful.
    • Take Make a backup of the Agent's installation directory and configuration directorydirectories, e.g. by creating a .zip archive.
      • Installation Directory:
        • The default installation directory for the Agent is
          • C:\Program Files\sos-berlin.com\js7\agent
      • Configuration Directory
        • The default configuration directory for the Agent is
          • C:\ProgramData\sos-berlin.com\js7\agent_<http-port>

...

  • To rollback the installation of a JS7 Agent instance remove the newly created installation directory and configuration directory of the JS7 Agent.
  • Restore the directories from a previous backup, e.g. by extracting the respective .tar.gz/.zip backup archives to the installation directory and configuration directorydirectories.

Rolling back an Installation by the Windows Installer in Headless Mode

  • To perform the rollback of a JS7 Agent installation run the uninstaller from the command line.
    • The default location of the uninstall.cmd file is:
      • C:\Program Files\sos-berlin.com\js7\agent\Uninstaller
  • Restore from a previous backup, e.g. by extracting the .tar.gz/.zip archive to the installation directory and configuration directorydirectories.
  • Re-install the Windows Service from the command line:
    • Switch to the .\bin directory of the Agent installation.
      • The default location of the .\bin directory is:
        • C:\Program Files\sos-berlin.com\js7\agent\bin

    • Run the Agent Instance Start Script installs the Agent's Windows Service:

      agent_<http-port>.cmd install-service

Automated Startup and Shutdown

For Unix systems startup Startup and shutdown configurations apply , which for Unix systems. These are executed by the root account e.g. from /etc/init.d scripts and use systemd.

...

Further References

...