Page History

Table of Contents

...

Introduction

This article describes the use of is one of a series describing how to configure the JobScheduler Universal Agent Batch Installer for installing multiple Agent instances in a heterogeneous environment. A multiple so that a number of JobScheduler Universal Agents will can be installed on every Agent server and every installation will be based on different prerequisites:

A JobScheduler Master is up and running.
The Agent installations are to be performed on any number of servers that do not have to have the same operating system. More than one Agent is to be installed per server.
In every Agent server, the Agents will be operated with different users and different listening ports.
- The Agents will be operated with different users (within the same Agent server) to make the example more multifaceted, although the same user can operate more than one Agent if the Agents run on different ports.
The installation path will be the same for all Agent installations.

The Batch Installer supports:

First Installation: an Agent has not yet been installed on the server.
Update Installation: an Agent has already been installed and may be up and running.

...

Configuration

...

readily installed on a number of servers.

Article Scope

This article describes how to use the Universal Agent Batch Installer to install multiple Agent instances. Other use cases in this series of articles are listed in the introductory JobScheduler Universal Agent - Batch Installation and Update of Agents article.

A general introduction to installation of the JobScheduler Universal Agent can be found in the JobScheduler Universal Agent - Installation & Operation article.

The JobScheduler Universal Agent - Batch Installation and Update of Agents article provides an overview of how the Batch Installer works. New users are strongly recommended to read this article before proceeding with the instructions presented here.

The Batch Installation - Reference Documentation article provides a detailed guide to configuration of the batch installer with, for example, full lists of parameters.

Installation Environment

This article describes the use of the JobScheduler Universal Agent Batch Installer for installing multiple Agent instances in a heterogeneous environment. A number of JobScheduler Agents will be installed on every Agent server and every installation will be based on different prerequisites:

A JobScheduler Master is up and running.
The Agent installations are to be performed on any number of servers that do not have to have the same operating system. More than one Agent is to be installed per server.
In every Agent server, the Agents will be operated with different users and different listening ports.
- The Agents will be operated with different users (within the same Agent server) to make the example more multifaceted, although the same user can operate more than one Agent if the Agents run on different ports.
The installation path will be the same for all Agent installations

Installation Procedure

General requirements:

A JobScheduler Master is up and running.
A Java Run-time Environment in version 1.8 or newer is installed on the system(s) the Agent is to be installed on.
We recommend that you use the SOS XML Editor to manage the configuration files required for the Batch Installer. More information about the installation and use of the XML editor will be provided later in this article.

1. Download and Extract the Batch Installer and Agent Files

The following steps have to be carried out. Files can be downloaded from http://www.sos-berlin.com/jobscheduler-downloads

1.1 Unix

- Download the "JobScheduler Universal Agent" tarball for Unix.
- Download the "Universal Agent Batch Installer". The archive contains the following folders and sub-folders:
  - live/batch_install_universal_agent
    - This folder contains the Jobs and Job Chain used to carry out the installation.
    - Extract these files to the the live folder of the JobScheduler Master: SCHEDULER_DATA/config/live.
  - batch_install
    - This folder contains the configuration files for the Batch Installer.
    - Extract these files to the config directory of the JobScheduler Master: SCHEDULER_DATA/config.
- Copy the JobScheduler Universal Agent installation file to the SCHEDULER_DATA/config/batch_install folder.

1.2 Windows
- Download the "JobScheduler Universal Agent" for Windows.
- Download the "Universal Agent Batch Installer". The archive contains the following folders and sub-folders
  - the live/batch_install_universal_agent folder
    - This folder contains the Jobs and Job Chain used to carry out the installation.
    - Extract these files to the live folder of the JobScheduler Master SCHEDULER_DATA/config/live.
  - the batch_install folder
    - This folder contains the configuration files for the Batch Installer.
    - Extract these files to the JobScheduler configuration directory SCHEDULER_DATA/config.
- Copy the JobScheduler Universal Agent installation file to the folder SCHEDULER_DATA/config/batch_install folder.

2. Configure the Transfer of the Universal Agent Installation Files and the Installation of the Agents

