Table of Contents

Installing the JS7 Agent

Prerequisites

A Java Runtime Environment starting from version 1.8 is required.
For details see Which Java versions is JobScheduler available for?

Preparation

Download the Agent archive for the target system from the JobScheduler Download page.
- For Unix systems:
  - A tarball archive is available that can be extracted to create the Agent's directory structure (see below).
- For Windows systems:
  - A .zip archive is available that can be extracted to create the Agent's directory structure (see below)
  - An installer zip archive is available that can be used for graphical installation of an Agent.

Installation

Unzip the downloaded file to an arbitrary directory.
The resulting directory structure includes (only files and folders immediately relevant):
- bin
  - agent.cmd
    - The start script for Windows platforms.
  - agent.sh
    - The start script for Unix platforms.
  - agent_instance.sh-example
    - A template for configuring multiple instances of the Universal Agent
- lib
  - The directory for Java libraries.
  - Configure the settings in log4j2.xml file if you want to adjust the logger settings.
- var_4445
  - logs
  - config/private (for ssl configuration)
  - tmp (for internal use)
- service (for Windows)

On Windows Systems:

You have to change the directory permissions for the .\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 e.g.

Code Block

language	bash
title	set full acces for "Users" on .\service and .\logs directory

cd "path\to\Agent installation"
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 instances are configured then every instance must have its own ./var_4445 data directory (e.g. ./var_<port of the instance>)

Updating an Agent

Preparations for an update
- Stop the Agent instance.
- Remove the ./lib directory.
Unzip the downloaded file to the installation directory.
If you use the Windows installer of JobScheduler Universal Agent then the ./lib directory is updated automatically during the setup. It is not necessary to remove the ./lib directory before you start the installer.

Running the Agent

SOS does not recommend to run the Agent as root (for Unix) or as Administrator (for Windows).
Instead the user account should be used that jobs are executed for. Should jobs be executed for a number of user accounts then consider the chapter Running multiple instances of JobScheduler Universal Agent.

Usage

Running the Agent start script without parameters shows the usage clause:

Code Block

language	text
title	Usage for Unix

Usage: agent.sh command [options] [web services]
  command:
    start           [options]
    start_docker    [options]
    stop            [options]
    abort           [options]
    restart         [options]
    status          [options] [web services]
    kill            [options]
 options:
    -http-port=<[hostname or ip address:]number>     | to listen to a specific host name or ip address if it is specified; default port: 4445, 
    -https-port=<[hostname or ip address:]number>    | 
    -data-directory=<location of data directory>     | default: ./var_4445
    -config-directory=<location of config directory> | default: ./var_4445/config
    -kill-script=<location of kill script>           | default: "./bin/agent_kill_task.sh"; only for start
    -java-options=<java options>                     | default: -Xms100m; see https://kb.sos-berlin.com/x/aIC9
    -job-java-options=<java options>                 | 
 web services:
    overview                                         | default
    task                                             | running Agent tasks
    tunnel                                           | tunnels summary
    tunnel/                                          | list of tunnels
    command                                          | running command summary
    command/                                         | list of running commands (watching file_order_source)

Code Block

language	text
title	Usage for Windows

Usage: agent.cmd command [options] [web services]
  command:
    start           [options]
    stop            [options]
    abort           [options]
    restart         [options]
    status          [options] [web services]
    kill            [options]
    install-service [options]
    remove-service  [options]
    start-service   [options]
 options:
    -http-port=<[hostname or ip address:]number>     | to listen to a specific host name or ip address if it is specified; default port: 4445, 
    -https-port=<[hostname or ip address:]number>    | 
    -data-directory=<location of data directory>     | default: .\var_4445
    -config-directory=<location of config directory> | default: .\var_4445\config
    -kill-script=<location of kill script> | default: ".\bin\agent_kill_task.cmd"; only for start, debug
    -java-options=<java options>           | default: -Xms100m; see https://kb.sos-berlin.com/x/aIC9
    -job-java-options=<java options>       | 
 web services:
    overview                               | default
    task                                   | running Agent tasks
    tunnel                                 | tunnels summary
    tunnel/                                | list of tunnels
    command                                | running command summary
    command/                               | list of running commands (watching file_order_source)

