install.config

About install.config

The install.config file contains options for LSF installation and configuration. Use lsfinstall -f install.config to install LSF using the options specified in install.config.

Template location

A template install.config is included in the installation script tar file lsf8_lsfinstall.tar.Z and is located in the lsf8_lsfinstall directory created when you uncompress and extract installation script tar file. Edit the file and uncomment the options you want in the template file. Replace the example values with your own settings to specify the options for your new installation.
Important:

The sample values in the install.config template file are examples only. They are not default installation values.

After installation, the install.config containing the options you specified is located in LSF_TOP/8/install/.

Format

Each entry in install.config has the form:
NAME="STRING1 STRING2 ..."

The equal sign = must follow each NAME even if no value follows and there should be no spaces around the equal sign.

A value that contains multiple strings separated by spaces must be enclosed in quotation marks.

Blank lines and lines starting with a pound sign (#) are ignored.

Parameters

  • EGO_DAEMON_CONTROL

  • ENABLE_DYNAMIC_HOSTS

  • ENABLE_EGO

  • ENABLE_HPC_CONFIG

  • EP_BACKUP

  • LSF_ADD_SERVERS

  • LSF_ADD_CLIENTS

  • LSF_ADMINS

  • LSF_CLUSTER_NAME

  • LSF_DYNAMIC_HOST_WAIT_TIME

  • LSF_LICENSE

  • LSF_MASTER_LIST

  • LSF_QUIET_INST

  • LSF_TARDIR

  • LSF_TOP

  • PATCH_BACKUP_DIR

  • PATCH_HISTORY_DIR

EGO_DAEMON_CONTROL

Syntax

EGO_DAEMON_CONTROL="Y" | "N"

Description

Enables EGO to control LSF res and sbatchd. Set the value to "Y" if you want EGO Service Controller to start res and sbatchd, and restart if they fail. To avoid conflicts, leave this parameter undefined if you use a script to start up LSF daemons.

Note:

If you specify EGO_ENABLE="N", this parameter is ignored.

Example

EGO_DAEMON_CONTROL="N"

Default

N (res and sbatchd are started manually)

ENABLE_DYNAMIC_HOSTS

Syntax

ENABLE_DYNAMIC_HOSTS="Y" | "N"

Description

Enables dynamically adding and removing hosts. Set the value to "Y" if you want to allow dynamically added hosts.

If you enable dynamic hosts, any host can connect to cluster. To enable security, configure LSF_HOST_ADDR_RANGE in lsf.cluster.cluster_name after installation and restrict the hosts that can connect to your cluster.

Example

ENABLE_DYNAMIC_HOSTS="N"

Default

N (dynamic hosts not allowed)

ENABLE_EGO

Syntax

ENABLE_EGO="Y" | "N"

Description

Enables Platform EGO functionality in the LSF cluster.

ENABLE_EGO="Y" causes lsfinstall uncomment LSF_EGO_ENVDIR and sets LSF_ENABLE_EGO="Y" in lsf.conf.

ENABLE_EGO="N" causes lsfinstall to comment out LSF_EGO_ENVDIR and sets LSF_ENABLE_EGO="N" in lsf.conf.

Set the value to "Y" if you want to take advantage of the following LSF features that depend on EGO:
  • LSF daemon control by EGO Service Controller

  • EGO-enabled SLA scheduling

Default

N (EGO is disabled in the LSF cluster)

ENABLE_HPC_CONFIG

Syntax

ENABLE_HPC_CONFIG="Y" | "N"

Description

Set the value to "Y" to enable LSF HPC features and add HPC configuration parameters to the cluster.

Default

N (HPC features are disabled.)

EP_BACKUP

Syntax

EP_BACKUP="Y" | "N"

Description

Enables backup and rollback for enhancement packs. Set the value to "N" to disable backups when installing enhancement packs (you will not be able to roll back to the previous patch level after installing an EP, but you will still be able to roll back any fixes installed on the new EP).

You may disable backups to speed up install time, to save disk space, or because you have your own methods to back up the cluster.

Default

Y (backup and rollback are fully enabled)

LSF_ADD_SERVERS

Syntax

LSF_ADD_SERVERS="host_name [ host_name...]"

Description

List of additional LSF server hosts.

The hosts in LSF_MASTER_LIST are always LSF servers. You can specify additional server hosts. Specify a list of host names two ways:
  • Host names separated by spaces

  • Name of a file containing a list of host names, one host per line.

Valid Values

Any valid LSF host name.

Example 1

List of host names:

LSF_ADD_SERVERS="hosta hostb hostc hostd"

Example 2

Host list file:

LSF_ADD_SERVERS=:lsf_server_hosts
The file lsf_server_hosts contains a list of hosts:
hosta
hostb
hostc
hostd

Default

Only hosts in LSF_MASTER_LIST are LSF servers.

LSF_ADD_CLIENTS

Syntax

LSF_ADD_CLIENTS="host_name [ host_name...]"

Description

List of LSF client-only hosts.
Tip:

After installation, you must manually edit lsf.cluster.cluster_name to include the host model and type of each client listed in LSF_ADD_CLIENTS.

Valid Values

Any valid LSF host name.

Example 1

List of host names:

LSF_ADD_CLIENTS="hoste hostf"

Example 2

Host list file:

LSF_ADD_CLIENTS=:lsf_client_hosts
The file lsf_client_hosts contains a list of hosts:
hoste
hostf

Default

No client hosts installed.

LSF_ADMINS

Syntax

LSF_ADMINS="user_name [ user_name ... ]"

Description

Required. List of LSF administrators.

The first user account name in the list is the primary LSF administrator. It cannot be the root user account.

Typically this account is named lsfadmin. It owns the LSF configuration files and log files for job events. It also has permission to reconfigure LSF and to control batch jobs submitted by other users. It typically does not have authority to start LSF daemons. Usually, only root has permission to start LSF daemons.

All the LSF administrator accounts must exist on all hosts in the cluster before you install LSF. Secondary LSF administrators are optional.
CAUTION:

You should not configure the root account as the primary LSF administrator.

Valid Values

Existing user accounts

Example

LSF_ADMINS="lsfadmin user1 user2"

Default

None—required variable

LSF_CLUSTER_NAME

Syntax

LSF_CLUSTER_NAME="cluster_name"

Description

Required. The name of the LSF cluster.

Example

LSF_CLUSTER_NAME="cluster1"

Valid Values

Any alphanumeric string containing no more than 39 characters. The name cannot contain white spaces.
Important:

Do not use the name of any host, user, or user group as the name of your cluster.

Default

None—required variable

LSF_DYNAMIC_HOST_WAIT_TIME

Syntax

LSF_DYNAMIC_HOST_WAIT_TIME=seconds

Description

Time in seconds slave LIM waits after startup before calling master LIM to add the slave host dynamically.

This parameter only takes effect if you set ENABLE_DYNAMIC_HOSTS="Y" in this file. If the slave LIM receives the master announcement while it is waiting, it does not call the master LIM to add itself.

Recommended value

Up to 60 seconds for every 1000 hosts in the cluster, for a maximum of 15 minutes. Selecting a smaller value will result in a quicker response time for new hosts at the expense of an increased load on the master LIM.

Example

LSF_DYNAMIC_HOST_WAIT_TIME=60

Hosts will wait 60 seconds from startup to receive an acknowledgement from the master LIM. If it does not receive the acknowledgement within the 60 seconds, it will send a request for the master LIM to add it to the cluster.

Default

Slave LIM waits forever

LSF_LICENSE

Syntax

LSF_LICENSE="/path/license_file"

Description

Full path to the name of the LSF license file, license.dat.

You must have a valid license file to install LSF.
CAUTION:

If you do not specify LSF_LICENSE, or lsfinstall cannot find a valid license file in the default location, lsfinstall exits.

Example

LSF_LICENSE="/usr/share/lsf_distrib/license.dat"

Default

The parent directory of the current working directory. For example, if lsfinstall is running under usr/share/lsf_distrib/lsf_lsfinstall the LSF_LICENSE default value is usr/share/lsf_distrib/license.dat.

LSF_MASTER_LIST

Syntax

LSF_MASTER_LIST="host_name [ host_name ...]"

Description

Required for a first-time installation. List of LSF server hosts to be master or master candidates in the cluster.

You must specify at least one valid server host to start the cluster. The first host listed is the LSF master host.

During upgrade, specify the existing value.

Valid Values

LSF server host names

Example

LSF_MASTER_LIST="hosta hostb hostc hostd"

Default

None — required variable

LSF_QUIET_INST

Syntax

LSF_QUIET_INST="Y" | "N"

Description

Enables quiet installation.

Set the value to Y if you want to hide the LSF installation messages.

Example

LSF_QUIET_INST="Y"

Default

N (installer displays messages during installation)

LSF_TARDIR

Syntax

LSF_TARDIR="/path"

Description

Full path to the directory containing the LSF distribution tar files.

Example

LSF_TARDIR="/usr/share/lsf_distrib"

Default

The parent directory of the current working directory. For example, if lsfinstall is running under usr/share/lsf_distrib/lsf_lsfinstall the LSF_TARDIR default value is usr/share/lsf_distrib.

LSF_TOP

Syntax

LSF_TOP="/path"

Description

Required. Full path to the top-level LSF installation directory.

Valid Value

The path to LSF_TOP must be shared and accessible to all hosts in the cluster. It cannot be the root directory (/). The file system containing LSF_TOP must have enough disk space for all host types (approximately 300 MB per host type).

Example

LSF_TOP="/usr/share/lsf"

Default

None — required variable

PATCH_BACKUP_DIR

Syntax

PATCH_BACKUP_DIR="/path"

Description

Full path to the patch backup directory. This parameter is used when you install a new cluster for the first time, and is ignored for all other cases.

The file system containing the patch backup directory must have sufficient disk space to back up your files (approximately 400 MB per binary type if you want to be able to install and roll back one enhancement pack and a few additional fixes). It cannot be the root directory (/).

If the directory already exists, it must be writable by the cluster administrator (lsfadmin).

If you need to change the directory after installation, edit PATCH_BACKUP_DIR in LSF_TOP/patch.conf and move the saved backup files to the new directory manually.

Example

PATCH_BACKUP_DIR="/usr/share/lsf/patch/backup"

Default

LSF_TOP/patch/backup

PATCH_HISTORY_DIR

Syntax

PATCH_HISTORY_DIR="/path"

Description

Full path to the patch history directory. This parameter is used when you install a new cluster for the first time, and is ignored for all other cases.

It cannot be the root directory (/). If the directory already exists, it must be writable by lsfadmin.

The location is saved as PATCH_HISTORY_DIR in LSF_TOP/patch.conf. Do not change the directory after installation.

Example

PATCH_BACKUP_DIR="/usr/share/lsf/patch"

Default

LSF_TOP/patch