Sun Grid Engine Information Center
Installing Sun Grid Engine
Index

Automating the Installation Process

This section describes how you can automate the software installation process for the following reasons:

• To install the Grid Engine software on many hosts

• To install the Grid Engine software without user interaction

This section consists of the following topics:

About Automatic Installation

You can use the $SGE_ROOT/inst_sge utility to install and uninstall Sun Grid Engine master hosts, execution hosts, shadow host and Berkeley DB spooling server hosts. You can also use this utility to backup automatically the Sun Grid Engine configuration and accounting data.

Note Using the Berkeley DB Spooling Server host does not provide high availability, and it has no authentication mechanism. It should only be used on a closed network with fully trusted users.

You can use the inst_sge utility in interactive mode to supplant any of the commands that were described in Installing the Grid Engine Software Interactively.

To simplify automatic installation and backup processes, use the configuration templates that are located in the $SGE_ROOT/util/install_modules directory.

The automatic installation requires no user interaction. No messages are displayed on the terminal during the installation.

When the installation finishes, a message indicates where the installation log file resides. The name of the installation log file format is install_hostname_timestamp.log. Normally, you can find information about errors during installation in this file. In case of serious errors though, the installation script might not be able to move the log file into the spool directory. In this situation, the log file is placed in the /tmp directory.

Special Considerations

The first step in performing an automatic installation is to set up a configuration file. You can find configuration file templates in the $SGE_ROOT/util/install_modules directory. Consider the following as you plan your automatic installation:

• To use automatic installation on remote hosts, the root user must be able to access those hosts through rsh or ssh without supplying a password.
• For local spooling, that is, spooling on the master host, no special configuration is needed. However, the directory where the spooling occurs must not be on an NFS version 3 volume. You may use an NFS version 4 volume for local spooling.
• To run the Berkeley DB spooling server on a host other than the master host, you must install and configure RPC services on this separate host.

To perform this step manually before you start the automatic installation, use the following command:

./inst_sge -db

You can also use the following command to install automatically the Berkeley DB Spooling Server:

% ./inst_sge -db -m -x -auto <full-path-to-configuration-file>

This command checks the SPOOLING_SERVER entry within the configuration file and starts the Berkeley DB installation on the server host.

Note If you start the automatic installation on the master host, the entire cluster can be installed with one command. The automatic installation script accesses the remote hosts through rsh or ssh and starts the installation remotely. This process requires a well-configured configuration file, which each host must be able to read. That file should be installed on each host or shared through NFS.

Using the inst_sge Utility and a Configuration Template

To automate system installation, use the inst_sge utility in combination with a configuration file. See Configuration File Templates.

Note You cannot use the auto installation procedure to install remotely a Windows execution host. You must run the auto installation procedure directly on the Windows execution host.

How to Automate the Master Host Installation

Before You Begin

You need to complete the planning process as outlined in Planning the Installation.

In addition, you need to be able to connect to each of the remote hosts using the rsh or ssh commands, without supplying a password. If this type of access is not allowed on your network, you cannot use this method of installation.

Steps

1. Create a copy of the configuration template, $SGE_ROOT/util/install_modules/inst_template.conf.

   # cd $SGE_ROOT/util/install_modules
   # cp inst_template.conf my_configuration.conf
   

   
   

2. Edit your configuration template, using the values from the worksheet you completed in Planning the Installation.
   The configuration file template includes liberal comments to help you decide where appropriate information belongs. See Configuration File Templates.
   
   
3. Log in as root on the system that you want to be the Sun Grid Engine master host.
   
   
4. Create the $SGE_ROOT directory.
   The $SGE_ROOT directory is the root directory of the Sun Grid Engine software hierarchy, for example /opt/sge62.
   
   
5. Go to the $SGE_ROOT directory and start the installation.

   # cd $SGE_ROOT
   # ./inst_sge -m -auto <full-path-to-configuration-file>
   