Command Line Options

-http-port=<[hostname or ip address:]number>
- is the HTTP port that the Agent is listening to in order to receive requests from a JobScheduler Master:
  - ```
  jobscheduler_agent.cmd|sh command -http-port=####
```
- where #### is the numeric port.
- This option can be also used to indicate which network interfaces the JobScheduler Agent should listen to if you specify a hostname or IP address in addition
- Without this option being used the port defaults to 4445 and the Agent listens to all available network interfaces.
- Should you want to specify a port then the following precedence applies:
  - First precedence: command line option
  - Second precedence: environment variable JS7_AGENT_HTTP_PORT (see below)
  - Third precedence: use of default value
-https-port=<[hostname or ip address:]number>
- is the HTTPS port that the Agent is listening to in order to receive requests from a Controller:
  - ```
  agent.cmd|sh command -https-port=####
```
- where #### is the numeric port.
- This option can be also used to indicate which network interfaces the Agent should listen to if you specify a hostname or IP address in addition
- Without this option being used the port defaults to 4445 and the Agent listens to all available network interfaces.
- Should you want to specify a port then the following precedence applies:
  - First precedence: command line option
  - Second precedence: environment variable SJS7_AGENT_HTTPS_PORT (see below)
  - Third precedence: use of default value
-data-directory=<number>
- Location of the data directory.
- It has to be unique for all Agent instances
- Should you want to specify a data directory then the following precedence applies:
  - First precedence: command line option
  - Second precedence: environment variable JS7_AGENT_DATA (see below)
  - Third precedence: use of default value (=JS7_AGENT_HOME/var_<JS7_AGENT_PORT>)
-kill-script=<location of kill script>
- The kill script provides the functionality to kill a task and any child processes.
- Two kill script is provided from
  - ./bin/jobscheduler_agent_kill_task.sh for Unix.
  - .\bin\jobscheduler_agent_kill_task.cmd for Windows.
- This option can be used to specify the location of a different "kill script" if required.
- Should you want to specify a different "kill script" then the following precedence applies:
  - First precedence: command line option
  - Second precedence: environment variable JS7_AGENT_KILL_SCRIPT (see below)
  - Third precedence: use of default value
-java-options=<java options>
- With Java 1.8 the initial memory allocation has changed, for details see How to manage the Java heap space.
- This option can be used to apply Java options for the Agent, e.g. the memory settings.
- Without this option being used the Java options default to '-Xms100m'.
- Should you want to specify the Java options then the following precedence applies:
  - First precedence: command line option
  - Second precedence: environment variable JAVA_OPTIONS (see below)
  - Third precedence: use of default value
-job-java-options=<java options>
- Without this option being used the Java options for each job which is started by the Agent.
- Should you want to specify the Java options for execution of JITL jobs and JVM jobs then the following precedence applies:
  - First precedence: command line option
  - Second precedence: environment variable JS7_AGENT_JOB_JAVA_OPTIONS (see below)

Starting the Agent

Code Block

language	bash

agent.cmd|sh start [options]

Stopping the Agent

Code Block

language	bash

agent.cmd|sh stop [options]

This command will safely terminate the Agent (recommended).

The Agent waits for running processes to be completed.

Code Block

language	bash

agent.cmd|sh abort [options]

The Agent process is terminated immediately.

Any running tasks and child processes are killed immediately with a SIGKILL signal.
Should tasks use resources such as database connections then they will not be properly closed.

Code Block

language	bash

agent.cmd|sh kill [options]

The Agent process is killed.

This corresponds to sending SIGKILL with a kill command.
Should jobs be running that started detached child processes then it is not guaranteed that child processes will be killed.

