Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Final proofreading changes

...

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. Concretely, it will be used here for transferring the following files from the JobScheduler Master to the Agent servers:
    • JobScheduler Universal Agent installation files: jobscheduler_unix_universal_agent.1.11.0-SNAPSHOT.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

 

Show If
groupsos-members

Status
colourYellow
titleContext / Zusammenhang?

...

  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. 

 

Show If
groupsos-members

#4 -

Status
colourYellow
title???

 

Example: Installation of two Agents

...

The following configuration steps should be carried out:

  1. Specify the 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>.

      Show If
      groupsos-members

       

      Status
      colourYellow
      titleHow does the user know this?

    • 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 Use the <postprocessing> element to specify the post-processing commands that fit your for the Agent server's operating system on the Agent server with the <postprocessing> element. The default commands for an Ubuntu distribution will place the Agent start script under /etc/init.d and will setup the autostart for JobScheduler the 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 Specify the installation parameters (specified for each Agent installation):
    • Agent options:
      • <scheduler_user>: Agent user
      • <scheduler_log_dir>: Logs folder for the Agent
    • SSH Host 

Info
titlePost-processing commands
  • The SSH login user has to become root in order to execute these commands. Therefore the SSH login user should be included to sudoers.
  • These two commands will be executed by the PerformInstall job node PerformInstall, which is the last job node in the job chain. If you want to add more commands, please add the call on to the job node.
  • Note that the values for the elements defined in the Batch Installer configuration file can be used for the postprocessing commands, for instance:

    Show If
    groupsos-members

     

    Status
    colourYellow
    titleMeaning not clear

    • ${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, like as in the example below.

 

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

Code Block
languagexml
titleBatch Installer Configuration File
collapsetrue
<?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>

 

Info
titleHints
  • Note that the port is specified with the

    parameter 

    <scheduler_http_port>

    is not specified with the element

    parameter and not the <installations><installation><agent_options> element. This configuration causes the global value 4445 to be applied to all Agent installations.

    Show If
    groupsos-members

     

    Status
    colourYellow
    title'this configuration' refers to agent_options?

  • For a homogeneous environment parameters can be specified with the <global> element and are applied to all Agent installations.

...

Anchor
yade_profile_transfer
yade_profile_transfer
YADE Configuration File for File Transfer

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

Each installation makes use of a 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> element and
  • <port> will be substituted with the value from the element  <installation><agent_option><scheduler_http_port> element.

Please follow these take 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 above - 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 above - 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.

...

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

Code Block
title.ini 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.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/

...

XML Editor for Batch Installer configuration file

An example for a Batch Installer configuration file where one Agent installation is defined looks like thisfor the installation of a single Agent is shown in the following screenshot:

XML Editor for YADE configuration file

An example for a YADE configuration file where one Agent installation is defined looks like thisfor the installation of a single Agent is shown in the next screenshot:

Anchor
yadexml2ini_converter
yadexml2ini_converter
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:

Image Removed

The "YADE Xml2Ini Converter" function in the XML Editor is available for converting YADE files from XML to the .ini format required by versions of YADE before 1.11. Clicking on the button of the same name will open the following form:

Image Added

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

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

 

YADE configuration file