Skip to end of metadata
Go to start of metadata

Introduction

  • 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.
    • by running the Agent installer in headless mode.

Prerequisites

Download

  • Download the Agent archive for the target system from the JS7 - Download page.
    • For Unix systems:
      • A tarball archive is available that is extracted to create the Agent's directory structure (see below).
        • js7_agent_unix.<release>.tar.gz
    • For Windows systems:
      • A .zip archive is available that is extracted to create the Agent's directory structure (see below).
        • js7_agent_windows.<release>.zip
      • A .zip archive including the installer is available that is used to run the installer in headless mode.
        • js7_agent_windows_installer.<release>.zip

Installation from tarball/zip Archive

Installation

  • Extract the downloaded archive file to a directory.
  • The resulting directory structure includes (only files and folders immediately relevant):
    • agent 
      • bin
        • agent.cmd|sh
          • The Start Script for Windows/Unix platforms
        • agent_watchdog.cmd|sh
          • Restarts the Agent for Windows/Unix platforms
        • agent_instance.sh-example
          • The template for the Agent Instance Start Script
      • lib
        • The directory for Java libraries
      • var
      • yade
        • For use of the YADE file transfer utility
      • service
        • For operation as a Windows Service
    • On Windows Systems:
      • You have to modify the directory permissions for the above .\logs and .\service directories if you extracted the Agent to e.g. C:\Program Files.
        • This step is not required if you extract the Agent e.g. to C:\ProgamData.
        • Start a command prompt with elevated administrative rights and execute e.g.

          Allow full acces for "Users" on .\service and .\logs directories
          cd "path\to\installation-directory"
          icacls "service" /L /grant *S-1-5-32-545:(OI)(CI)F
          icacls "logs" /L /grant *S-1-5-32-545:(OI)(CI)F 
    • If multiple run-time instances of an Agent starting from the same Agent installation are used then every instance must have its own ./var_<port of the instance> data directory, e.g. ./var_4445, ./var_4447 etc.

Update

Preparation

  • Stop the JS7 Agent instance.
  • Prepare to rollback in case that the update of the JS7 Agent is not successful:
    • Take a backup of the Agent's installation directory and configuration directory, e.g. by creating a .tar.gz/.zip archive.
      • Installation Directory:
        • The default installation directory for the Agent is
          • /opt/sos-berlin.com/js7/agent for Unix systems,

          • C:\Program Files\sos-berlin.com\js7\agent for Windows systems.
      • Configuration Directory
        • The default configuration directory for the Agent is
          • /home/<user-account>/sos-berlin.com/js7/agent_<port> for Unix systems,
          • C:\ProgramData\sos-berlin.com\js7\agent_<port> for Windows systems.

Running the Update

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

  • When extracting files to the same location then existing files with the same name will be overwritten. Files added by the user remain in place.
    • This is particularly true for the Agent Start Script ./bin/agent.sh|cmd that should not be modified by users. Instead, apply changes to a new Agent Instance Start Script file  ./bin/agent_<port>.sh|cmd. This script is used to configure a number of environment variables and to finally execute the Agent Start Script.
  • The tarball/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 from Windows Installer in Headless Mode

The installer is available for Windows systems only. 

Installation