Restarting the Agent

Code Block

language	bash

agent.cmd|sh restart [options]

Checking the Agent Status

Code Block

language	bash

agent.cmd|sh status [options]

Should the Agent be up and running then this command will result in some output such as:

Code Block

language	bash

isTerminating: false
system:
  hostname: agenthost
  mxBeans:
    operatingSystem:
      processCpuLoad: 2.5630713121704744E-5
      availableProcessors: 4
      freePhysicalMemorySize: 311668736
      systemCpuLoad: 0.046373903924522855
      committedVirtualMemorySize: 4475301888
      totalPhysicalMemorySize: 3155517440
java:
  systemProperties:
    java.vendor: Oracle Corporation
    os.arch: amd64
    os.version: 2.6.32-220.17.1.el6.x86_64
    os.name: Linux
    java.version: 1.8.0_31
version: 1.10.0-SNAPSHOT (6956c56a535d15fcf659f293c42d22dcf92e9e12 2015-07-15 21:23:24+02:00)
startedAt: '2015-07-17T08:38:30.516Z'
totalTaskCount: 21
currentTaskCount: 0

Should the Agent not be running then some output is provided such as:

Code Block
ERROR: spray.can.Http$ConnectionAttemptFailedException: Connection attempt to localhost:4445 failed ...JS7 Agent(4445) not started!

Monitoring Agents

See the JS7 - Active Checks with a System Monitor article for information how to configure an automated status check of Agents for monitoring purposes.

Controller/Agent Compatibility

The Agent will raise an error if it is contacted by a Controller that is not compatible with the Agent's version.

Working Directory for Jobs

The JS7_AGENT_WORK_DIR environment variable can be used to modify the working directory of jobs. The default value is the same as JS7_AGENT_HOME. Alternative locations include values such as $HOME (Unix) or %USEERPROFILE% (Windows).

Windows Service Interface: Usage

The following information applies to batch installation on Windows systems. For installation with a GUI and user dialog see JobScheduler Universal Agent - Installation with Windows Installer.

The Agent is operable as a Windows Service. The start script of the Agent allows to install/remove the Windows Service.

Installing the Windows Service

Code Block

language	bash

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

This command installs the Agent's Windows Service. After the installation you find the Windows Service with the name SOS JS7 Agent -port=<number> in the Services Manager Console. The Windows service uses the "local system" account.

Warning

During the service installation it tries to copy the executable file for the Windows Service to the .\service directory. This operation could fail with the error "Access denied" if you have extracted the Agent to e.g. C:\Program Files. In this case you can change the permissions of the .\service directory or open the command prompt with elevated administrator rights and execute the above command once more.

Starting the Windows Service

Code Block

language	bash

agent.cmd start-service [-http-port=<number>]

This command starts the Windows Service with the name SOS JS7 Agent -port=<number>.

Info
The `stop` command contains more than a simple `stop-service` command: the `stop` command checks whether the Agent was started through the CLI or as a Windows Service and stops the Agent accordingly. Therefore there is no `stop-service` command.

Removing the Windows Service

Code Block

language	bash

agent.cmd remove-service [-http-port=<number>]

This command removes the Windows Service. After executing this command you will not find the Windows Service with the name SOS JS7 Agent -port=<number> in the Services Manager Console any longer.

Warning

During removal of the service it tries to remove the executable file of the Windows Service from the .\service directory. This operation could fail with the error "Access denied" if you have extracted the Agent to e.g. C:\Program Files. In this case you can change the permissions of the .\service directory or open the command prompt with elevated administrator rights and execute the above command once more.

Configuring the Windows Service

After the installation of the Windows Service you will find the .\service\sos_js7_agent_<http-port>w.exe file. Start this program to configure the Windows Service.

...

Image Removed

...

For example goto the "Startup" tab
to modifiy the start parameter

...

