Environment
This article describes the use of the JobScheduler Universal Agent Batch Installer for installing extra JobScheduler Agents in an environment in which a number of Jobscheduler Agents have already been installed:
- A JobScheduler Master is up and running.
- JobScheduler Agents have been already installed on an Agent server.
- An extra installation of an Agent will be carried out.
- The new Agent will be operated with same user and installation path.
- The listening port for the new Agent will be obviously a different one than the installed Agents.
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 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
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
- 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
- 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. Extract these files to the thelive
folder of the JobScheduler Master:SCHEDULER_DATA/config/live
. - a
config/batch_installer
folder with the configuration files for the Batch Installer. Extract these files 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 contains the following
- the
config/live/batch_installer_agent
folder with the jobs and job chains. Extract these files to thelive
folder of the JobScheduler MasterSCHEDULER_DATA/config/live
. - the
config/batch_installer
folder with the configuration files for the Batch Installer. Extract these files to the JobScheduler configuration directorySCHEDULER_DATA/config
. - Copy the JobScheduler Universal Agent installation file to the folder
SCHEDULER_DATA/config/
batch_installer
.
- the
Configuration
XML files
Configuring XML files with a text editor is error-prone and we recommend that you download the XML Editor and use it 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 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. - Open your
yade_agent_batch_installer_settings.xml
YADE configurationconfig/batch_installer
folder and assign the XSD schema - Open your
batch_installer_config_file.xml
configuration file in the XML Editor and assign thescheduler_universal_agent_installations.xsd
schema: both files are located in theconfig/batch_installer
folder. See the Batch Installer Configuration File chapter below for instructions on how to configure the Batch Installer configuration file.
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.tar.gz
- Start script for an Agent instance:
jobscheduler_agent_<port>.sh
- Installation script:
jobscheduler_universal_agent_install.sh
- JobScheduler Universal Agent installation files:
- For more information about YADE, see the YADE product site.
JobScheduler Jobs
Carry out the following once the job and job chain have been extracted to the live
folder of your JobScheduler Master:
AgentBatchInstaller
job: adjust the parameter values for theAgentBatchInstaller
job in your JobScheduler Master.Set the
installation_definition_file
job parameter to point to the Batch Installer configuration file.
Installation of the Agents
The Agents can be installed after the XML configuration files and JobScheduler 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 JobScheduler orders as explained in the chapter Batch Installer Application.
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 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 parameter
installation_definition_file
has to be set. This parameter defines the path to the XML file that contains all parameters for the batch installation.The parameter
update
has to be set tofalse
. This parameter defines the following:If true then an order for all
<instances>
will be created.If false then an order for
<instances>
that do not have thelast_run
attribute will be created
- Create the YADE settings file (see section below YADE profiles for the file transfer)
Example: Installation of one extra JobScheduler Universal Agent
The following example describes how to do the installation and configuration of one JobScheduler Universal Agents in one of the Agent Servers, where more JobScheduler Universal Agents had already been installed. The extra instance is added to the configuration described in the Use Case above: Batch Installer Use Case: Multiple Instances
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:
HINTS:
- Note that the value that defines this case is the one from
<lastRun>
in the last<installation>
. For this to work:- The parameter
update
in the JobAgentBatchInstaller
has to be set tofalse
. - The value
<lastRun>
has to be empty for the extra installation.
- The parameter
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):