...

Job Chain: universal_agent_installer.job_chain.xml

The job chain is configuration is shown in the code block below:

...

• CheckPreRequisite
  • Checks for the correct Java version
  • Checks whether a JobScheduler Universal Agent already has been installed.
    
    • If soyes, then the Installer:
      • shuts down any instances that are possibly running
      • removes the installation
• Sync: Waits until all prerequisites have been checked and all instances shut down.
• TransferInstallationSetup: Transfers the installer files to the host
  • Before the transfer starts, the preprocessor will create the instance start script from the template jobscheduler_agent_instance_script.txt

  • The files that are to be transfered are specified with the <globals><transfer><file_spec=".*\.(sh|gz)$"> configuration element

    • This regular expression causes the following files to be transfered:
      
      • the JobScheduler Universal Agent installer files: jobscheduler_unix_universal_agent.<version>.tar.gz
      • the instance start script: jobscheduler_agent_<port>.sh
      • the installation script: jobscheduler_universal_agent_install.sh
• PerformInstall: Starts the installation using SSH.
  • The step before transfered installation script will be executed
  • The installation script installs and starts the JobScheduler Universal Agent
  • Finally the post-processing commands will be executed
    • The post-processing commands are specified with the <installation><postprocessing><command> element

    • Three commands will be executed
      
      • if you require additional commands, please add the call in the PerformInstall job

    • The default commands set up the autostart for JobScheduler Universal Agent on a Linux server (Ubuntu distribution)
      
      • echo ${ssh.sudo_password} | sudo -S cp ${install_path}/bin/jobscheduler_agent.sh /etc/init.d/jobscheduler
      • echo ${ssh.sudo_password} | sudo -S update-rc.d jobscheduler defaults

...

<job chain>_requirdrequired_orders

agent_options.scheduler_ip_address

agent_options.scheduler_http_port

agent_options.java_home

agent_options.java_options

agent_options.scheduler_home

agent_options.scheduler_user

agent_options.scheduler_log_dir

agent_options.scheduler_kill_script

agent_options.scheduler_pid_file_dir

host

port

user

auth_method

auth_file

password

sudo_password

install_path

Job: TransferInstallationSetup

This job uses the YADE JITL job to transfer the installer files to the host.

More detailed explanations of the parameters are available with the YADE - Documentation.

...

settings

profile

file_spec

target_host

target_port

target_protocol

target_user

target_password

target_dir

target_ssh_auth_method

target_ssh_auth_file

source_host

source_port

source

source_user

source_password

source_dir

source_ssh_auth_method

source_ssh_auth_file

...

command_n

command_counter

...

The update/installation procedure will be is started by running the job AgentBatchInstaller AgentBatchInstaller job, which is described in the next section.

The AgentBatchInstaller Job

...

The job AgentBatchInstaller reads the installer configuration file and creates orders for each element <installation>.

The element <installation> defines the source and the target of the installer files, the port for the JobScheduler Universal Agent and the SSH connection parameters. Please note:

• For all elements you You can define defaults for all elements in the <globals> element.
• You can use variables for the values e.g. ${ssh.host}.
• It is recommended to that specify the file name of the YADE settings file in the <globals> element and to use the default profile name. When doing so, no <installation><transfer> elements are required.

...

• This will mean that it is not necessary to define <installation><transfer> elements.

Parameters for the AgentBatchInstaller Job

installation_definition_file

filter_install_host

filter_install_port

installation_job_chain

update

Customizing the Installation Process

You can customize the The installation process can be customized as follows.

• Changing the script part The scripts in the SSH jobs CheckPreRequisite and PerformInstall e.g.  SSH jobs can be modified.
  
  • Use this if you want to check other prerequisites or execute
  some
  • additional commands either before or after the installation.
• Changing the installation script The jobscheduler_universal_agent_install.sh installation script can be modified.
• The Changing the template for the instance start script jobscheduler_agent_instance_script.txt start script for the Agent instances can be modified.

Checking Prerequisites

The CheckPreRequisite job CheckPreRequisite will will check the Java version, shutdown a possibly running shut down any JobScheduler Universal Agent and that may be running and remove the lib folder from an existing installation.

...

Performing the Installation

The PerformInstall job PerformInstall calls the installation script and executes the commands specified with the <postprocessing> element.

...

The installation script will unzip the Agent installation file and start the JobScheduler Universal Agent.