The -m option starts the master host installation and installs the master daemon on the local machine. In addition, the -auto option sets up any remote hosts, as specified in the configuration file.

Note You cannot install remotely a master host. You must always install a master host locally.

To prevent data loss or destroying an already installed cluster, the automatic installation terminates if the configured $SGE_CELL directory or the configured Berkeley DB spooling directory already exists. If the installation terminates, the script displays the reason for the termination on the screen.

A log file of the master installation is created in the $SGE_ROOT/default/spool/qmaster directory. The file name is created using the format install_hostname_date_time.log.

Tip You can also combine options if you want to perform multiple installations with one command. For example, the following command installs the master daemon on the local machine and installs all execution hosts that are configured in the configuration file:

./inst_sge -m -x -auto <full-path-to-configuration-file>

a. Wait for notification that the installation has completed.

b. When the automatic installation exits successfully, it displays a message similar to the following:

The Install log can be found in the 
{{/opt/sge62/spool/install_myhost_30mar2007_090152.log}} file.

The installation log file includes any script or error messages that were generated during installation. If the qmaster_spooling_dir directory exists, the log files will be in that directory. If the directory does not exist, the log files will be in the /tmp directory.

Troubleshooting If you do not want your execution hosts to spool locally, be sure to set EXECD_SPOOL_DIR_LOCAL="", with no space between the double quotes ("").

Automating Other Installations Through a Configuration File

In addition to installing the master host, you can perform a variety of other automatic installations using a similar process. The actual form of the inst_sge command differs slightly, and different sections of the configuration file apply. This section provides some examples.

• To install a shadow host, use the following form of the command:

  inst_sge -sm -auto <full-path-to-configuration-file>
  

  Tip To install more than one shadow host, enter the host names in the <SHADOW_HOST> parameter section within the configuration file.

• You can install a separate execution host installation if the master host was installed without identified compute hosts or if you need to add additional compute hosts. For the execution host installation, you also need to have a configuration file.
  
  To install all configured execution hosts, use the following form of the command:

  inst_sge -x -auto <full-path-to-configuration-file>
  

• To install the Berkeley database server, use the following form of the command:

  inst_sge -db -auto <full-path-to-configuration-file>
  

See Configuration File Templates.

Automatic Installation With Increased Security (CSP)

The automatic installation also supports the Certificate Security Protocol (CSP) mode described in Installing the Increased Security Features. To use the CSP security mode, you must fill out the CSP parameters of the template files. The parameters are as follows:

# This section is used for csp installation mode.
# CSP_RECREATE recreates the certs on each installation, if true.
# In case of false, the certs will be created, if not existing.
# Existing certs won't be overwritten. (mandatory for csp install)
CSP_RECREATE="true"

# The created certs won't be copied, if this option is set to false
# If true, the script tries to copy the generated certs. This
# requires passwordless ssh/rsh access for user root to the
# execution hosts
CSP_COPY_CERTS="false"

# csp information, your country code (only 2 characters)
# (mandatory for csp install)
CSP_COUNTRY_CODE="DE"

# your state (mandatory for csp install)
CSP_STATE="Germany"

# your location, eg. the building (mandatory for csp install)
CSP_LOCATION="Building"

# your organisation (mandatory for csp install)
CSP_ORGA="Organisation"

# your organisation unit (mandatory for csp install)
CSP_ORGA_UNIT="Organisation_unit"

# your email (mandatory for csp install)
CSP_MAIL_ADDRESS="name@yourdomain.com"

To start the installation, type the following command:

inst_sge -m -csp -auto template-file-name

Note Certificates are created during the installation process. These certificates have to be copied to each host of the installed cluster. The installation process can do this for you; however, you need to perform the following steps to allow the installation process appropriate permissions to copy the certificates: Use rsh/rcp or ssh/scp on each host. Provide the root user with access to each host over ssh or rsh, without entering a password.

