Batch Installer Use Case: Homogeneous environment

Environment

This article describes the use of the JobScheduler Universal Agent batch installer/updater 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 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 optionally up and running.

Operation of th Batch Installer/Updater Structure

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 Installer / Updater structure is made up of a JobScheduler AgentBatchInstaller job  and a JobScheduler universal_agent_installer job chain. 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:

• CheckPreRequisiteSync: To wait until all prerequisites have been checked and any already installed Agent instances that are running have been shut down. 

  • 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.

• 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 files that are to be transfered are specified with the element <globals><transfer><file_spec=".*\.(sh|gz)$">

  • This regular expression is used to, the following files will 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 step before transfered installation script will be executed
    

  • 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

Download

The following steps have to be carried out. Files can be downloaded from http://www.sos-berlin.com/jobscheduler-downloads

1. 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 the live 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 the config directory of the JobScheduler Master: $SCHEDULER_DATA/config.
   • Copy the JobScheduler Universal Agent installation file to the ${SCHEDULER_DATA}/config/batch_installer folder.
     
2. 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 the live folder of the JobScheduler Master ${SCHEDULER_DATA}/config/live.
     • the config/batch_installer folder contains configuration files for the Batch Installer that should be extracted to the JobScheduler configuration directory ${SCHEDULER_DATA}/config.
     • Copy the JobScheduler Universal Agent installation file to the folder ${SCHEDULER_DATA}/config/batch_installer.

Configuration

XML files

1. Configuring XML files with a text editor is error-prone. Therefore we recommend that you download the XML Editor that can be used to manage the configuration files required for the Batch Installer. For details about the XML Editor see the Using the XML Editor chapter below.
   
   • 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 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.
   • 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
2. See the Batch Installer Configuration File chapter below for instructions on how to configure the Batch Installer configuration file 
3. See the YADE profiles for the file transfer chapter below for instructions on how to configure the YADE configuration file

JobScheduler Jobs

• AgentBatchInstaller job: adjust the parameter values for the AgentBatchInstaller job in your JobScheduler Master.

  • Adjust the installation_definition_file job parameter with the path that points 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:

1. Open a JobScheduler Operating Center (JOC) browser window for the JobScheduler master.
2. Right click on the job to open the context menu.
   
3. Select the Start task immediately operation.
4. This job will create the appropriate JobScheduler orders as explained in the chapter and the Agent installation. 

Example: Installation of two Agents

The following example describes the installation of two Agents on separate servers.

Batch Installer Configuration File

You should have opened the Batch Installer configuration file batch_installer_config_file.xml and have assigned the XSD schema scheduler_universal_agent_installations.xsd. The XML file contains a basic example with the recommended values for an Agent installation.

The Batch Installer configuration file contains an <installation> element for each Agent instance. For a homogeneous environment parameters can be specified with the <global> element and will be applied to all Agent installations. If a parameter is available in the <global> element and in an individual <installation> element then the setting for the specific installation will overwrite the global setting.

Please, perform the following configuration steps:

1. Global parameters:
   • Specify the <install_path> to point to a location where the Agent should be installed.
   • Specify the path to the YADE settings file (.ini file) in the Batch Installer configuration file with the element <globals><transfer><settings>.
   • Specify the credentials for the SSH connection:
     • <user>: SSH login user 
     • <password>: Password for the login user
     • <sudo_password>: Password for sudo actions
     • <auth_method>: SSH authentication method
     • <port>: SSH port 
   • Specify the post-processing commands that fit your operating system on the Agent server with the <postprocessing> element. The default commands will place the Agent start script under /etc/init.d and will setup the autostart for JobScheduler Universal Agent on a Linux server (example for an 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
2. Installation parameters (specified for each Agent installation):
   • Agent options:
     • <scheduler_user>: Agent user
     • <scheduler_log_dir>: Logs folder for the Agent
   • SSH Host 
     
     

An example for the Batch Installer configuration file for the installation of two Agents might look like this:

<?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>
        <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>

YADE Configuration File for File Transfer

You should have opened your YADE configuration file yade_agent_batch_installer_settings.xml and have assigned the XSD schema http://www.sos-berlin.com/schema/yade/YADE_configuration_v1.0.xsd. The XML file contains a basic example with recommended values for an Agent installation (of only one Agent).

Each installation makes use of a profile in the YADE configuration 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. 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 element above <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 element above <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.

An example for the Batch Installer configuration file for the installation of two Agents might look like this:

 <?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>

YADE Settings File for File Transfer

Note that the file shown above is an XML file and YADE will expect an .ini file to perform the transfer that is specified with the Batch Installer configuration file in the element <globals><install_path><transfer><settings>.

• It is recommended to use the XML Editor to convert configuration files from XML to .ini format (see below chapter XML Editor for converting YADE configuration files (XML) into YADE setting files (.ini))
• Find the following example of an .ini file that has been converted from the above XML file:
  
  

[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/

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 for a Batch Installer configuration file where one Agent installation is defined looks like this:

XML Editor for YADE configuration file

An example for a YADE configuration file where one Agent installation is defined looks like this:

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

For converting YADE files from a XML format to an .ini format you have the option "YADE Xml2Ini Converter" in your XML Editor. The next screen will look like this:

Regarding the Batch Installer it is not necessary to create a Profile, since the conversion takes place one time once the "Autotransform" option has been chosen. Every time a change in the XML file is saved the file will be automatically converted to the .ini file. 

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