#!/bin/sh 
# Copyright (c) 2015 SOS GmbH, Berlin, Germany.
# All rights reserved.
export TERM=dumb
  clear
  echo "+---------------------------------------------------------+"
  echo "*     JobScheduler Univeral Agent                         *"
  echo "*     SOS Software- und Organisations Service GmbH        *" 
  echo "*     Giesebrechtstr. 15                                  *"
  echo "*     10629 Berlin                                        *"
  echo "*     ----------------------------------------------      *"
  echo "*     info@sos-berlin.com                                 *"
  echo "*     http://www.sos-berlin.com                           *"
  echo "+---------------------------------------------------------+"
  echo ""
  echo ""
  echo "+---------------------------------------------------------+"
  echo "*  This will install JobScheduler Universal Agent now ... *"
  echo "+---------------------------------------------------------+"
 
# -----------------------------------------------
cd `dirname $0`
  
SETUP_WORKING_DIR=`pwd` 
SETUP_INSTALL_PATH=""
SHOW_EXTRACTED_FILESNAMES=0
SETUP_LOG_FILE="$SETUP_WORKING_DIR/jobscheduler_universal_install.log"
SETUP_ERR=0
 


# ----------------------------------------------------------------- 
log_write() {
  case "$1" in
      0  ) msg_hint="[info]   ";;
      1  ) msg_hint="[warning]";;
      2  ) msg_hint="[error]  ";;
      3  ) msg_hint="[fatal]  ";;
      *  ) msg_hint="[info]   ";;
  esac
  timestamp=`date "+%Y-%m-%d %T"`
  msg="$timestamp   $msg_hint   $2"
  echo "$msg"
  echo "$msg">>"$SETUP_LOG_FILE"
}

show_usage() {
  echo "`basename $1` will install the 'JobScheduler Universal Agent' at [install_dir]." 
  echo "install_dir=Path with the JobScheduler Universal Agent"
  echo
  echo "Usage: `basename $1` [OPTION]"
  echo
  echo "Samples:"
  echo "  `basename $1` -co  -d/home/jobscheduler  -p4445 "      
  echo 
  echo "Options:"
  echo "  -h, --help                          | Shows this usage"
  echo "  -s, --show                          | show all extracted filenames"
  echo "  -w  --install_dir                   | Path of the JobScheduler Universal Agent installation"
  echo "  -p  --port                          | Port of JobScheduler Universal Agent. Default=4445"
 
}
 
# ----------------------------------------------------------------------------usage
if [ $# -eq 0 ]
then
  show_usage $0
  exit 65
fi 



# --------------------------------------------
     

for arg in "$@"
do
  long_opt=0
  echo "`expr match $arg '\(..\)'`" 
  case "`expr match $arg '\(..\)'`" in
    "-h"        )  show_usage $0; exit 64;;
    "-d"        )  SETUP_INSTALL_PATH="`expr match $arg '-d\(.*\)'`";;
    "-p"        )  UNIVERSAL_AGENT_PORT="`expr match $arg '-p\(.*\)'`";;
    "-s"        )  SHOW_EXTRACTED_FILESNAMES="`expr match $arg '-d\(.*\)'`";;
    "--"        )  long_opt=1;;
  esac 
  
  if [ "$long_opt" -eq 1 ]
  then
  case `expr match "$arg" '\(--[^=]*\)'` in
    "--show_extracted_filenames"    )  SHOW_EXTRACTED_FILESNAMES=`expr match "$arg" '--.*=\(.*\)'`;;
    "--help"    )  show_usage $0; exit 64;;
    "--install_dir"    )  SETUP_INSTALL_PATH=`expr match "$arg" '--.*=\(.*\)'`;;
    "--port"    )  UNIVERSAL_AGENT_PORT=`expr match "$arg" '--.*=\(.*\)'`;;
  esac
  fi

done

 
# ---------------

  
check_dir(){
     SETUP_INSTALL_PATH="$1"
     echo SETUP_INSTALL_PATH="$SETUP_INSTALL_PATH"

     if [ -d "$SETUP_INSTALL_PATH" ]
     then
       if [ -r "$SETUP_INSTALL_PATH" ]
       then
         cd "$SETUP_INSTALL_PATH"
         SETUP_INSTALL_PATH=`pwd`
         chmod 700 "$SETUP_INSTALL_PATH" 2>/dev/null
         SETUP_ERR=$?
       else
         log_write 2 "$SETUP_INSTALL_PATH is not readable."
         SETUP_ERR=1
       fi
     else
       echo create $SETUP_INSTALL_PATH

       mkdir -m700 -p "$SETUP_INSTALL_PATH" 2>/dev/null
       SETUP_ERR=$?
       if [ $SETUP_ERR -eq 0 ]
       then
      
         cd  "$SETUP_INSTALL_PATH"
         SETUP_INSTALL_PATH=`pwd`
       else
         log_write 2 "$SETUP_INSTALL_PATH can not create."
         SETUP_ERR=1 
       fi
     fi
     
     
     cd  "$SETUP_WORKING_DIR"
     if [ $SETUP_ERR -ne 0 ]
     then
        log_write 2 "You haven't the necessary rights on the installation directory $SETUP_INSTALL_PATH."
     exit $SETUP_ERR
fi
}