Automatic Uninstallation

You can also uninstall hosts automatically.

Note Uninstall all compute hosts before you uninstall the master host. If you uninstall the master host first, you have to uninstall all execution hosts manually.

To ensure that you have a clean environment, always source the $SGE_ROOT/$SGE_CELL/common/settings.csh file before proceeding.

Uninstalling Execution Hosts

During the execution host uninstallation, all configuration information for the targeted hosts is deleted. The uninstallation attempts to stop the exec hosts in a graceful manner.

First, the queue instances associated with the target host of the uninstallation will be disabled, so that new jobs will not be started. Then, in sequence, the following actions are done on each of the running jobs: checkpoint the job; reschedule the job; do forced rescheduling of the job.

At this point, the queue instance will be empty, and the execution daemon will be shut down, then the configuration, global spool directory or local spool directory will be removed.

The configuration file template has a section for identifying hosts that can be uninstalled automatically. Look for this section:

# Remove this execution hosts in automatic mode 
EXEC_HOST_LIST_RM="host1 host2 host3 host4"

Every host in the EXEC_HOST_LIST_RM list will be automatically removed from the cluster.

To start the automatic uninstallation of execution hosts, type the following command:

% ./inst_sge -ux -auto <full-path-to-configuration-file>

Uninstalling the Master Host

The master host uninstallation removes all of the Sun Grid Engine configuration files. After the uninstallation procedure completes, only the binary files remain. If you think that you will need the configuration information after the uninstallation, perform a backup of the master host. The master host uninstallation supports both interactive and automatic mode.

To start the automatic uninstallation of the master host, type the following command:

% ./inst_sge -um -auto <full-path-to-configuration-file>

This command performs the same procedure as in interactive mode, except the user is not prompted for confirmation of any steps and all terminal output is suppressed. Once the uninstall process is started, it cannot be stopped.

Uninstalling the Shadow Host

To start the automatic uninstallation of the shadow host, type the following command:

% ./inst_sge -usm -auto <full-path-to-configuration-file>

Automatic Backup

The automatic backup procedure backs up configuration and accounting data in much the same way as the interactive backup procedure. You can run the automatic backup procedure as a cron job if you want to schedule unattended or periodic backups. The automatic backup requires a configuration file, for which a template is located in the $SGE_ROOT/util/install_modules/backup_template.conf file.

Comments within the configuration file template indicate what values to use for your environment.

Starting an Automatic Backup

After you set up the configuration file, type the following command to start the automatic backup:

% ./inst_sge -bup -auto <full-path-to-configuration-file>

To prevent overwriting existing backup files, a date/time combination is added to the end of the backup directory name that is specified in the configuration file.

Example - Backup Configuration File

#--------------------------------------------------- 
# Autobackup Configuration File Template 
#--------------------------------------------------- 
# Please, enter your SGE_ROOT here (mandatory) 
SGE_ROOT="/opt/gridengine" 
# Please, enter your SGE_CELL here (mandatory) 
SGE_CELL="default" 
# Please, enter your Backup Directory here 
# After backup you will find your backup files here (mandatory) 
# The autobackup will add a time /date combination to this dirname 
# to prevent an overwriting! 
BACKUP_DIR="/opt/backups/ge_backup" 
# Please, enter true to get a tar/gz package 
# and false to copy the files only (mandatory) 
TAR="true" 
# Please, enter the backup file name here. (mandatory) 
BACKUP_FILE="backup.tar"

Troubleshooting Automatic Installation and Uninstallation

The following errors might be encountered during auto-installation:

If your network does not allow user root to have permissions to connect to other hosts through rsh or ssh without asking for a password, the automatic installation will not work remotely. In this case, log in to the host and use the following command to start the automatic installation locally on each host:

% ./inst_sge -x -noremote -auto /tmp/install_config_file.conf

Supplemental Information

• Configuration File Templates