JS7 JobScheduler

Space shortcuts

Page tree

Versions Compared

Old Version 5

changes.mady.by.user Andreas Püschel

Saved on

compared with

New Version 6

changes.mady.by.user Andreas Püschel

Saved on

Key

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

Table of Contents

Installing the JS7 Agent

Prerequisites

Preparation

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
    Download the Agent archive for the target system from the JS7 - Download page.
    • For Unix systems:
      • A tarball archive is available that can be 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 can be is extracted to create the Agent's directory structure (see below).

      Installation

            • 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
        • Unzip
      • the downloaded archive file to
        • an arbitrary
      • a directory.
      • The resulting directory structure includes (only files and folders immediately relevant):
        • agent 
          • bin
            • agent.cmd
              • The
        • start script
              • Start Script for Windows platforms
        • .
            • agent.sh
              • The
        • start script
              • Start Script for Unix platforms
        • .
            • agent_instance.sh-example
            • A
                  • The template for
            • configuring multiple instances of
                  • the
            • Universal
                  • Agent Instance Start Script
              • lib
                • The directory for Java libraries
            • .
              • var
            • _4445

                • logs
                  • The directory for log files
                • config/private
            • (for ssl configuration)
          • tmp (for internal use)
          • service (for Windows)
              • yade
                • For use of the YADE file transfer utility
              • service
                • For operation as a Windows Service
            • On Windows Systems:
              • You have to
            • change
              • 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 extracted the Agent to e.g. C:\ProgamData.

                • Start a command prompt with elevated administrative rights and

            • type

                • execute e.g.

                  Code Block
                  languagebash
                  title
            • set
                • Allow full acces for "Users" on .\service and .\logs
            • directory
                • directories
                  cd "path\to\
            • Agent 
                • 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
            • are configured
            • of an Agent starting from the same Agent installation are used then every instance must have its own ./var_
            • 4445 data directory (
            • <port of the instance> data directory, e.g. ./var_
            • <port of the instance>)

          Updating an Agent

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

          • js7_agent_windows.x.x.x.zip for windows
          • js7_agent_unix.x.x.x.tar.gz for Linux

          Preparation

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

          • Stop the JS7 Agent instance.
          • Prepare to rollback in case that the update of the JS7 Agent is not successful:
            • Create a .tar.gz/.zip archive for the
              • Installation Directory:
                • The default installation paths for the Agent are:

                  • /opt/sos-berlin.com/js7/agent on Linux Unix systems and,

                  • C:\Program Files\sos-berlin.com\js7\agent on Windows systems.
              • Configuration Directory
                • The default configuration paths directory for the Agent are:is
                  • /home/sos<user-account>/sos-berlin.com/js7/agent_<port> on Linux Unix systems and ,
                  • C:\ProgramData\sos-berlin.com\js7\agent_<port> on Windows systems.
          • Take a Backup of the above archives created.

          Note: For Linux environments taking the backup of the directories and extracting them at the time of rollback is sufficient, however, in case of Windows it is also required to re-install the service of the Agent.

          Update

          Installer Options 

          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 in 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.  

            Code Block
            languagexml
            titleConfiguration of the agent_install.xml file
            linenumbers
          • When the Agent was previously installed it added the agent_install.xml file that includes parameters such as the installation path, ports, etc.
            • The default location of the agent_install.xml file is:

              • /opt/sos-berlin.com/js7/agent on Linux systems and

              • C:\Program Files\sos-berlin.com\js7\agent on Windows.

          • The agent_install.xml file is explained with the code listing below. The extensive comments are intended to be self-explanatory.  

            Code Block
            languagexml
            titleConfiguration of the agent_install.xml file
            linenumberstrue
            collapsetrue
            <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- 
XML configuration file for JS7 Agent

If you call the installer with this XML file then 
you accept at the same time the terms of the 
SOS GmbH freeware license agreement; see  
http://www.sos-berlin.com/freeware-license-agreement
-->
<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
             It must be absolute!
             For example 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"/>
			<!-- Set optionally an ip address or hostname. It could be used for indicating which network 
				 interfaces the JS7 Agent should listen to when using HTTP. If it is 
                 empty then it listens to all available network interfaces. -->
            <entry key="agentHost" value=""/>
            <!-- Launch the JS7 Agent after installation? (yes|no) -->
            <entry key="launchAgent" value="yes"/>
            <!-- The JS7 Agent will be installed as Windows service. You can set the 
                 service account otherwise the local system account will be used. The account has to be 
                 the form '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 AND LOG FILES
             This directory has to be unique for each JS7 Agent instance.
             The path must be absolute!
             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 user 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 all jobs which started by the JS7 Agent
                 e.g. %USERPROFILE% (default: [installation path]) -->
            <entry key="workPath" value=""/>
            <!-- The JS7 Agent requires a Java JRE at least version '1.8'. You can choose 
                 a different Java environment than the Java which is used during this installation. -->
            <entry key="javaOptions" value=""/>
            <!-- Set optionally Java options (default: -Xms100m). -->
            <entry key="javaHome" 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

          • Install Running the installer of the JS7 Agent on Linux Windows systems for the root user:

            Code Block
            languagetext
            titleRunning the installer of JS7 Agent on Linux Windows systems with root permissions
            C:\temp\/tmp/agent.[release]> ./setup.shcmd agent_install.xml

          • Installer of the JS7 Agent on Linux systems for the current user:

            Code Block
            languagetext
            titleRunning the installer of JS7 Agent on Linux systems without root permissions
            /tmp/agent.[release]> ./setup.sh -u agent_install.xml

          • Running the installer of JS7 Agent on Windows systems

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

          Rollback

          To perform a rollback there are different steps to be followed for Windows and Linux.

          Rollback JS7 Agent Instance on Windows

          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
                  • C:\ProgramData
            To perform the rollback of a JS7 Agent instance run the uninstaller from the command line.
          • Restore the folders from the backup by unzipping the .tar.gz/.zip archive for the installation directory and configuration directory to the respective location.
            • Re-Install the windows service from the command line:
          • Switch to the ./bin directory for the Agent from the command line
            • The default location of the ./bin directory is:

              • C:\Program Files\sos-berlin.com\js7\agent\bin on Windows.

            • Run the below command. This command installs the Agent's Windows Service. 

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

          Rollback JS7 Agent Instance on Linux

          • To perform JS7 Agent instance rollback on Linux remove the newly created Installation and the configuration directory of the JS7 Agent.
          • Restore the folders from the backup by unzipping the .tar.gz archive for the installation directory and configuration directory to the respective location.

          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 subdirectory of the Agent configuration directory.

          • The default paths of the logs directory for the Agent are:
          • Installation log files are named according to the pattern, Install_V[release]_[date&time]_....log where release is the version release number and date and time refer to the installation.
                  • _<port>

          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 JS7 Agent from tarball/zip Archive Installation

          • To rollback the installation of a JS7 Agent instance on Unix 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 JS7 Agent 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 on Windows.
          • 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 on Windows.

            • Run the below command that installs the Agent's Windows Service:

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

            For further references about the logging refer to the complete overview of log files JS7 - Logging

          Automated Start-up and Shutdown

          For Unix systems , the start-up and shutdown configurations apply that are executed by root, e.g. in 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 , the start-up operation of the Agent by installing it as a Windows Service is recommended as such services can be configured to start/stop automatically on server start-up and shutdown.

          Further References

          ...