Log File
- On startup the Agent creates a log file in the directory that is pointed to by the environment variable JS7_AGENT_LOG_DIR or in the var_4445/logs sub-directory of the Agent installation directory.
- Log file names are created from a prefix and from the port used by the Agent like this:
  - agent.log
- Log files are rotated for each day (see ./lib/log4j2.xml) for which job activities occur.
- Rotated log files are assigned file names like this: agent.log.<yyyy-MM-dd>
- For days where the Agent has no jobs to execute no log rotation will be performed.
PID File
- On startup the Agent creates a PID file in the directory that is pointed to by the environment variable JS7_AGENT_PID_FILE_DIR or in the log directory. The PID file contains the Process ID of the system process that the Agent is running in.
- The PID file is used in order to prevent the Agent to be started twice with the same settings and it can be used for shutdown scripts that require the PID to terminate the process.
- PID file names are created like this:
  - agent.pid
Further References
- For individual configuration of log rotation and log retention see JS7 - Log Rotation

...

Introduction

The JS7 Agent can be installed and operated in any Unix and Windows environments that meet the prerequisites listed below.
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.
- by running the Agent graphical installer, see JS7 - Agent - Installation Using the Windows Graphical Installer.

Prerequisites

A Java Runtime Environment starting from version 1.8 is required. For details see Which Java versions is JobScheduler available for?
It is recommended that a time service is operated on the server that hosts the Agent in order to synchronize the system clock's time.

Download

Download the Agent archive for the target system from the JS7 - Download page.
- For Unix systems:
  - A .tar.gz 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 that is used to run the installer in headless mode is available.
    - js7_agent_windows_installer.<release>.zip

Installation Video

This video explains the installation.

Widget Connector

url	https://www.youtube.com/watch?v=Bgm6MjJCp4w&ab_channel=JobScheduler

Installation from the .tar.gz/.zip Archive

Installation

Extract the downloaded archive file to a directory.

After extraction the resulting directory structure includes (only files and folders immediately relevant):

agent
- license.gpl (copy of GPLv3 (General Public License) used for the Open Source JS7 - License)
- license.html (HTML format of license terms for the commercial JS7 - License)
- license.txt (plain text format of license terms for the commercial JS7 - License)
- sbom.json (JS7 - Software Bill of Materials)
- ThirdParty.txt (list of 3rd party components and licenses used by JS7)
- bin
  - anonymize-logs.sh|.cmd (used to anonymize log files, see JS7 - Log Anonymization)
  - agent.sh|.cmd (Start Script for Unix/Windows platforms)
  - agent.service-example (sample file for use with JS7 - systemd Service Files for automated Startup and Shutdown with Unix Systems)
  - agent_credential_value.sh|.cmd (Script for access to a Credential Store on Unix/Windows platforms)
  - agent_instance.sh-example (template for the Agent Instance Start Script)
  - agent_watchdog.sh|.cmd (restarts the Agent for Unix/Windows platforms if not operated as a Daemon/Service, called by Start Script)
- lib (directory for Java libraries)
  - log4j2.xml (used for based console logging to stdout, see JS7 - Logging)
  - patches (used for JS7 - Patches for Agent, the directory is cleaned up when running the installer)
  - user_lib (used for individual .jar files such as JDBC Drivers, see JS7 - Database)
  - (additional directories for Java libraries)
- service (directory for operation as a Windows Service)
  - install_agent_windows_service.cmd (used by installer)
  - LICENSE.txt (copy of Apache License, Version 2.0)
  - NOTICE.txt (Apache Commons Daemon license notice)
  - RELEASE-NOTES.txt (Apache Commons Daemon release notes)
  - uninstall_agent_windows_service.cmd (used by uninstaller)
  - amd64
  - manager
  - x86