2.1 Edit the XML Configuration files

Configuring complex XML files with a text editor is often a tedious and error-prone procedure. To get around this, we recommend that you use our XML Editor to manage the configuration files required for the Batch Installer. The XML Editor automatically validates configuration files and therefore reduces the possibility of configuration errors. See the Using the XML Editor chapter below for more detailed information about using the XML Editor.

After downloading the XML Editor, extract the contents of the zip file to a convenient folder (an installation routine is not required) and start the the sos.xml.editor.exe program program.
Use the XML Editor to configure transfer of the Universal Agent installation files:
Open your
- Open your
- yade_agent_batch_installer_settings.xml
YADE
- YADE configuration
- file, which is located in
the the config/batch_installer folder folder and assign the XSD schema following schema in the XML Editor:http://www.sos-berlin.com/schema/yade/YADE_configuration_v1.0.xsd. See See the YADE profiles for the file transfer chapter below for instructions on how to configure the YADE configuration file.
Use the XML Editor to configure the installation of the Universal Agents: Open your batch_installer_config_file.xml configuration file in the XML Editor and assign the scheduler_universal_agent_installations.xsd schema: both files are located in the config/batch_installer folder. See See the Batch Installer Configuration File chapter below for instructions on how to configure the Batch Installer configuration file.

Info

title	Hints

The XML Editor is available for Windows.
YADE is an Open Source file transfer solution for FTP, SFTP, FTPS, WebDAV and other protocols. Concretely, it will be used here for transferring the following files from the JobScheduler Master to the Agent servers:
- JobScheduler Universal Agent installation files: jobscheduler_unix_universal_agent.1.11.0-SNAPSHOT.<version>.tar.gz
- Start script for an Agent instance: jobscheduler_agent_<port>.sh
- Installation script: jobscheduler_universal_agent_install.sh
For more information about YADE, see the YADE product site.

`2.2 Configure the JobScheduler Jobs`

Carry out the following once the job and job chain Once the Job and Job Chain have been extracted to the the live folder folder of your JobScheduler Master carry out the following:

AgentBatchInstaller Job: Set AgentBatchInstaller job: adjust the parameter values for the AgentBatchInstaller job in your JobScheduler Master. Set the installation_definition_file job parameter to the path that points to the Batch Installer configuration file.

`3 Installation of the Agents`

The Agents can be installed after the XML configuration files and JobScheduler jobs Jobs have been configured. Start a task for the AgentBatchInstaller AgentBatchInstaller job as follows:

Open a JobScheduler Operating Center (JOC) browser window for the JobScheduler master.
Go on the "Jobs" Window and open the "batch_installer_universal_agent" folder.
Right click on the job to open the context menu.
Select the Start task immediately operation operation.
This job will create the appropriate Orders for the JobScheduler

 orders  as explained in the description of the 
 chapter  Batch Installer Application.

`Example: Installation of four Agents on two Servers`

The following example describes how to install four JobScheduler Universal Agents on two Servers - that is, two JobScheduler Universal Agents will be installed per server. First of all, the YADE configuration file for the file transfer will be configured (in XML format), it will then be converted to the YADE settings file format (.ini) and finally the Batch Installer configuration file will be specified.

Anchor
yade_profile_transfer
yade_profile_transfer
`YADE Configuration File for File Transfer`

We assume that you have opened the yade_agent_batch_installer_settings.xml YADE configuration file and have assigned the http://www.sos-berlin.com/schema/yade/YADE_configuration_v1.0.xsd XSD schema. The XML file contains a basic example with recommended values for the installation of a single Agent.

...

Code Block

language	xml
title	YADE Configuration File
collapse	true