tarx (){
  if [ -f "$1.gz" ]
  then
     gzip -fd $1.gz
  fi
  
  if [ ! -d "$2" ]
  then
      mkdir $2
  fi
 
  cd  $2
  tar $tarpar $SETUP_WORKING_DIR/$1
  cd  $SETUP_WORKING_DIR
} 

tarpar="-xf "

if [ "$SHOW_EXTRACTED_FILESNAMES" = "1" ]
then
   tarpar="-xvf "
fi


SETUP_INSTALL_PATH="$SETUP_INSTALL_PATH"

echo SETUP_INSTALL_PATH=$SETUP_INSTALL_PATH
check_dir $SETUP_INSTALL_PATH
  

# Installing
log_write 0 "Installing --> $SETUP_INSTALL_PATH"
tarx  jobscheduler_unix_universal_agent.tar  $SETUP_INSTALL_PATH 

if [ -z "$UNIVERSAL_AGENT_PORT" ]
then
$UNIVERSAL_AGENT_PORT=4445
fi

mv `dirname $0`/jobscheduler_agent_$UNIVERSAL_AGENT_PORT.sh $SETUP_INSTALL_PATH/jobscheduler_agent/bin 
chmod a+x  $SETUP_INSTALL_PATH/jobscheduler_agent/bin/jobscheduler_agent_$UNIVERSAL_AGENT_PORT.sh   
log_write 0 "Start JobScheduler Universal Agent"
log_write 0 $SETUP_INSTALL_PATH/jobscheduler_agent/bin/jobscheduler_agent_$UNIVERSAL_AGENT_PORT.sh start
$SETUP_INSTALL_PATH/jobscheduler_agent/bin/jobscheduler_agent_$UNIVERSAL_AGENT_PORT.sh start 1 > /dev/null

exit $?

...

The installer configuration file contains an <installation> element for each JobScheduler Universal Agent instance.

A The following code block shows a minimal example for the installer configuration file can look like this:

 <?xml version="1.0" encoding="utf-8"?>
<installations lastRun="2015-11-06 15:11">
  <globals>
    <transfer>
      <settings><![CDATA[C:\Temp\batch_install\yade_agent_batch_installer_settings.ini]]></settings>
    </transfer>
  </globals>
  <installation lastRun="2015-11-06 15:11">
    <install_path><![CDATA[/home/test/temp/xxx]]></install_path>
    <agent_options>
      <scheduler_http_port>4445</scheduler_http_port>
      <scheduler_ip_address><![CDATA[192.11.0.116]]></scheduler_ip_address>
    </agent_options>
    <ssh>
      <user><![CDATA[test]]></user>
      <password><![CDATA[12345]]></password>
      <sudo_password><![CDATA[12345]]></sudo_password>
      <auth_method><![CDATA[password]]></auth_method>
      <port><![CDATA[22]]></port>
    </ssh>
    <postprocessing>
      <command><![CDATA[echo ${ssh.sudo_password} | sudo -S cp ${install_path}/bin/jobscheduler_agent.sh /etc/init.d/jobscheduler]]></command>
      <command><![CDATA[echo ${ssh.sudo_password} | sudo -S update-rc.d jobscheduler defaults]]></command>
    </postprocessing>
  </installation>
</installations>

With the The <globals> element you is used to specify the values that are used for all installation items. The items that are specific for an individual installation will overwrite the global values. There is one An installation item is required for each Agent. You can use substitution in the values of the elements.

<command>echo ${ssh.sudo_password} | sudo cp ${install_path}/bin/jobscheduler_agent.sh /etc/init.d/jobscheduler</command>

Using the XML Editor

...

to Configure 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 Then XML Editor can be used to manage the installater configuration file. It can be used to manage the YADE profiles for the transfer of the installation files as wellconfiguration 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 using the XML Editor.

Find more details from our XML Editor section article.

• After download of downloading the XML Editor, extract the zip file, then start the "sos.xml.editor.exe" file. (The XML Editor runs on Windows systems and does not need to be installed.)
• Open your installer configuration file in the Editor and assign the XSD schema scheduler_universal_agent_installations.xsd schema.

Managing the YADE

...

file transfer profiles

Each installation makes use of a profile in the YADE settings file. The default profile name is <host>:<port> where:

• <host> will be is substituted with the value from the element <installation><agent_option><scheduler_ip_address> and
• <port> will be is substituted with the value from the element <installation><agent_option><scheduler_http_port>

...