Page History

...

The JobScheduler Universal Agent Batch Installer is a set of files that are is used by a JobScheduler Master to install one or more Universal Agents on local and remote servers.

...

This article describes the use of the JobScheduler Universal Agent Batch Installer on a Linux server, working from a Windows system.

Note that the Batch Installer is only available for the current JobScheduler Universal Agent version.

Installation Procedure

General requirements:

...

...

Two configuration elements are required for the transfer of the files required for each Universal Agent that is to be installedinstallation:

• a Protocol Fragment that defines how the file transfer is to be carried out and
• a Profile that defines the file transfer itself.

...

• Configurations
  • Fragments
    • ProtocolFragments
      • SFTPFragment name="SFTP_192.11.0.0202202:4441"
        • BasicConnection
          • Hostname192.11.02020.202
        • SSHAuthentication
          • Account sos
          • AuthenticationMethodPassword
            • Password ********

...

A typical profile_id attribute would be 192.11.02020.202:4441.

A typical Profile configuration could contain the following elements:

• The CopySource ... Directory element

...

• , which points to the batch_install folder which was unpacked as described in Section 1 of this article above.
• The SFTPFragmentRef element

...

• , which contains the name of the SFTPFragment element configured in the Protocol Fragment Configuration section above.
• The CopyTarget ... Directory

...

• , which points to a folder on the target server where the Account specified in the SSHAuthentication.Account element (configured in the Protocol Fragment Configuration section above) will be able to carry out the installation.

A complete typical Protocol Fragment Profile configuration for a single Agent would be (shown listed from the root Configurations element):

• Configurations
  • Profiles
    • Profile profile_id="192.11.0.202:4441"
      
      • Operation
        • Copy
          • CopySource
            • CopySourceFragmentRef
              • LocalSource
            • SourceFileOptions
              • Selection
                • FileSpecSelection
                  • FileSpec .*\.(sgsh|gz)$
                  • Directory C:\ProgramData\sos-berlin.com\jobscheduler\jobscheduler_1.12\config\batch_install
          • CopyTarget
            • CopyTargetFragmentRef
              • SFTPFragmentRef ref="SFTP_192.11.0.202:4441"
            • Directory /home/sos/temp/js_agent_batch_install

...

• Open your batch_installer_config_file.xml configuration file in the XML Editor.
  
  • Assign the scheduler_universal_agent_installations.xsd schema, which will also be located in the SCHEDULER_DATA/config/batch_installer folder.

The root XML element of the Batch Installer configuration file is the <installations> element. This contains an <installation> element for each Agent instance to be installed. In addition, the <global> element can be used in a homogeneous environment to specify parameters that will be applied to all Agent installations. The majority of configuration elements can be specified as <global> and as <installation> elements. 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.

The parameters to be configured are:

The parameters to be configured are:

• The <install_path> element, which points to a location where the Agent should be installed. (Mandatory)
  
  • A
  the <install_path> element, which points to a location where the Agent should be installed.
  • A typical value would be /opt/sos-berlin.com/jobscheduler
• the <transfer><settings> The <transfer><settings> element which points to the location where the YADE transfer configuration file that was configured in Section 2.1 above. (Mandatory)
  • A typical value would be C:\ProgramData\sos-berlin.com\jobscheduler\jobscheduler_1.12\config\batch_install\yade_agent_batch_installer_settings.xml
• the The <ssh> elements (often partly configured as <global> elements):
  • <auth_method>: the authentication method to be used for the SSH connection. (Mandatory)
  • <port>: SSH port. (Mandatory)
  • <user>: SSH login account name. (Mandatory)
  • <password>: Password for the SSH login account.
  • <auth_method>: SSH authentication method. (Mandatory)
  • <host>: the host name of the target server. (Mandatory)
• the The <installation_file> element - the name of the Universal Agent installation file. This filename contains the version of the Agent which you are installing and it is helpful for recognizing the version of the Agents that are installed. (Mandatory)
  
  • For Unix systems this is usually jobscheduler_unix_universal_agent.<version>.tar.gz
• the The <agent_options> elements:
  • <java_home>: the location of the Java Runtime Environment (JRE)
    
    • See here for more information.
  • <java_options>: the Java options, e.g the Java memory settings
    • See here for more information
  • <scheduler_http_port>: the http port that the Universal Agent is to use.
  • <scheduler_user>: the user name the Agent is to run under on the target system.
  • <scheduler_log_dir>: the directory to be used for the Agent Log files.
    
    • A typical location would be /var/log/sos-berlin.com/jobscheduler/agent.
  • listen to. (Mandatory)
  • <scheduler_ip_address> the IP address of the target system. (Mandatory)
  • <scheduler_user>: the user name the Agent is to run under on the target system. (Mandatory)
  • <scheduler_log_dir>: the directory to be used for the Agent Log files.
    
    • A typical location would be /var/log/sos-berlin.com/jobscheduler/agent.
    • See here for more information
  • <scheduler_kill_script> the kill scripts allows a task and it's child processes to be killed.
    
    • See here for more information.
  • <scheduler_pid_file_dir> the
    • See here for more information.
  • <agent_installation_script> the script to be used for the installation of the Agent (Mandatory)
    
    • This is usually jobscheduler_universal_agent_install.sh
• The <postprocessing> elements:
  • Post
  the <postprocessing> elements:
  • 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
  • These two commands will be executed by the PerformInstall job node, which is the last job node in the batch installer job chain. If you want to add more commands, please add the call to the job node.

...

Note that in the above example two of the SSH elements (<auth_method> and <port>) are configured globally and four (<user>, <password>, <sudo_password> and <host>) are configured individually for each Agent.

...