<?xml version="1.0" encoding="utf-8"?>
<Configurations xsi:noNamespaceSchemaLocation="http://www.sos-berlin.com/schema/yade/YADE_configuration_v1.0.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Fragments>
    <ProtocolFragments>
      <SFTPFragment name="SFTP_192.11.0.111:4445">
        <BasicConnection>
          <Hostname><![CDATA[192.11.0.111]]></Hostname>
        </BasicConnection>
        <SSHAuthentication>
          <Account><![CDATA[test]]></Account>
          <AuthenticationMethodPassword>
            <Password><![CDATA[xxxx]]></Password>
          </AuthenticationMethodPassword>
        </SSHAuthentication>
      </SFTPFragment>
      <SFTPFragment name="SFTP_192.11.0.111:4446">
        <BasicConnection>
          <Hostname><![CDATA[192.11.0.111]]></Hostname>
        </BasicConnection>
        <SSHAuthentication>
          <Account><![CDATA[sos]]></Account>
          <AuthenticationMethodPassword>
            <Password><![CDATA[xxxx]]></Password>
          </AuthenticationMethodPassword>
        </SSHAuthentication>
      </SFTPFragment>
      <SFTPFragment name="SFTP_192.11.0.95:4445">
        <BasicConnection>
          <Hostname><![CDATA[192.11.0.95]]></Hostname>
        </BasicConnection>
        <SSHAuthentication>
          <Account><![CDATA[sos]]></Account>
          <AuthenticationMethodPassword>
            <Password><![CDATA[xxxx]]></Password>
          </AuthenticationMethodPassword>
        </SSHAuthentication>
      </SFTPFragment>
      <SFTPFragment name="SFTP_192.11.0.95:4446">
        <BasicConnection>
          <Hostname><![CDATA[192.11.0.95]]></Hostname>
        </BasicConnection>
        <SSHAuthentication>
          <Account><![CDATA[test]]></Account>
          <AuthenticationMethodPassword>
            <Password><![CDATA[xxxx]]></Password>
          </AuthenticationMethodPassword>
        </SSHAuthentication>
      </SFTPFragment>
    </ProtocolFragments>
  </Fragments>
  <Profiles>
    <Profile profile_id="192.11.0.111:4445">
      <Operation>
        <Copy>
          <CopySource>
            <CopySourceFragmentRef>
              <LocalSource />
            </CopySourceFragmentRef>
            <SourceFileOptions>
              <Selection>
                <FileSpecSelection>
                  <FileSpec><![CDATA[.*\.(sh|gz)$]]></FileSpec>
                  <Directory><![CDATA[C:\Program Files (x86)\sos-berlin.com\jobscheduler\vg_4444\scheduler_data\config\batch_installer]]></Directory>
                </FileSpecSelection>
              </Selection>
            </SourceFileOptions>
          </CopySource>
          <CopyTarget>
            <CopyTargetFragmentRef>
              <SFTPFragmentRef ref="SFTP_192.11.0.111:4445" />
            </CopyTargetFragmentRef>
            <Directory><![CDATA[/home/test/tmp/]]></Directory>
          </CopyTarget>
        </Copy>
      </Operation>
    </Profile>
    <Profile profile_id="192.11.0.111:4446">
      <Operation>
        <Copy>
          <CopySource>
            <CopySourceFragmentRef>
              <LocalSource />
            </CopySourceFragmentRef>
            <SourceFileOptions>
              <Selection>
                <FileSpecSelection>
                  <FileSpec><![CDATA[.*\.(sh|gz)$]]></FileSpec>
                  <Directory><![CDATA[C:\Program Files (x86)\sos-berlin.com\jobscheduler\vg_4444\scheduler_data\config\batch_installer]]></Directory>
                </FileSpecSelection>
              </Selection>
            </SourceFileOptions>
          </CopySource>
          <CopyTarget>
            <CopyTargetFragmentRef>
              <SFTPFragmentRef ref="SFTP_192.11.0.111:4446" />
            </CopyTargetFragmentRef>
            <Directory><![CDATA[/home/sos/tmp/]]></Directory>
          </CopyTarget>
        </Copy>
      </Operation>
    </Profile>
    <Profile profile_id="192.11.0.95:4445">
      <Operation>
        <Copy>
          <CopySource>
            <CopySourceFragmentRef>
              <LocalSource />
            </CopySourceFragmentRef>
            <SourceFileOptions>
              <Selection>
                <FileSpecSelection>
                  <FileSpec><![CDATA[.*\.(sh|gz)$]]></FileSpec>
                  <Directory><![CDATA[C:\Program Files (x86)\sos-berlin.com\jobscheduler\vg_4444\scheduler_data\config\batch_installer]]></Directory>
                </FileSpecSelection>
              </Selection>
            </SourceFileOptions>
          </CopySource>
          <CopyTarget>
            <CopyTargetFragmentRef>
              <SFTPFragmentRef ref="SFTP_192.11.0.95:4445" />
            </CopyTargetFragmentRef>
            <Directory><![CDATA[/home/sos/tmp/]]></Directory>
          </CopyTarget>
        </Copy>
      </Operation>
    </Profile>
    <Profile profile_id="192.11.0.95:4446">
      <Operation>
        <Copy>
          <CopySource>
            <CopySourceFragmentRef>
              <LocalSource />
            </CopySourceFragmentRef>
            <SourceFileOptions>
              <Selection>
                <FileSpecSelection>
                  <FileSpec><![CDATA[.*\.(sh|gz)$]]></FileSpec>
                  <Directory><![CDATA[C:\Program Files (x86)\sos-berlin.com\jobscheduler\vg_4444\scheduler_data\config\batch_installer]]></Directory>
                </FileSpecSelection>
              </Selection>
            </SourceFileOptions>
          </CopySource>
          <CopyTarget>
            <CopyTargetFragmentRef>
              <SFTPFragmentRef ref="SFTP_192.11.0.95:4446" />
            </CopyTargetFragmentRef>
            <Directory><![CDATA[/home/test/tmp/]]></Directory>
          </CopyTarget>
        </Copy>
      </Operation>
    </Profile>
  </Profiles>