- var (data directory, to be copied to var_<http_port> directory based on the HTTP port used by the Agent)
  - config (directory for configuration files)
    - agent.conf (general Agent configuration, see JS7 - Agent Configuration Items)
    - private (directory for security related configuration files)
      - private.conf-example (security related configuration, see JS7 - Agent Configuration Items)
        For setting up JS7 - Agent HTTPS Connections
        For setting up authentication and digital signature checks
      - trusted-pgp-keys (empty directory, can be used to add individual PGP public keys for signing, see JS7 - Secure Deployment of Scheduling Objects)
      - trusted-x509-keys (directory to hold X.509 certificates for signing, see JS7 - Secure Deployment of Scheduling Objects)
        sos.intermediate-ca.pem (default certificate of SOS to allow deployment with JOC Cockpit)
  - logs (directory for log files)
  - state (directory for journal files, will be created on startup of the Agent)
  - work (directory for work files)
- yade (directory for the YADE file transfer utility)

On Windows Systems:

You have to modify the directory permissions for the above-mentioned .\logs and .\service directories if you extracted the Agent to, for example, C:\Program Files.

This step is not required if you extract the Agent to, for example, C:\ProgamData.

Start a command prompt with elevated administrative rights and execute, for example:

Code Block

language	bash
title	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 more than one run-time instance of an Agent starting from the same Agent installation is used then every instance has to use its individual ./var_<http-port> data directory, e.g. ./var_4445, ./var_4447 etc. as each Agent instance has to use an individual port when operated on the same server.
- This allows to operate each Agent instance with a different run-time account executing jobs within the context of this account.
- Alternatively users can switch the run-time account on a per job basis, see JS7 - Running Jobs as a different User.
To start the Agent you can use the commands explained in the JS7 - Agent - Command Line Operation article or your can automate startup from the instructions provided by the Automated Start-up and Shutdown section below.

Update and Upgrade

Detailed instructions are available in the JS7 - Update and Patch Management article.

Preparation

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 the event of the update of the JS7 Agent not being successful:
- Make a backup of the Agent's installation directory and data 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.
  - Data Directory
    - The default data directory for the Agent is
      - /home/<user-account>/sos-berlin.com/js7/agent_<http-port> for Unix systems,
      - C:\ProgramData\sos-berlin.com\js7\agent_<http-port> for Windows systems.

Running the Update

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

When extracting files to 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 before executing the Agent Start Script.
The .tar.gz/.zip archive includes Java libraries in the ./lib directory that ship with file names that are unique to every 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.

Example for Installation from the Unix Command Line

The Agent is installed with a few straightforward commands:

Code Block

language	bash
title	Example how to install from the Unix command line
linenumbers	true

# download archive (consider using a current release that matches the Controller release)
curl  'https://download.sos-berlin.com/JobScheduler.2.1/js7_agent_unix.2.1.1.tar.gz' --output js7_agent_unix.2.1.1.tar.gz

# extract archive
tar xvzf js7_agent_unix.2.1.1.tar.gz

# find extracted files in the "agent" sub-directory
ls -la agent

# prepare an instance start script from the example using default port 4445
cd agent/bin
cp -p agent_instance.sh-example agent_4445.sh

# optionally activate/adjust environment variables in agent_4445.sh
# JS7_AGENT_HTTP_PORT=4445
# JAVA_HOME=...

# copy original var directory to var_<port> indicating the port used by the Agent
cp -p -R ../var ../var_4445

# alternatively for an existing var_4445 directory you can add the default certificate to verify signed workflows
# cp ../var/config/private/trusted-x509-keys/* ../var_4445/config/private/trusted-x509-keys/

# run the Agent
./agent_4445.sh start

# find log output
tail -100 ../var_4445/logs/agent.log

Installation using the Windows Installer in Headless Mode

The installer is available for Windows systems only.

To run the Windows installer in graphical mode see the JS7 - Agent - Installation Using the Windows Graphical Installer article.
Refer to the information below to run the Windows installer in headless mode..

Installation

After extraction of the installer .zip archive the directory structure will include:

agent_install.xml (installer response file)
install_agent.txt (installation notes)
js7_agent_windows.<release>.jar (installer library for a given release)
license.txt, license.html (copy of JS7 JobScheduler Commercial License Agreement)
setup.cmd (installer script)

