Page History

versions

Table of Contents

Table of Contents

Environment

Introduction

The JobScheduler Universal Agent Batch Installer is a set of files used together by a JobScheduler Master to install the Universal Agent on local and remote servers.

This article is one of a series describing how to configure This article describes the use of the JobScheduler Universal Agent Batch Installer in a homogeneous environment. We define a homogeneous environment as one in which a number of JobScheduler Agents will be installed according to the same prerequisites:

A JobScheduler Master is up and running.
The Agent installations are to be performed on any number of servers that have the same operating system. One Agent is to be installed per server.
The Agents will be operated with the same user, listening port and installation path.

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.

...

so that a number of Universal Agents can be readily installed on a number of servers.

Article Scope

This article describes how to use the Universal Agent Batch Installer to install Agents in a homogeneous environment. 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 in a homogeneous environment - that is an environment in which a number of JobScheduler Agents will be installed according to the same prerequisites:

Requirements for this use case:
- The Agent installations are to be performed on any number of servers that have the same operating system. One Agent is to be installed per server.
- The Agents will be operated with the same user, listening port and installation path.

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 JobScheduler Agents will be installed by a JobScheduler Master that:

connects to the Servers that the Agents are to be installed on and
executes the required Agent installations.

The Batch Installer application has two main components - a JobScheduler AgentBatchInstaller job and a JobScheduler universal_agent_installer job chain. In addition, two XML files batch_installer_config_file.xml and yade_agent_batch_installer_settings.xml are needed for the application.

The AgentBatchInstaller job is responsible for creating the JobScheduler orders for the job chain. Each of these orders is named according to the pattern <host>:<port> to convey the host and port of the server where each Agent is to be installed.

The universal_agent_installer job chain has four job nodes configured in series as follows:

...

The individual nodes in the universal_agent_installer job chain have the following functions:

CheckPreRequisite
- Check for the correct Java version.
- Check whether a JobScheduler Universal Agent has already been installed. If so:
  - - shut down the instance if it is running,
    - remove the installation.
Sync: To wait until all prerequisites have been checked and any already installed Agent instances that are running have been shut down.

TransferInstallationSetup: To transfer the installer files on the host
- Before the transfer starts, the preprocessor will use the use the jobscheduler_agent_instance_script.txt template to create a start script for each Agent instance.
- The XML file yade_agent_batch_installer_settings.xml has to be configured and converted to .ini file before the transfer starts. See the YADE configuration file for the file transfer chapter below for instructions on how to configure the YADE configuration file and YADE Settings File for the File Transfer for instructions on how the .ini file should look like.
- The files that will be transfered are specified with the element <globals><transfer><file_spec=".*\.(sh|gz)$">
- This regular expression is used to select the files to be transfered:
  - the JobScheduler Universal Agent installation files: jobscheduler_unix_universal_agent.tar.gz
    the jobscheduler_agent_<port>.sh start script for the instance
  - the installation script: jobscheduler_universal_agent_install.sh
PerformInstall: The installation is started by SSH.
- The installation script will install and start the JobScheduler Universal Agent
- The PerformInstall job post-processing commands will then be executed:
  - These commands are specified using the <installation><postprocessing><command> element.
  - The default configuration for a Linux server will place the Agent start script under /etc/init.d and set up the autostart for JobScheduler Universal Agent (the following example is for a Ubuntu distribution):
    - ```
    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}
```
- echo ${ssh.sudo_password} | sudo -S update-rc.d jobscheduler_agent_${agent_options.scheduler_http_port} defaults