</Configurations>

Anchor
yade_settings_file
yade_settings_file
`YADE Settings File for File Transfer`

Note that the file shown above is an in the YADE XML file format and that YADE versions less that 1.10 and older require a .ini file to perform the transfer that is specified in the <globals><install_path><transfer><settings> element in the Batch Installer configuration file.

We recommended that you use the XML Editor to convert configuration files from XML to the .ini format (see the XML Editor for converting YADE configuration files (XML) into YADE setting files (.ini) section below for more information).
The following example shows as an example a .ini file that has been converted from the XML file above. You can download the example using this link: yade_agent_batch_installer_settings.ini.

Code Block

title	.ini file
collapse	true

[protocol_fragment_sftp@SFTP_192.11.0.111:4445]
protocol                            = sftp
host                                = 192.11.0.111
user                                = test
ssh_auth_method                     = password
password                            = xxxx
[protocol_fragment_sftp@SFTP_192.11.0.111:4446]
protocol                            = sftp
host                                = 192.11.0.111
user                                = sos
ssh_auth_method                     = password
password                            = xxxx
[protocol_fragment_sftp@SFTP_192.11.0.95:4445]
protocol                            = sftp
host                                = 192.11.0.95
user                                = sos
ssh_auth_method                     = password
password                            = xxxx
[protocol_fragment_sftp@SFTP_192.11.0.95:4446]
protocol                            = sftp
host                                = 192.11.0.95
user                                = test
ssh_auth_method                     = password
password                            = xxxx
[192.11.0.111:4445]
operation                           = copy
source_protocol                     = local
file_spec                           = .*\.(sh|gz)$
source_dir                          = C:\Program Files (x86)\sos-berlin.com\jobscheduler\vg_4444\scheduler_data\config\batch_installer
target_include                      = protocol_fragment_sftp@SFTP_192.11.0.111:4445
target_dir                          = /home/test/tmp/
[192.11.0.111:4446]
operation                           = copy
source_protocol                     = local
file_spec                           = .*\.(sh|gz)$
source_dir                          = C:\Program Files (x86)\sos-berlin.com\jobscheduler\vg_4444\scheduler_data\config\batch_installer
target_include                      = protocol_fragment_sftp@SFTP_192.11.0.111:4446
target_dir                          = /home/sos/tmp/
[192.11.0.95:4445]
operation                           = copy
source_protocol                     = local
file_spec                           = .*\.(sh|gz)$
source_dir                          = C:\Program Files (x86)\sos-berlin.com\jobscheduler\vg_4444\scheduler_data\config\batch_installer
target_include                      = protocol_fragment_sftp@SFTP_192.11.0.95:4445
target_dir                          = /home/sos/tmp/
[192.11.0.95:4446]
operation                           = copy
source_protocol                     = local
file_spec                           = .*\.(sh|gz)$
source_dir                          = C:\Program Files (x86)\sos-berlin.com\jobscheduler\vg_4444\scheduler_data\config\batch_installer
target_include                      = protocol_fragment_sftp@SFTP_192.11.0.95:4446
target_dir                          = /home/test/tmp/