Installer Response File

The Agent installation uses the agent_install.xml response file, which 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

Code Block

language	xml
title	Configuration of the agent_install.xml file
linenumbers	true
collapse	true

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- 
XML installer response 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 license.txt

The setup asks you for the desired license model,
see below <entry key="licenseOption" .../>

If you run the installer and do not specify a commercial license key
then at the same time you accept the terms of the
license 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.UserInputPanel id="licenses">
        <userInput>
        
            <!-- Select the license model (GPL or Commercial) -->
            <entry key="licenseOption" value="GPL"/>
            
        </userInput>
    </com.izforge.izpack.panels.UserInputPanel>
    <com.izforge.izpack.panels.HTMLLicencePanel id="gpl_license"/>
    <com.izforge.izpack.panels.HTMLLicencePanel id="commercial_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

Run the installer for the JS7 Agent on Windows systems with the following command:
Code Block
language text
title Running the installer of JS7 Agent on Windows systems
C:\temp\agent.[release]> setup.cmd agent_install.xml

Directory Structure

After installation the resulting directory structure will be similar to that described in the Installation from .tar.gz/.zip Archive section above.

Directories for installation and configuration of the Agent might differ.

Installation Log

The installer creates a log file in the directory specified in the JS7_AGENT_LOGS environment variable or in the logs sub-directory of the Agent data directory.

The default location of the logs directory is:
- C:\ProgramData\sos-berlin.com\js7\agent_<http-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.
For further information about logging see the JS7 - Logging article.

Update

Preparation

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.
- Make a backup of the Agent's installation and configuration directories, 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
  - Data Directory
    - The default data directory for the Agent is:
      - C:\ProgramData\sos-berlin.com\js7\agent_<http-port>

Running the Update

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

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

Rollback

Rolling back an Installation from .tar.gz/.zip Archive

To rollback the installation of a JS7 Agent instance, remove the newly created installation and configuration directories 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 and configuration directories.

Rolling back an Installation by the Windows Installer in Headless Mode

To perform a 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 and configuration directories.
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

Anchor
automated_startup_shutdown
automated_startup_shutdown
Automated Start-up and Shutdown

Start-up and shutdown configurations apply for Unix systems. These are executed by the root account e.g. from /etc/init.d scripts and use systemd.

Note the use of the JS7_AGENT_USER environment variable from the ./bin/agent_<http-port>.sh Instance Start Script to run an Agent that is started by root for a different user account.
A sample service file for use with systemd can be found at ./bin/agent.service-example.
For details see JS7 - systemd Service Files for automated Startup and Shutdown with Unix Systems

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

Consider assigning a service account to the JS7 Agent service with the Windows Service Panel.
Consider allowing the JS7 Agent service to be automatically started on server start-up.

Initial Operation

Having completed the installation or update of a JS7 Agent you can start the Agent either manually or from its Unix daemon/Windows Service, see JS7 - Agent Command Line Operation.

Further References

Installation
- JS7 - Agent - Installation Using the Windows Graphical Installer
Operation
- JS7 - Agent - Command Line Operation
Configuration
- JS7 - Configuration Items
- JS7 - Agent HTTPS Connections

...

The following environment variables can be used:

