Page History

...

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

...

• connects to the Servers that the Agents are to be installed on and
• executes the corresponding  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 the respective each Agent is to be installed. 

...

• 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 each Agent instance. 
  • The XML file yadefile 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 following files to 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 installation script will install and start the JobScheduler Universal Agent
  • Finally the 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(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

...

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. Extract these files to the the live folder of the JobScheduler Master: SCHEDULER_DATA/config/live.
     • a config/batch_installer folder containing configuration files for the Batch Installer. Extract these files 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 contains the following content:
     • the config/live/batch_installer_agent folder contains jobs and job chains that should be extracted . Extract these files 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 . Extract these files to the JobScheduler configuration directory SCHEDULER_DATA/config.
     • Copy the JobScheduler Universal Agent installation file to the folder SCHEDULER_DATA/config/batch_installer.

...

Configuring XML files with a text editor is error-prone . Therefore and we recommend that you download the XML Editor. The XML Editor  that can can be used to manage the configuration files required for the Batch Installer and automatically validates files and thereby reduces the possibility of configuration errors. For details about the XML Editor see the Using the XML Editor chapter below.

...

1. Open a JobScheduler Operating Center (JOC) browser window for the JobScheduler master.
2. Go on the "Jobs" Window and open the folder "batch_installer_universal_agent" folder.
3. Right click on the job to open the context menu.
4. Select the Start task immediately operation.
5. This job will create the appropriate JobScheduler orders as explained in the chapter Batch Installer Application.

...

The following example describes how to do the installation of two JobScheduler Universal Agents on two separate servers, that is, one JobScheduler Universal Agent installed per Server. First of all, the YADE configuration files (XML file ) for the file transfer will be specified (in XML format), then it will then be converted to the YADE settings file format (.ini) and finally the Batch Installer configuration file will be specified.

...

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

An example for the Batch Installer configuration file for the installation of two Agents is attached on to this wiki page (download: yade_agent_batch_installer_settings.xml) and might look like thisis shown in the following code block::

 <?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[sos]]></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:\tmp\agent_batch]]></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:\tmp\agent_batch]]></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>
  </Profiles>
</Configurations>

...

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 here using this link: yade_agent_batch_installer_settings.ini.

...

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 both the <global> element and in an individual <installation> element then the setting for the individual element will overwrite the global setting.

...

1. Specify the Global parameters:

   • Specify the path to the YADE settings file (.ini file) in the Batch Installer configuration file with the element <globals><transfer><settings>. 

   • Specify the filename (not the path) for the Agent that has to be installed with the element <installation_file> element. This filename contains the version of the Agent which you are installing and it is helpful for recognising this version of the installed versionsrecognizing the Agent versions that have been installed.

2. Specify the installation parameters for each Agent installation:
   • Specify the <install_path> to point to a location where the Agent should be installed.
   • 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>:  SSH the SSH Host
     • <port>: the SSH port 
   • Use the <postprocessing> element to specify the post-processing commands that for the Agent server's operating system. The default commands for an a 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



An example Batch Installer configuration file for the installation of two Agents is attached on this wiki page (download: batch_installer_config_file.xml) and might look like thisis shown in the following code block:

<?xml version="1.0" encoding="utf-8"?>
<installations lastRun="2015-11-19 17:11">
  <globals>
    <transfer>
      <settings><![CDATA[c:\tmp\agent_batch\yade_agent_batch_installer_settings.ini]]></settings>
    </transfer>
	<installation_file><![CDATA[jobscheduler_unix_universal_agent.1.10.2-SNAPSHOT.tar.gz]]></installation_file>
  </globals>
  <installation lastRun="2015-11-19 17:11">
    <install_path><![CDATA[/opt]]></install_path>
    <agent_options>
      <scheduler_http_port>4447</scheduler_http_port>
      <scheduler_user><![CDATA[test]]></scheduler_user>
      <scheduler_log_dir><![CDATA[/var/log/sos-berlin.com/jobscheduler/agent]]></scheduler_log_dir>
    </agent_options>
    <ssh>
      <password><![CDATA[test]]></password>
      <sudo_password><![CDATA[xxxx]]></sudo_password>
      <auth_method><![CDATA[password]]></auth_method>
      <host><![CDATA[192.11.0.111]]></host>
      <port><![CDATA[22]]></port>
    </ssh>
    <postprocessing>
      <command><![CDATA[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><![CDATA[echo ${ssh.sudo_password} | sudo -S update-rc.d jobscheduler_agent_${agent_options.scheduler_http_port}]]></command>
    </postprocessing>
  </installation>
  <installation lastRun="2015-11-19 17:11">
    <install_path><![CDATA[/opt/]]></install_path>
    <agent_options>
      <scheduler_http_port>4445</scheduler_http_port>
      <scheduler_user><![CDATA[sos]]></scheduler_user>
      <scheduler_log_dir><![CDATA[/var/log/sos-berlin.com/jobscheduler/agent]]></scheduler_log_dir>
    </agent_options>
    <ssh>
      <user><![CDATA[sos]]></user>
      <password><![CDATA[xxxx]]></password>
      <sudo_password><![CDATA[xxxx]]></sudo_password>
      <auth_method><![CDATA[password]]></auth_method>
      <host><![CDATA[192.11.0.95]]></host>
      <port><![CDATA[22]]></port>
    </ssh>
    <postprocessing>
      <command><![CDATA[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><![CDATA[echo ${ssh.sudo_password} | sudo -S chkconfig jobscheduler_agent_${agent_options.scheduler_http_port}]]></command>
    </postprocessing>
  </installation>
</installations>

...