Anchor
installer_config_file
installer_config_file
`Batch Installer Configuration File`

We assume that you have opened the Batch Installer configuration file batch_installer_config_file.xml in the XML Editor and assigned the scheduler_universal_agent_installations.xsd XSD schema.

...

Code Block

language	xml
title	Installer Configuration File
collapse	true

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<installations lastRun="2015-11-23 12:11">
    <globals>
        <install_path>/opt</install_path>
        <transfer>
            <settings>C:\Program Files (x86)\sos-berlin.com\jobscheduler\vg_4444\scheduler_data\config\batch_installer\yade_agent_batch_installer_settings.ini</settings>
        </transfer>
        <ssh>
            <auth_method>password</auth_method>
            <port>22</port>
        </ssh>
		<installation_file><jobschedulerfile>jobscheduler_unix_universal_agent.1.10.2.tar.gz><gz</installation_file>
    </globals>
    <installation lastRun="2015-11-23 11:11">
        <agent_options>
            <scheduler_user>test</scheduler_user>
            <scheduler_log_dir>/var/log/sos-berlin.com/jobscheduler/agent</scheduler_log_dir>
        </agent_options>
        <ssh>
            <user>test</user>
            <password>xxxx</password>
            <sudo_password>xxxx</sudo_password>
            <host>192.11.0.111</host>
        </ssh>
        <postprocessing>
            <command>echo ${ssh.sudo_password} | sudo -S cp ${install_path}/jobscheduler_agent/bin/jobscheduler_agent_${agent_options.scheduler_http_port}.sh /etc/init.d/jobscheduler_agent_${agent_options.scheduler_http_port}</command>
            <command>echo ${ssh.sudo_password} | sudo -S updadte-rc.d jobscheduler_agent_${agent_options.scheduler_http_port}</command>
        </postprocessing>
    </installation>
    <installation lastRun="2015-11-23 11:11">
        <agent_options>
            <scheduler_http_port>4446</scheduler_http_port>
            <scheduler_user>sos</scheduler_user>
            <scheduler_log_dir>/var/log/sos-berlin.com/jobscheduler/agent</scheduler_log_dir>
        </agent_options>
        <ssh>
            <user>sos</user>
            <password>xxxx</password>
            <sudo_password>xxxx</sudo_password>
            <host>192.11.0.111</host>
        </ssh>
        <postprocessing>
            <command>echo ${ssh.sudo_password} | sudo -S cp ${install_path}/jobscheduler_agent/bin/jobscheduler_agent_${agent_options.scheduler_http_port}.sh /etc/init.d/jobscheduler_agent_${agent_options.scheduler_http_port}</command>
            <command>echo ${ssh.sudo_password} | sudo -S update-rc.d jobscheduler_agent_${agent_options.scheduler_http_port}</command>
        </postprocessing>
    </installation>
    <installation lastRun="2015-11-23 11:11">
        <agent_options>
            <scheduler_user>sos</scheduler_user>
            <scheduler_log_dir>/var/log/sos-berlin.com/jobscheduler/agent</scheduler_log_dir>
        </agent_options>
        <ssh>
            <user>sos</user>
            <password>xxxx</password>
            <sudo_password>xxxx</sudo_password>
            <host>192.11.0.95</host>
        </ssh>
        <postprocessing>
            <command>echo ${ssh.sudo_password} | sudo -S cp ${install_path}/jobscheduler_agent/bin/jobscheduler_agent_${agent_options.scheduler_http_port}.sh /etc/init.d/jobscheduler_agent_${agent_options.scheduler_http_port}</command>
            <command>echo ${ssh.sudo_password} | sudo -S chkconfig jobscheduler_agent_${agent_options.scheduler_http_port}</command>
        </postprocessing>
    </installation>
    <installation lastRun="2015-11-23 11:11">
        <agent_options>
            <scheduler_http_port>4446</scheduler_http_port>
            <scheduler_user>test</scheduler_user>
            <scheduler_log_dir>/var/log/sos-berlin.com/jobscheduler/agent</scheduler_log_dir>
        </agent_options>
        <ssh>
            <user>test</user>
            <password>xxxx</password>
            <sudo_password>xxxx</sudo_password>
            <host>192.11.0.95</host>
        </ssh>
        <postprocessing>
            <command>echo ${ssh.sudo_password} | sudo -S cp ${install_path}/jobscheduler_agent/bin/jobscheduler_agent_${agent_options.scheduler_http_port}.sh /etc/init.d/jobscheduler_agent_${agent_options.scheduler_http_port}</command>
            <command>echo ${ssh.sudo_password} | sudo -S chkconfig jobscheduler_agent_${agent_options.scheduler_http_port}</command>
        </postprocessing>
    </installation>