JAVA_HOME
- points to the location of the Java Runtime Environment (JRE).
- Without setting this environment variable Java will be used from the location specified by the system path.
- Please consider that JAVA_HOME does not point to the location of a JDK but to a JRE directory where the bin/java executable resides.
JAVA_OPTIONS
- sets Java options, e.g. the Java memory settings for the Agent.
- Without setting this environment variable the Java options default to '-Xms100m'.
JS7_AGENT_JOB_JAVA_OPTIONS
- sets Java options for each job that is started by the Agent.
JS7_AGENT_HOME
- points to the directory where the JobScheduler Agent has been installed.
- Without setting this environment variable the default value is the parent directory of the start script.
- Should you want to start the Agent from a directory different to the Agent installation directory, e.g. by copying the start script to some other location, then this environment variable has to be set in order to locate the JobScheduler Agent installation directory.
JS7_AGENT_DATA
- points to the directory where the Agent finds its data directory.
- Without setting this environment variable the default value is JS7_HOME/var_<JS7_HTTP_PORT>.
JS7_AGENT_HTTP_PORT
- sets the HTTP port that the Agent is listening to.
- indicates which network interfaces the Agent should listen to if a hostname or IP address is specified.
- if only a port number is specified then the Agent listens to all available network interfaces via HTTP.
- Without setting this environment variable the port defaults to 4445.
JS7_AGENT_HTTPS_PORT
- sets the HTTPS port that the Agent is listening to.
- indicates which network interfaces the Agent should listen to if a hostname or IP address is specified.
- if only a port number is specified then the Agent listens to all available network interfaces via HTTPS.
- Without setting this environment variable the HTTPS protocol is not used.
JS7_AGENT_USER
- sets the user account that the Agent is operated for. This includes running jobs with the permissions of the specified user.
- This setting is available for Unix systems only. For Windows systems the user account that runs the start script is used.
- Without setting this environment variable the user account that runs the start script is used.
- This setting can be used when running the Agent start script in system start-up and shutdown configurations that are executed by root, e.g. in /etc/init.d or corresponding locations.
JS7_AGENT_LOG_DIR
- sets the directory where the Agent log file is created.
- This setting defaults to the directory logs in the JS7_AGENT_DATA directory.
JS7_AGENT_WORK_DIR
- sets the working directory for the jobs started by the Agent, e.g. ${HOME} or %USERPROFILE%.
- This setting defaults to JS7_AGENT_HOME.
JS7_AGENT_KILL_SCRIPT
- sets the location of a "kill script" if required.
- The kill script provides the functionality to kill a task and any child processes.
- Kill scripts are provided by
  - ./bin/jobscheduler_agent_kill_task.sh for Unix.
  - .\bin\jobscheduler_agent_kill_task.cmd for Windows.
JS7_AGENT_PID_FILE_DIR
- sets the directory where the Agent PID file is created.
- This setting defaults to the directory that is specified with the JS7_AGENT_LOG_DIR environment variable or the log directory default value.

Usage Examples

Running the Agent on Windows

For Windows® operating systems the location of the Java Runtime Environment and of the log directory can be specified e.g. like this:

Code Block

language	bash

set JAVA_HOME=%ProgramFiles%\Java\jre8
set JS7_AGENT_LOG_DIR=%ProgramData%\sos-berlin.com\js7\agent\agent_2.0\logs 
"%ProgramFiles%\sos-berlin.com\agent\js7\agent_2.0\bin\agent.cmd" start

Running the Agent on Mac OS X

For Mac® OS X the location of the Java Runtime Environment can be specified like this:

Code Block

language	bash

JAVA_HOME=/Library/Internet\ Plug-Ins/JavaAppletPlugin.plugin/Contents/Home
export JAVA_HOME
/Users/ap/Documents/js7/agent/bin/agent.sh start

Automated Start-up and Shutdown of an Agent

For Unix systems the start-up and shutdown configurations apply that are executed by root, e.g. in /etc/init.d or corresponding locations.
- Consider use of the JS7_USER environment variable to run an Agent that is started by root for a different user account.
For Windows systems the start-up of the Agent by installing it as a Windows Service is recommended.

Debugging

The Agent log level can be increased using the Agent's Apache ProcRun Demon Service Manager demon/service.
On Windows systems this is installed in the Agent service folder and will have a name such as sos_agent_4445w.exe where 4445 is the port the Agent listens to.
Start the ProcRun Manager, select the Logging tab in the Manager interface and set the level to Debug.
The location of log files is explained above.
Do not forget to set the debug level back to Info once finished.