...

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 "JobScheduler Universal Agent Batch Installer" for Unix. The The archive contains the following folders and sub-folders:
a `config/live/batch_installerinstall_universal_agent` folder, with the jobs and job chains.
This folder contains the Jobs and Job Chain used to carry out the installation.
Extract these files to the the `live`
folder
folder of the JobScheduler Master: `SCHEDULER_DATA/config/live`.
a config/
`batch_`installer`install`
This folder contains the configuration
folder containing configuration
files for the Batch Installer.
Extract these files to
the
the `config` directory of the JobScheduler Master: `SCHEDULER_DATA/config`.
Copy the JobScheduler Universal Agent installation file to the the `SCHEDULER_DATA/config/batch_`installer`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

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 sos.xml.editor.exe program.
Use the XML Editor to configure transfer of the Universal Agent installation files:
- Open your yade_agent_batch_installer_settings.xml YADE configurationfile, which is located in the config/batch_installer folder and assign the
XSD 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 live folder of your JobScheduler Master carry out the following:

AgentBatchInstallerjob Job: set Set 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 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.
This job will create the appropriate Orders for the JobScheduler

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

`Example Use Case: Installation of two Agents`

The following example describes the installation of two Agents on separate servers. 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 in the XML Editor and assigned the http://www.sos-berlin.com/schema/yade/YADE_configuration_v1.0.xsd XSD schema.

...

Code Block

language	xml
title	YADE ProfilesConfiguration 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.95:4445">
        <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.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/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 in the YADE XML format and that YADE versions 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.95:4445]
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.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/test/tmp/

Anchor
batch_installer_config_file
batch_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	Batch Installer Configuration File
collapse	true

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<installations lastRun="2015-11-20 14: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>
			<user>test</user>
            <password>xxxx</password>
            <sudo_password>xxxx</sudo_password>
            <auth_method>password</auth_method>
            <port>22</port>
        </ssh>
  	    <installation_file><![CDATA[jobschedulerfile>jobscheduler_unix_universal_agent.1.10.2-SNAPSHOT.tar.gz]]><gz</installation_file>
        <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} defaults</command>
        </postprocessing>
    </globals>
    <installation lastRun="2015-11-20 14:11">
        <agent_options>
            <scheduler_user>test</scheduler_user>
            <scheduler_log_dir>/var/log/sos-berlin.com/jobscheduler/agent</scheduler_log_dir>
        </agent_options>
        <ssh>
            <host>xxxx</host>
        </ssh>
    </installation>
    <installation lastRun="2015-11-20 14:11">
        <agent_options>
            <scheduler_user>test</scheduler_user>
            <scheduler_log_dir>/var/log/sos-berlin.com/jobscheduler/agent</scheduler_log_dir>
        </agent_options>
        <ssh>
            <host>xxxx</host>
        </ssh>
    </installation>
</installations>

Info

title	Hints

Note that if the port is not specified with the <installations><installation><agent_options><scheduler_http_port> element and means that the global default value of 4445 is will be applied to all Agent installations.
For a homogeneous environment parameters can be specified with the <global> element and applied to all Agent installations.

Excerpt

Anchor
xml_editor
xml_editor
Using the XML Editor

The XML Editor can be used to manage the Batch Installer configuration file and the YADE configuration file.

XML Editor for Batch Installer configuration file

An example Batch Installer configuration file for the installation of a single Agent is shown in the following screenshot:

XML Editor for YADE configuration file

An example YADE configuration file for the installation of a single Agent is shown in the next screenshot:

Anchor
yadexml2ini_converter
yadexml2ini_converter
XML Editor for converting YADE configuration files (XML) into YADE setting files (.ini)

The "YADE Xml2Ini Converter" function in the XML Editor is available for converting YADE files from XML to the .ini format required by versions of YADE before 1.11. Clicking on the button of the same name will open the following form:

Note that it is not necessary to create a Profile for the Batch Installer, as conversion will take place automatically once the "Autotransform" option has been chosen. Every time a change in the XML file is saved the XML file will be automatically converted and saved in .ini format.

A pop-up window will show every time a change is saved if the option "Show notification on autotransform" is chosen.

Space shortcuts

Page tree

Versions Compared

Old Version 85

New Version Current

Key

Environment

Introduction

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

Configuration

files

`2.2 Configure the JobScheduler Jobs`

`3 Installation of the Agents`

`Example Use Case: Installation of two Agents`

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
batch_installer_config_file
batch_installer_config_file
`Batch Installer Configuration File`

Anchor
xml_editor
xml_editor
Using the XML Editor

XML Editor for Batch Installer configuration file

XML Editor for YADE configuration file

Anchor
yadexml2ini_converter
yadexml2ini_converter
XML Editor for converting YADE configuration files (XML) into YADE setting files (.ini)

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 85

New Version Current

Key

Environment

Introduction

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

Configuration

files

2.2 Configure the JobScheduler Jobs

3 Installation of the Agents

Example Use Case: Installation of two Agents

Anchoryade_profile_transferyade_profile_transferYADE Configuration File for File Transfer

Anchoryade_settings_fileyade_settings_fileYADE Settings File for File Transfer

Anchorbatch_installer_config_filebatch_installer_config_fileBatch Installer Configuration File

Anchorxml_editorxml_editorUsing the XML Editor

XML Editor for Batch Installer configuration file

XML Editor for YADE configuration file

Anchoryadexml2ini_converteryadexml2ini_converterXML Editor for converting YADE configuration files (XML) into YADE setting files (.ini)

`2.2 Configure the JobScheduler Jobs`

`3 Installation of the Agents`

`Example Use Case: Installation of two Agents`

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
batch_installer_config_file
batch_installer_config_file
`Batch Installer Configuration File`

Anchor
xml_editor
xml_editor
Using the XML Editor

Anchor
yadexml2ini_converter
yadexml2ini_converter
XML Editor for converting YADE configuration files (XML) into YADE setting files (.ini)