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 different Agent servers.
- 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 on this server.
Prerequisites
In case you an extra Agent installation has to be done, that would mean that other Agents have been installed (either using the Batch Installer or through other methods). In any case, to understand properly how this application works in case you had not use the Batch Installer for Agents before, you can find the relevant information for your corresponding environment in the articles described below - have a look at the chapters "Batch Installer Application" and "Download":
- Batch Installer Use Case: Homogeneous 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 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.
- Batch Installer Use Case: Heterogeneous environments: This article describes the use of the JobScheduler Universal Agent Batch Installer in a heterogeneous environment. We define a heterogeneous environment as one in which a number of JobScheduler Agents will be installed according to 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. One Agent is to be installed per server.
- The Agents will be operated with different users, listening ports and installation paths.
- Batch Installer Use Case: Multiple Instances: This article describes the use of the JobScheduler Universal Agent Batch Installer for installing multiple Agent instances in a heterogeneous environment. A multiple 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.
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 the path to the Batch Installer configuration file.- Set the
update
job parameter tofalse
. This value set to false is the one that will determine that the rest of the installations defined in the configuration for Batch Installer Configuration File are not going to be performed.
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.
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 exactly four JobScheduler Universal Agents had already been installed - two Agents on two different servers. The extra instance is added to the configuration described in the Use Case above: Batch Installer Use Case: Multiple Instances.
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.
A separate profile in the YADE configuration file is required for each Agent installation. 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>
Now carry out the following steps:
- Add a
<ProtocolFragments>
element and nodes for each host that you want to install the Agent for. The best way to add another<ProtocolFragments>
element using the XML Editor is copying the element and pasting it to the parent element - in this case<Fragments>
. - Add a
<Profile>
element and nodes for each host that you want to install the Agent for. The best way to add another<Profile>
element using the XML Editor is copying the element and pasting it to the parent element - here<Profiles>
. - The default
profile_id
is<host>:<port>
. If you do not use the default then you have to specify the profile name in the Batch Installer configuration file.
An example for the Batch Installer configuration file for the installation of two Agents is attached to this page (download: yade_agent_batch_installer_settings.xml) and is shown in the following code block:
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.11 and newer 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
Batch Installer Configuration File
We assume that you have opened the Batch Installer configuration file batch_installer_config_file.xml
and assigned the scheduler_universal_agent_installations.xsd
XSD schema. The XML file contains a basic example with recommended values for an Agent installation.
The Batch Installer configuration file contains an <installation>
element for each Agent instance. In addition, the <global>
element can be used in a homogeneous environment to specify parameters that will be applied to all Agent installations. If a parameter is specified in the <global>
element and in an individual <installation>
element then the setting for the individual element will overwrite the global setting.
The following configuration steps should be carried out:
- Leave the global parameters as they were set for your previous Use Case.
- Specify the installation parameters for the extra Agent installation:
- Set
lastRun
element to an empty value (with the element<installations><installation>
). This is the value that will make the Batch Installer just carry out this one extra installation and skip the rest. - Agent options:
<scheduler_user>
: the Agent user<scheduler_log_dir>
: the Logs folder for the Agent
Specify the credentials for the SSH connection:
<user>
: the SSH login user<password>
: the Password for the login user<sudo_password>
: the Password forsudo
actions- <
auth_method>
: the SSH authentication method - <
host
>: the SSH Host <port>
: the SSH port
- Use the
<postprocessing>
element to specify the post-processing commands for the Agent server's operating system. The default commands for an Ubuntu distribution will place the Agent start script under/etc/init.d
and will setup the autostart for the Universal Agent: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
- Set
Post-processing commands
- The SSH login user has to be set to
root
in order to execute these commands. Therefore the SSH login user should be included insudoers
. - These two commands will be executed by the
PerformInstall
job node, which is the last job node in the job chain. If you want to add more commands, please add the call to the job node. Note that the values for the elements defined in the Batch Installer configuration file can be used for the postprocessing commands, for instance:
${install_path}
: the value for the element<install_path>
${agent_options.scheduler_http_port}
: the value for the element<
scheduler_http_port>
. If not defined, the default value (4445 in this case) is taken, as in the example below.
An example Batch Installer configuration file for the installation of two Agents is attached to this page (download: batch_installer_config_file.xml) and is shown in the following code block:
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:
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.