...

Multiple instances of the JS7 Agent on the same computer can be operated, e.g. for different user accounts that jobs should be executed for.
Consider detailed instructions with the JobScheduler Universal Agent - Running multiple instances article.

Show If

group	sos-members

Any number of Agent instances can be started from the same installation, however, different ports have to be used that the Agent is listening to for requests of a JS7 Controller.
Running the Agent for different user accounts and ports
- Use the environment variable JS7_USER to operate the Agent for a user account that is different from the one that starts the Agent.
- Use the environment variable JS7_HTTP_PORT or the option -http-port=#### to start the Agent for a port that is different from the default setting.
- Make sure that the directories JS7_LOG_DIR and JS7_PID_FILE_DIR are readable and writable for the different user accounts
Add the startup options as given in the following examples to your individual startup script.

Examples for Windows

Code Block

language	bash
title	Set port by commands and options

set JAVA_HOME=%ProgramFiles%\Java\jre8
 
"%ProgramFiles%\sos-berlin.com\js7\agent\agent_2.0\bin\agent.cmd" start -http-port=4447

Code Block

language	bash
title	Set log directory and port by environment variables

set JAVA_HOME=%ProgramFiles%\Java\jre8
set JS7_LOG_DIR=%ProgramData%\sos-berlin.com\agent\jobscheduler_agent_1.10\logs
set JS7_HTTP_PORT=4445
 
"%ProgramFiles%\sos-berlin.com\js7\agent\agent_2.0\bin\agent.cmd" start

Examples for Unix

Code Block

language	bash
title	Switch user account and port by commands and options

su - js
agent.sh start -http-port=4446

Code Block

language	bash
title	Switch user account and port by environment variables

SCHEDULER_USER=js
SCHEDULER_HTTP_PORT=4446
export SCHEDULER_USER SCHEDULER_HTTP_PORT

jobscheduler_agent.sh start

Testing Agent Operability

Status

colour	Yellow
title	TODO

...

Behavior in the event of the Agent crashing

It is important that all the tasks running on an Agent are killed if the Agent should crash or otherwise terminate abnormally while executing tasks. To this end, every task that is being executed by an Agent is noted by a agent_watchdog.sh agent watchdog process in a kill_tasks_after_crash.sh script. This script is located in the Agent's tmp folder and tasks are dynamically added to and deleted from the script as they are started and completed. This script is dynamically created when a first task is started by the Agent and is deleted when no tasks are running.

...

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 1

New Version Current

Key

Installing the JS7 Agent

Prerequisites

Preparation

Installation

Updating an Agent

Running the Agent

Usage

Command Line Options

Starting the Agent

Stopping the Agent

Restarting the Agent

Checking the Agent Status

Monitoring Agents

Controller/Agent Compatibility

Working Directory for Jobs

Windows Service Interface: Usage

Installing the Windows Service

Starting the Windows Service

Removing the Windows Service

Configuring the Windows Service

Introduction

Prerequisites

Download

Installation Video

Installation from the .tar.gz/.zip Archive

Installation

Update and Upgrade

Preparation

Running the Update

Example for Installation from the Unix Command Line

Installation using the Windows Installer in Headless Mode

Installation

Installer Response File

Running the Installer

Directory Structure

Installation Log

Update

Preparation

Running the Update

Rollback

Rolling back an Installation from .tar.gz/.zip Archive

Rolling back an Installation by the Windows Installer in Headless Mode

Anchorautomated_startup_shutdownautomated_startup_shutdownAutomated Start-up and Shutdown

Initial Operation

Further References

Usage Examples

Running the Agent on Windows

Running the Agent on Mac OS X

Automated Start-up and Shutdown of an Agent

Debugging

Examples for Windows

Examples for Unix

Testing Agent Operability

Behavior in the event of the Agent crashing

Anchor
automated_startup_shutdown
automated_startup_shutdown
Automated Start-up and Shutdown