Installer Response File

  • The Agent installation makes use the agent_install.xml response file that includes parameters such as the installation path, ports, etc.
    • For a fresh installation the installer response file is included with the downloaded archive.
    • The default location of the agent_install.xml file from a previous installation is:
      • C:\Program Files\sos-berlin.com\js7\agent
  • The agent_install.xml file is explained with the code listing below. The comments included are intended to be self-explanatory.
    Download: agent_install.xml

    Configuration of the agent_install.xml file
    <?xml version="1.0" encoding="UTF-8" standalone="no"?>
    <!-- 
    XML configuration file for JS7 Agent setup
    
    The JS7 Agent is available with a dual license model:
    - GNU GPL v3.0 License, see https://www.gnu.org/licenses/gpl-3.0.en.html
    - JS7 Commercial License, see licence.txt
    
    The setup asks you for the desired license model,
    see below <entry key="licenceOptions" .../>
    
    If you run the installer and do not specify a commercial license key
    then at the same time you accept the terms of the
    licence agreement under the GNU GPL v3.0 License.
    
    -->
    <AutomatedInstallation langpack="eng">
        <com.izforge.izpack.panels.UserInputPanel id="home">
            <userInput/>
        </com.izforge.izpack.panels.UserInputPanel>
        <com.izforge.izpack.panels.HTMLLicencePanel id="license"/>
        <com.izforge.izpack.panels.TargetPanel id="target">
            
            <!-- SELECT THE INSTALLATION PATH
                 The path must be absolute!
                 The default path is C:\Program Files\sos-berlin.com\js7\agent -->
            <installpath>C:\Program Files\sos-berlin.com\js7\agent</installpath>
            
        </com.izforge.izpack.panels.TargetPanel>
        <com.izforge.izpack.panels.UserInputPanel id="network">
    		<userInput>
    						
    			<!-- HTTP port of the JS7 Agent -->
    			<entry key="agentPort" value="4445"/>
    			<!-- Optionally specify an IP address or hostname that is used to indicate which network 
    				 interface the JS7 Agent should listen to when using HTTP. If empty 
                     then the Agent listens to any available network interfaces. -->
                <entry key="agentHost" value=""/>
                <!-- Choose 'yes' or 'no' whether the JS7 Agent should be started after installation -->
                <entry key="launchAgent" value="yes"/>
                <!-- The JS7 Agent will be installed as a Windows Service. You can set the 
                     service account otherwise the local system account will be used. The account has to be 
                     specified according to the pattern 'Domain\User'. -->
    			<entry key="serviceAccount" value=""/>
                <entry key="servicePassword" value=""/>
                
    		</userInput>
    	</com.izforge.izpack.panels.UserInputPanel>
        <com.izforge.izpack.panels.UserPathPanel id="userpath">
            
            <!-- SELECT THE DIRECTORY FOR CONFIGURATION FILES AND LOG FILES
                 This directory has to be unique for each JS7 Agent instance.
                 The path must be absolute!
                 The default path is C:\ProgramData\sos-berlin.com\js7\agent_%agentPort%
                 where %agentPort% is the value from above entry 'agentPort' -->
            <UserPathPanelElement>C:\ProgramData\sos-berlin.com\js7\agent_4445</UserPathPanelElement>
            
        </com.izforge.izpack.panels.UserPathPanel>
        <com.izforge.izpack.panels.UserInputPanel id="environment">
            <userInput>
    
                <!-- Directory where the JS7 Agent's log files are stored
                     (default: '[above configuration path]\logs'). -->
                <entry key="logPath" value=""/>
                <!-- Directory where the JS7 Agent's PID file is stored 
                     (default: above log path). -->
                <entry key="pidFilePath" value=""/>
                <!-- Working directory for jobs started by the JS7 Agent
                     e.g. %USERPROFILE% (default: [installation path]) -->
                <entry key="workPath" value=""/>
                <!-- The JS7 Agent requires a Java JRE minimum version '1.8'. You can choose 
                     a different Java environment than the Java used during installation. -->
                <entry key="javaHome" value=""/>
                <!-- Optionally specify Java options (default: -Xms100m). -->
                <entry key="javaOptions" value=""/>
                
            </userInput>
        </com.izforge.izpack.panels.UserInputPanel>
        <com.izforge.izpack.panels.UserInputPanel id="end">
            <userInput/>
        </com.izforge.izpack.panels.UserInputPanel>
        <com.izforge.izpack.panels.InstallPanel id="install"/>
        <com.izforge.izpack.panels.ProcessPanel id="process"/>
        <com.izforge.izpack.panels.FinishPanel id="finish"/>
    </AutomatedInstallation>

Running the Installer

  • Running the installer of the JS7 Agent on Windows systems

    Running the installer of JS7 Agent on Windows systems
    C:\temp\agent.[release]> setup.cmd agent_install.xml

Installation Log

The installer creates a log file in the directory that is pointed to by the environment variable JS7_AGENT_LOGS or in the logs sub-directory of the Agent configuration directory.

  • The default location of the logs directory is:
    • C:\ProgramData\sos-berlin.com\js7\agent_<port>
  • Installation log files are named according to the pattern Install_V<release>_<date-time>_....log where <release> is the release number and <date-time> refers to the point in time of installation.

Update

Preparation

  • Stop the JS7 Agent instance.
  • Prepare to rollback in case that the update of the JS7 Agent is not successful.
    • Take a backup of the Agent's installation directory and configuration directory, e.g. by creating a .zip archive.
      • Installation Directory:
        • The default installation directory for the Agent is
      • Configuration Directory
        • The default configuration directory for the Agent is

Running the Update

The update procedure makes use of the same installer response file as explained for a fresh installation.

Steps to run the installer are the same as explained for a fresh installation.

Rollback

Rollback from tarball/zip Archive Installation

  • 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 directory.

Rollback from Installation with Headless Installer for Windows

  • 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 directory.
  • 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 below command that installs the Agent's Windows Service:

      agent.cmd install-service [--http-port=<number>] [--ip-address=<hostname or ip address>]

Automated Start-up and Shutdown

For Unix systems the start-up and shutdown configurations apply that are executed by root, e.g. from /etc/init.d or from corresponding locations and by systemd.

  • Consider use of the JS7_AGENT_USER environment variable to run an Agent that is started by root for a different user account.
  • For use with systemd find a sample service file from ./bin/agent.service-example file.

For Windows systems operation of the Agent by a Windows Service is recommended as such services can be configured to start/stop automatically on server start-up and shutdown.

Further References


  • No labels
Write a comment…