</installations>

Info

title	Hints

Note that if the port was not specified with the <installations><installation><agent_options><scheduler_http_port> element, this would mean that the global value of 4445 would be applied to all Agent installations. In this example, this element is superfluous for the first and the third installation.
The commands defined under <command> (in the section <installations><installation><postprocessing><command>) are executed for each installation individually. In this example the Agents are installed on different UNIX distributions, the first two Agents would be installed on an Ubuntu distribution (and therefore commands such as update-rc.d are used) and the last two Agents would be installed on a CentOS distribution (and therefore commands such as chkconfig are used).

Excerpt Include

	Batch Installer Installation - Use Cases - Homogeneous environment
	Batch Installer Installation - Use Cases - Homogeneous environment
nopanel	true

Space shortcuts

Page tree

Versions Compared

Old Version 33

New Version Current

Key

Introduction

Configuration

Article Scope

Installation Environment

Installation Procedure

1. Download and Extract the Batch Installer and Agent Files

2. Configure the Transfer of the Universal Agent Installation Files and the Installation of the Agents

2.1 Edit the XML Configuration files

`2.2 Configure the JobScheduler Jobs`

`3 Installation of the Agents`

`Example: Installation of four Agents on two Servers`

Anchor
yade_profile_transfer
yade_profile_transfer
`YADE Configuration File for File Transfer`

Anchor
yade_settings_file
yade_settings_file
`YADE Settings File for File Transfer`

Anchor
installer_config_file
installer_config_file
`Batch Installer Configuration File`

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 33

New Version Current

Key

Introduction

Configuration

Article Scope

Installation Environment

Installation Procedure

1. Download and Extract the Batch Installer and Agent Files

2. Configure the Transfer of the Universal Agent Installation Files and the Installation of the Agents

2.1 Edit the XML Configuration files

2.2 Configure the JobScheduler Jobs

3 Installation of the Agents

Example: Installation of four Agents on two Servers

Anchoryade_profile_transferyade_profile_transferYADE Configuration File for File Transfer

Anchoryade_settings_fileyade_settings_fileYADE Settings File for File Transfer

Anchorinstaller_config_fileinstaller_config_fileBatch Installer Configuration File

`2.2 Configure the JobScheduler Jobs`

`3 Installation of the Agents`

`Example: Installation of four Agents on two Servers`

Anchor
yade_profile_transfer
yade_profile_transfer
`YADE Configuration File for File Transfer`

Anchor
yade_settings_file
yade_settings_file
`YADE Settings File for File Transfer`

Anchor
installer_config_file
installer_config_file
`Batch Installer Configuration File`