Environment
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 based on the same 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 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 optionally up and running.
Batch Installer Application
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 corresponding Agent installations.
The Batch Installer application has two main components - a JobScheduler AgentBatchInstaller
job and a JobScheduler universal_agent_installer
job chain. Moreover, 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 the respective 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 to 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 the 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 the following files to be transfered:
- the JobScheduler Universal Agent installation files:
jobscheduler_unix_universal_agent.tar.gz
thejobscheduler_agent_<port>.sh
start script for the instance - the installation script:
jobscheduler_universal_agent_install.sh
- the JobScheduler Universal Agent installation files:
- Before the transfer starts, the preprocessor will use the use the
PerformInstall
: The installation is started by SSH.- The installation script will install and start the JobScheduler Universal Agent
- Finally the
PerformInstall
job post-processing commands will 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(example 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
- These commands are specified using the
Download
The following steps have to be carried out. Files can be downloaded from http://www.sos-berlin.com/jobscheduler-downloads
- Unix
- Download the "JobScheduler Universal Agent" tarball for Unix.
- Download the "JobScheduler Universal Agent Batch Installer" for Unix. The archive contains the following:
- a
config/live/batch_installer_agent
folder, with the jobs and job chains that are to be extracted to thelive
folder of the JobScheduler Master:SCHEDULER_DATA/config/live
. - a
config/batch_installer
folder containing configuration files for the Batch Installer. These files should be extracted to theconfig
directory of the JobScheduler Master:SCHEDULER_DATA
/config
. - Copy the JobScheduler Universal Agent installation file to the
SCHEDULER_DATA/config/
batch_installer
folder.
- a
- Windows
- Download the "JobScheduler Universal Agent" for Windows.
- Download the "JobScheduler Universal Agent Batch Installer" for Windows. The archive provides the following content:
- the
config/live/batch_installer_agent
folder contains jobs and job chains that should be extracted to thelive
folder of the JobScheduler MasterSCHEDULER_DATA/config/live
. - the
config/batch_installer
folder contains configuration files for the Batch Installer that should be extracted to the JobScheduler configuration directorySCHEDULER_DATA/config
. - Copy the JobScheduler Universal Agent installation file to the folder
SCHEDULER_DATA/config/
batch_installer
.
- the
Installation and Configuration Steps
For both scenarios above, the same steps will be carried out:
- Download the JobScheduler Universal Agent Batch Installer zip File
Unzip the JobScheduler Universal Agent Batch Installer zip file.
- Download the JobScheduler Universal Agent installation file.
- Copy the content of the
live
folder to thelive
folder of your JobScheduler Master instance - Copy the content of the folder
batch_install
to any folder (where the JobScheduler Master has permissions to access) - Copy the JobScheduler Universal Agent installation file to the same folder mentioned in step 5) and rename the JobScheduler Universal Agent installation file to
jobscheduler_unix_universal_agent.tar.gz
- Create the installer configuration file (see paragraph below Installer Configuration File)
- Job
AgentBatchInstaller:
Adjust the parameter values for the JobAgentBatchInstaller
in your JobScheduler MasterThe only parameter to adjust in that case is
installation_definition_file
, where it is set the path to the XML file that contains all parameters for the batch installation.The rest of the parameters should be let as defined per default.
- Create the YADE settings file (see section below YADE profiles for the file transfer)
Example: 4 Agents and 2 Servers
The following example describes how to do the installation of four JobScheduler Universal Agents in two Agent Servers, that is, two JobScheduler Universal Agents installed per Server.
Installer Configuration File
The installer configuration file contains an <installation>
element for each JobScheduler Universal Agent instance. Set the name for the YADE settings file in the installer configuration file with the element <globals><transfer><settings>.
An example for the installer configuration file can look like this:
YADE profiles for the file transfer
Each installation makes use of a profile in the YADE settings file. The default profile name is <host>:<port>
where
<host>
will be substituted with the value from the element<installation><agent_option><scheduler_ip_address>
<port>
will be substituted with the value from the element<installation><agent_option><scheduler_http_port>
Please follow these steps:
- Specify the name of the YADE settings file with the
<globals><settings>
element. - Open the YADE settings file or create a new one.
- Assign the XSD Schema http://www.sos-berlin.com/schema/yade/YADE_configuration_v1.0.xsd
- Add a
<ProtocolFragments>
element and nodes for each host that you want to install the JobScheduler Universal Agent for. - Add a
<Profile>
element and nodes for each host you want install the JobScheduler Universal Agent for. - The default
profile_id
is<host>:<port>
. If you do not use the default then you have to specify the profile name in the installer configuration file.
HINTS:
- Note that this is a XML file and YADE will expect an INI file to do the transfer, as we indicated in the installer configuration file (in the section
<globals><install_path><transfer><settings>
).- It is recommended to use the XML Editor for converting from XML to INI format (see below paragraph Using the XML Editor)
- Here is an example of an INI file, converted from the XML file attached above:
Using the XML Editor
Then XML Editor can be used to manage the installation configuration file and the YADE profiles for the transfer of the installation files as well.
Find more details from our XML Editor section.
- After download of the XML Editor, extract the zip file, then start "sos.xml.editor.exe"
- Open your installer configuration file and assign the XSD schema
scheduler_universal_agent_installations.xsd
Please see the following examples (one example for each file):