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 installer script package lsf9.1_lsfinstall.tar.Z and is located in the lsf9.1_lsfinstall directory created when you uncompress and extract the installer script package. 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>/9.1/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

CONFIGURATION_TEMPLATE
EGO_DAEMON_CONTROL
ENABLE_DYNAMIC_HOSTS
ENABLE_EGO
ENABLE_STREAM
LSF_ADD_SERVERS
LSF_ADD_CLIENTS
LSF_ADMINS
LSF_CLUSTER_NAME
LSF_DYNAMIC_HOST_WAIT_TIME
LSF_ENTITLEMENT_FILE
LSF_MASTER_LIST
LSF_QUIET_INST
LSF_SILENT_INSTALL_TARLIST
LSF_TARDIR
LSF_TOP
PATCH_BACKUP_DIR
PATCH_HISTORY_DIR
SILENT_INSTALL

CONFIGURATION_TEMPLATE

Syntax

CONFIGURATION_TEMPLATE="DEFAULT" | "PARALLEL" | "HIGH_THROUGHPUT"

Description

LSF Standard Edition on UNIX or Linux only. Selects the configuration template for this installation, which determines the initial LSF configuration parameters specified when the installation is complete. The following are valid values for this parameter:

DEFAULT: This template should be used for clusters with mixed workload. This configuration can serve different types of workload with good performance, but is not specifically tuned for a particular type of cluster.
PARALLEL: This template provides extra support for large parallel jobs. This configuration is designed for long running parallel jobs, and should not be used for clusters that mainly run short jobs due to the longer reporting time for each job.
HIGH_THROUGHPUT: This template is designed to be used for clusters that mainly run short jobs, where over 80% of jobs finish within one minute. This high turnover rate requires LSF to be more responsive and fast acting. However, this configuration will consume more resources as the daemons become busier.

The installer uses the DEFAULT configuration template when installing LSF Standard Edition on Windows.

Note: Do not specify CONFIGURATION_TEMPLATE for LSF Express Edition and Advanced Edition. These editions have their own default configuration templates for all installations.

The installer specifies the following initial configuration file parameter values based on the selected configuration template:

DEFAULT

lsf.conf:

DAEMON_SHUTDOWN_DELAY=180
LSF_LINUX_CGROUP_ACCT=Y
LSF_PROCESS_TRACKING=Y

lsb.params:

JOB_DEP_LAST_SUB=1
JOB_SCHEDULING_INTERVAL=1
MAX_JOB_NUM=10000
NEWJOB_REFRESH=Y
SBD_SLEEP_TIME=7

PARALLEL

lsf.conf:

LSB_SHORT_HOSTLIST=1
LSF_LINUX_CGROUP_ACCT=Y
LSF_PROCESS_TRACKING=Y
LSF_ENABLE_EXTSCHEDULER=Y
LSF_HPC_EXTENSIONS="CUMULATIVE_RUSAGE LSB_HCLOSE_BY_RES SHORT_EVENTFILE"

Refer to the Enable LSF HPC Features section for a full description.

lsb.params:

JOB_DEP_LAST_SUB=1
JOB_SCHEDULING_INTERVAL=1
NEWJOB_REFRESH=Y

HIGH_THROUGHPUT

lsf.conf:

LSB_MAX_PACK_JOBS=300
LSB_SHORT_HOSTLIST=1

lsb.params:

CONDENSE_PENDING_REASONS=Y
JOB_SCHEDULING_INTERVAL=50ms
MAX_INFO_DIRS=500
MAX_JOB_ARRAY_SIZE=10000
MAX_JOB_NUM=100000
MIN_SWITCH_PERIOD=1800
NEWJOB_REFRESH=Y
PEND_REASON_UPDATE_INTERVAL=60
SBD_SLEEP_TIME=3

The installer specifies the following initial configuration parameters for all configuration templates:

lsf.conf:

EGO_ENABLE_AUTO_DAEMON_SHUTDOWN=Y
LSB_DISABLE_LIMLOCK_EXCL=Y
LSB_MOD_ALL_JOBS=Y
LSF_DISABLE_LSRUN=Y
LSB_SUBK_SHOW_EXEC_HOST=Y
LSF_PIM_LINUX_ENHANCE=Y
LSF_PIM_SLEEPTIME_UPDATE=Y
LSF_STRICT_RESREQ
LSF_UNIT_FOR_LIMITS=MB

lsb.params:

ABS_RUNLIMIT=Y
DEFAULT_QUEUE=normal interactive
JOB_ACCEPT_INTERVAL=0
MAX_CONCURRENT_JOB_QUERY=100
MBD_SLEEP_TIME=10
PARALLEL_SCHED_BY_SLOT=Y

In addition, the installer enables the following features for all configuration templates:

Fairshare scheduling (LSF Standard Edition and Advanced Edition): All queues except admin and license have fairshare scheduling enabled as follows in lsb.queues:
```
Begin Queue
...
FAIRSHARE=USER_SHARES[[default, 1]]
...
End Queue
```
Host groups (LSF Standard Edition on UNIX or Linux): Master candidate hosts are assigned to the master_hosts host group.
User groups (LSF Standard Edition on UNIX or Linux): LSF administrators are assigned to the lsfadmins user group.
Affinity scheduling in both lsb.modules and lsb.hosts.

Example

CONFIGURATION_TEMPLATE="HIGH_THROUGHPUT"

Default

DEFAULT (the default configuration template is used)

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 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_STREAM

Syntax

ENABLE_STREAM="Y" | "N"

Description

Enables LSF event streaming.

Enable LSF event streaming if you intend to install IBM Platform Analytics or IBM Platform Application Cluster.

Default

N (Event streaming is disabled)

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_ENTITLEMENT_FILE

Syntax

LSF_ENTITLEMENT_FILE=path

Description

Full path to the LSF entitlement file. LSF uses the entitlement to determine which feature set to be enable or disable based on the edition of the product. The entitlement file for LSF Standard Edition is platform_lsf_std_entitlement.dat. For LSF Express Edition, the file is platform_lsf_exp_entitlement.dat. For LSF Advanced Edition, the file is platform_lsf_adv_entitlement.dat. The entitlement file is installed as <LSF_TOP>/conf/lsf.entitlement.

You must download the entitlement file for the edition of the product you are running, and set LSF_ENTITLEMENT_FILE to the full path to the entitlement file you downloaded.

Once LSF is installed and running, run the lsid command to see which edition of LSF is enabled.

Example

LSF_ENTITLEMENT_FILE=/usr/share/lsf_distrib/lsf.entitlement

Default

None — required variable

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_SILENT_INSTALL_TARLIST

Syntax

LSF_SILENT_INSTALL_TARLIST="ALL" | "Package_Name ..."

Description

A string which contains all LSF package names to be installed. This name list only applies to the silent install mode. Supports keywords ?all?, ?ALL? and ?All? which can install all packages in LSF_TARDIR.

LSF_SILENT_INSTALL_TARLIST="ALL" | "lsf9.1.2_linux2.6-glibc2.3-x86_64.tar.Z"

Default

None

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

SILENT_INSTALL

Syntax

SILENT_INSTALL="Y" | "N"

Description

Enabling the silent installation (setting this parameter to Y) means you want to do the silent installation and accept the license agreement.