Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: 'Introduction' extended

Table of Contents

Scenario

Let be the following scenario:

  • One JobScheduler Master is running.
  • N different servers, where K JobScheduler Universal Agent instances have to be installed on each server. 
  • The ports where the JobScheduler Universal Agents will be running are the NOT the same ones 
  • The users, which the JobScheduler Universal Agents is running under are NOT named the same.
  • There has been no previous JobScheduler Universal Agents installations on the N servers.

Installation and Configuration Steps

For both scenarios above, the same steps will be carried out:

  1. Download the JobScheduler Universal Agent Batch Installer zip File
  2. Unzip the JobScheduler Universal Agent Batch Installer zip file.

  3. Download the JobScheduler Universal Agent installation file.
  4. Copy the content of the live folder to the live folder of your JobScheduler Master instance
  5. Copy the content of the folder batch_install to any folder (where the JobScheduler has permissions to access)
  6. 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
  7. Create the installer configuration file (see paragraph below Installer Configuration File
  8. Job AgentBatchInstaller: Adjust the parameter values for the Job AgentBatchInstaller in your JobScheduler Master
  9. Create the YADE settings file (see section below YADE profiles for the file transfer)

Example: Extra Installation after 2 Agents on 2 Servers

The following example describes how to do the installation of two JobScheduler Universal Agents in two Servers, that is, one JobScheduler Universal Agent installed per Server. 

...

Introduction

This article is one of a series describing how to configure the JobScheduler Universal Agent Batch Installer 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 an environment where Agents have already been installed. 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 Agent Batch Installer for installing JobScheduler Agents in an environment in which a number of the Agents have already been installed and where the new Agents are to be installed on a server which already has at least one Agent. The environment can be summarized as having the following characteristics:

  • A JobScheduler Master is up and running.
  • A number of JobScheduler Agents have already been installed on different Agent servers.
    • At least one additional Agent is to be installed on a server which already has an Agent installed on it.
    • The additional Agent installation will overwrite the previous Agent installation.
  • The new Agent(s) will be operated with the same user and installation path as one of the Agents already installed on an Agent server.
  • The new Agent will be identified by its listening port which will be unique for the server which the Agent is being installed on.

The use case described in this article builds on the case presented in the Batch Installation - Use Cases - Multiple Instances article in which a total of four agents were installed on two servers. Note, however, that only one Agent server with a single Agent installed on it is required before the current example can be implemented.

Prerequisites

The following articles describe the installation of Agents using the Agent Batch Installer. These articles all cover fresh installation - i.e. the installation of a first Agent on a server - or update for a number of different environments. In case an extra Agent installation should be carried out, the user came previously across one of these environments (either using the Batch Installer or through other methods). In particular, we recommend to have a look the "Batch Installer Application" and "Download" sections in each article to understand how the solution works:

Excerpt Include
Batch Installer for the JobScheduler Universal Agent (deprecated)
Batch Installer for the JobScheduler Universal Agent (deprecated)
nopaneltrue

Configuration

XML 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 section below for more detailed information about using the XML Editor.

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:

...

languagexml
titleInstaller Configuration File
linenumberstrue
collapsetrue

...

  • 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 configuration file, which is located in the config/batch_installer folder and assign the XSD schema http://www.sos-berlin.com/schema/yade/YADE_configuration_v1.0.xsd. See the YADE profiles for the file transfer section below for instructions on how to configure the YADE configuration file.
  • 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 the Batch Installer Configuration File section below for instructions on how to configure the Batch Installer configuration file.

Info
titleHints
  • The  XML Editor is available for Windows.
  • YADE is an Open Source file transfer solution for FTP, SFTP, FTPS, WebDAV and other protocols. It is used here for transferring the following files from the JobScheduler Master to the Agent servers:
    • JobScheduler Universal Agent installation files: jobscheduler_unix_universal_agent.<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.

JobScheduler Jobs

Background information

The JobScheduler Agents will be installed by the JobScheduler Master which:

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

The Batch Installer 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 uses a name according to the pattern <host>:<port> to convey the host and port of the server where each Agent is to be installed.

Configuration

Carry out the following once the job and job chain have been extracted to the live folder of the JobScheduler Master: 

  • AgentBatchInstaller job: adjust the parameter values for the AgentBatchInstaller 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 to false. This will ensure that in the example described below the Batch Installer will not attempt to update existing Agent installations that have been installed using the Batch Installer - and whose configurations are included in the Batch Installer Configuration File.

Further information

A detailed description of the installation procedure itself can be found in the Batch Installation - Reference Documentation article.

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:

  1. Open a JobScheduler Operating Center (JOC) browser window for the JobScheduler master.
  2. Go on the Jobs Window and open the batch_installer_universal_agent folder.
  3. Right click on the job to open the context menu.
  4. Select the Start task immediately operation.

Example: Installation of an additional JobScheduler Universal Agent

The following example describes how to do the installation and configuration of a JobScheduler Universal Agent on an Agent Servers, in an environment with four JobScheduler Universal Agents already installed - two Agents on two different servers. The extra instance is added to the configuration already described in the Batch Installation - Use Cases - Multiple Instances use case. ´The Batch Installer will ignore the configuration information for the agents that have already been installed as the update job parameter for the AgentBatchInstaller job has been set to false as described in the JobScheduler Jobs section of this article above.

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.

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:

  1. 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>.
  2. 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>.
  3. 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.

You can download the YADE Configuration file for the example here: yade_agent_batch_installer_settings.xml. The contents of this file are shown in the following code block:

Code Block
languagexml
titleYADE Profiles
collapsetrue
<?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:4445ini</settings>
        </transfer>
        <ssh>
            <auth_method>password</auth_method>
            <port>22</port>
        </ssh>
    </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 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>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 chkconfig 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><BasicConnection>
            <scheduler_http_port>4446</scheduler_http_port><Hostname><![CDATA[192.11.0.111]]></Hostname>
            <scheduler_user>test</scheduler_user></BasicConnection>
            <scheduler_log_dir>/var/log/sos-berlin.com/jobscheduler/agent</scheduler_log_dir>
<SSHAuthentication>
          </agent_options><Account><![CDATA[test]]></Account>
        <ssh>
  <AuthenticationMethodPassword>
          <user>sos</user>
      <Password><![CDATA[xxxx]]></Password>
        <password>xxxx<  </password>AuthenticationMethodPassword>
        </SSHAuthentication>
    <sudo_password>xxxx</sudo_password>
    </SFTPFragment>
      <SFTPFragment name="SFTP_192.11.0.111:4446">
        <BasicConnection>
          <host>192<Hostname><![CDATA[192.11.0.95</host>111]]></Hostname>
        </ssh>BasicConnection>
        <postprocessing><SSHAuthentication>
            <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>
    <Account><![CDATA[sos]]></Account>
          <AuthenticationMethodPassword>
        <command>echo ${ssh.sudo_password} | sudo -S chkconfig jobscheduler_agent_${agent_options.scheduler_http_port}</command>  <Password><![CDATA[xxxx]]></Password>
          </AuthenticationMethodPassword>
        </postprocessing>SSHAuthentication>
      </installation>
	<installation lastRun="SFTPFragment>
      <SFTPFragment name="SFTP_192.11.0.95:4445">
        <agent_options><BasicConnection>
            <scheduler_http_port>4448</scheduler_http_port><Hostname><![CDATA[192.11.0.95]]></Hostname>
            <scheduler_user>test</scheduler_user></BasicConnection>
        <SSHAuthentication>
    <scheduler_log_dir>/var/log/sos-berlin.com/jobscheduler/agent</scheduler_log_dir>
        </agent_options><Account><![CDATA[sos]]></Account>
        <ssh>  <AuthenticationMethodPassword>
            <user>test</user><Password><![CDATA[xxxx]]></Password>
            <password>xxxx</password></AuthenticationMethodPassword>
        </SSHAuthentication>
      </SFTPFragment>
      <sudo_password>xxxx</sudo_password>
  <SFTPFragment name="SFTP_192.11.0.95:4446">
        <BasicConnection>
          <host>192<Hostname><![CDATA[192.11.0.111</host>95]]></Hostname>
        </ssh>BasicConnection>
        <postprocessing><SSHAuthentication>
          <Account><![CDATA[test]]></Account>
  <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>       <AuthenticationMethodPassword>
            <command>echo ${ssh.sudo_password} | sudo -S chkconfig jobscheduler_agent_${agent_options.scheduler_http_port}</command>
   <Password><![CDATA[xxxx]]></Password>
          </AuthenticationMethodPassword>
        </SSHAuthentication>
      </postprocessing>SFTPFragment>
    </installation>ProtocolFragments>
</installations>

 

...

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:

  1. Specify the name of the YADE settings file with the <globals><settings> element.
  2. Open the YADE settings file or create a new one.
  3. Assign the XSD Schema http://www.sos-berlin.com/schema/yade/YADE_configuration_v1.0.xsd
  4. Add a <ProtocolFragments> element and nodes for each host that you want to install the JobScheduler Universal Agent for.
  5. Add a <Profile> element and nodes for each host you want install the JobScheduler Universal Agent for.
  6. 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.

 

Code Block
languagexml
titleYADE Profiles
collapsetrue
 <?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>  </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>
      <SFTPFragment name="SFTP_192.11.0.111:4445">
          <BasicConnection></SourceFileOptions>
          <Hostname><![CDATA[192.11.0.111]]></Hostname>
</CopySource>
          </BasicConnection><CopyTarget>
        <SSHAuthentication>
    <CopyTargetFragmentRef>
      <Account><![CDATA[test]]></Account>
        <SFTPFragmentRef  <AuthenticationMethodPassword>ref="SFTP_192.11.0.111:4445" />
            <Password><!</CopyTargetFragmentRef>
            <Directory><![CDATA[xxxx/home/test/tmp/]]></Password>Directory>
          </AuthenticationMethodPassword>CopyTarget>
        </SSHAuthentication>Copy>
      </SFTPFragment>Operation>
    </Profile>
    <SFTPFragment<Profile nameprofile_id="SFTP_192.11.0.95111:44454446">
      <Operation>
        <BasicConnection><Copy>
          <Hostname><![CDATA[192.11.0.95]]></Hostname><CopySource>
        </BasicConnection>
    <CopySourceFragmentRef>
    <SSHAuthentication>
          <Account><![CDATA[sos]]></Account><LocalSource />
          <AuthenticationMethodPassword>
            <Password><![CDATA[xxxx]]></Password>
</CopySourceFragmentRef>
            </AuthenticationMethodPassword><SourceFileOptions>
        </SSHAuthentication>
      </SFTPFragment><Selection>
    </ProtocolFragments>
  </Fragments>
  <Profiles>
    <Profile profile_id="192.11.0.111:4445">
      <Operation><FileSpecSelection>
        <Copy>
          <CopySource>
<FileSpec><![CDATA[.*\.(sh|gz)$]]></FileSpec>
            <CopySourceFragmentRef>
      <Directory><![CDATA[C:\Program Files (x86)\sos-berlin.com\jobscheduler\vg_4444\scheduler_data\config\batch_installer]]></Directory>
      <LocalSource />
            </CopySourceFragmentRef>FileSpecSelection>
            <SourceFileOptions>
  </Selection>
            <Selection></SourceFileOptions>
          </CopySource>
      <FileSpecSelection>
    <CopyTarget>
            <CopyTargetFragmentRef>
              <FileSpec><![CDATA[.*\.(sh|gz)$]]></FileSpec>
<SFTPFragmentRef ref="SFTP_192.11.0.111:4446" />
            </CopyTargetFragmentRef>
            <Directory><![CDATA[C:\tmp\agent_batch/home/sos/tmp/]]></Directory>
                </FileSpecSelection>CopyTarget>
        </Copy>
      </Selection>Operation>
     </Profile>
    <Profile profile_id="192.11.0.95:4445">
      <Operation>
        <Copy>
          <CopySource>
            <CopySourceFragmentRef>
              <LocalSource </SourceFileOptions>>
            </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>
	<Profile profile_id="192.11.0.111:4448">
      <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:4448" />
            </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.11 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.

Code Block
titleINI file
collapsetrue
[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
[protocol_fragment_sftp@SFTP_192.11.0.111:4448]
protocol                            = sftp
host                                = 192.11.0.111
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/
[192.11.0.111:4448]
operation                           = copy
source_protocol                     = local
file_spec                           = .*\.(sh|gz)$
source_dir                          = C:\tmp\agent_batch
target_include                      = protocol_fragment_sftp@SFTP_192.11.0.111:4448
target_dir                          = /home/test/tmp/

Anchor
installer_config_file
installer_config_file
Batch Installer Configuration File

You can download the Batch Installer configuration file for the example here: batch_installer_config_file.xml. The contents of this file are listed in the code block later on in this section:

Open the Batch Installer configuration file in the XML Editor and assign the scheduler_universal_agent_installations.xsd XSD schema.

The Batch Installer configuration file contains an <installation> element for each Agent instance. In addition, the <global> element is used 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 configuration file contains configurations for the four Agents whose installation was described in the Batch Installation - Use Cases - Multiple Instances article. The file also contains the configuration for the additional Agent that is to be installed in this example. The configuration for this Agent can easily be recognized by <installation lastRun=""> element tag, which is empty and therefore the only one that will be took into account by the Batch Installer.

The following configuration steps would need to be carried out to add the configuration for the additional Agent to this file:

  1. Leave the global parameters as they were set for your previous Use Case.
  2. Specify the installation parameters for the extra Agent installation:
    • Set lastRun attribute to an empty value (for the <installations><installation> element). This is the value that will make the Batch Installer just carry out this one additional installation and skip (i.e. not attempt to update) 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 for sudo 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
Info
titlePost-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 in sudoers.
  • The two post-processing 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 XML elements defined in the Batch Installer configuration file can be used for post-processing 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.

The Batch Installer configuration file for the example can be downloaded here: batch_installer_config_file.xml and is shown in the following code block:

Code Block
languagexml
titleInstaller Configuration File
linenumberstrue
collapsetrue
<?xml version="1.0"  </CopySource>
  encoding="UTF-8" standalone="yes"?>
<installations lastRun="2015-11-23 12:11">
        <CopyTarget><globals>
            <CopyTargetFragmentRef><install_path>/opt</install_path>
              <SFTPFragmentRef ref="SFTP_192.11.0.111:4445" /><transfer>
            </CopyTargetFragmentRef> <settings>C:\Program Files (x86)\sos-berlin.com\jobscheduler\vg_4444\scheduler_data\config\batch_installer\yade_agent_batch_installer_settings.ini</settings>
        </transfer>
        <Directory><![CDATA[/home/test/tmp/]]></Directory><ssh>
          </CopyTarget>
  <auth_method>password</auth_method>
            <<port>22</Copy>port>
        </Operation>/ssh>
		<installation_file>jobscheduler_unix_universal_agent.1.10.2.tar.gz</installation_file>
    </Profile>globals>
    <Profile<installation profile_idlastRun="192.11.0.95:4445">
  2015-11-23 11:11">
        <agent_options>
            <scheduler_user>test</scheduler_user>
    <Operation>
        <Copy><scheduler_log_dir>/var/log/sos-berlin.com/jobscheduler/agent</scheduler_log_dir>
          <CopySource></agent_options>
            <CopySourceFragmentRef><ssh>
              <LocalSource /><user>test</user>
            <<password>xxxx</CopySourceFragmentRef>password>
            <SourceFileOptions><sudo_password>xxxx</sudo_password>
            <host>192.11.0.111</host>
   <Selection>
     </ssh>
        <postprocessing>
   <FileSpecSelection>
         <command>echo ${ssh.sudo_password} | sudo -S     <FileSpec><![CDATA[.*\.(sh|gz)$]]></FileSpec>
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     <Directory><![CDATA[C:\tmp\agent_batch]]></Directory>chkconfig jobscheduler_agent_${agent_options.scheduler_http_port}</command>
          </postprocessing>
      </FileSpecSelection>installation>
    <installation lastRun="2015-11-23 11:11">
        </Selection><agent_options>
            </SourceFileOptions>
<scheduler_http_port>4446</scheduler_http_port>
            </CopySource>
<scheduler_user>sos</scheduler_user>
            <CopyTarget><scheduler_log_dir>/var/log/sos-berlin.com/jobscheduler/agent</scheduler_log_dir>
        </agent_options>
    <CopyTargetFragmentRef>
    <ssh>
          <SFTPFragmentRef ref="SFTP_192.11.0.95:4445" /> <user>sos</user>
            <<password>xxxx</CopyTargetFragmentRef>password>
            <Directory><![CDATA[/home/sos/tmp/]]></Directory><sudo_password>xxxx</sudo_password>
          </CopyTarget>  <host>192.11.0.111</host>
        </Copy>ssh>
      </Operation>
    </Profile>
  </Profiles>
</Configurations>

HINTS: 

...

titleINI file
collapsetrue

...

  <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_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>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="">
        <agent_options>
            <scheduler_http_port>4448</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.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 chkconfig jobscheduler_agent_${agent_options.scheduler_http_port}</command>
        </postprocessing>
    </installation>
</installations>

Excerpt Include
Batch Installation - Use Cases - Homogeneous environment
Batch Installation - Use Cases - Homogeneous environment
nopaneltrue

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):

Image Removed

Image Removed