install.config

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

Template location

A template install.config is included in the installer script package lsf<version>_lsfinstall.tar.Z and is located in the lsf<version>_lsfinstall directory that is created when you decompress and extract the installer script package. Edit the file and uncomment the options that 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 file that contains the options that you specified is located in the LSF_TOP/<version>/install/ directory.

Format

Each entry in the install.config file has the following format:
NAME="STRING1 STRING2 ..."

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

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

Blank lines and lines that start with a number sign (#) are ignored.

Parameters

  • CONFIGURATION_TEMPLATE
  • EGO_DAEMON_CONTROL
  • ENABLE_CGROUP
  • 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 that are specified when the installation is complete. The following are valid values for this parameter:

DEFAULT
Use this template for clusters with mixed workload. This configuration can serve different types of workload with good performance, but is not tuned for a particular type of cluster.
PARALLEL
This template provides extra support for large parallel jobs. Since this configuration is designed for long running parallel jobs, do not use this configuration for clusters that mainly run short jobs due to the longer reporting time for each job.
HIGH_THROUGHPUT
This template is 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 uses 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 the CONFIGURATION_TEMPLATE parameter for LSF Express Edition and LSF 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"

    For a full description of the PARALLEL configuration template, refer to Enable LSF HPC Features.

    lsb.params
    JOB_DEP_LAST_SUB=1
JOB_SCHEDULING_INTERVAL=1
NEWJOB_REFRESH=Y
TRACK_ELIGIBLE_PENDINFO=Y
  • HIGH_THROUGHPUT
    lsf.conf
    LSB_MAX_PACK_JOBS=300
LSB_SHORT_HOSTLIST=1
    lsb.params
    JOB_SCHEDULING_INTERVAL=50ms
MAX_INFO_DIRS=500
MAX_JOB_ARRAY_SIZE=10000
MAX_JOB_NUM=100000
MIN_SWITCH_PERIOD=1800
NEWJOB_REFRESH=YSBD_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_UNIT_FOR_LIMITS=MB
  • lsb.params:
    ABS_RUNLIMIT=Y
DEFAULT_QUEUE=normal interactive
JOB_ACCEPT_INTERVAL=0
MAX_CONCURRENT_QUERY=100
MAX_JOB_NUM=10000
MBD_SLEEP_TIME=10
PARALLEL_SCHED_BY_SLOT=Y
RELAX_JOB_DISPATCH_ORDER=Y
In addition, the installer enables the following features for all configuration templates:
  • Fair share scheduling (LSF Standard Edition and LSF Advanced Edition): The following example for the lsb.queues file enables fair share scheduling for all queues except admin and license:
    Begin Queue
...
FAIRSHARE=USER_SHARES[[default, 1]]
...
End Queue
  • Host groups (LSF Standard Edition on UNIX or Linux): Management candidate hosts are assigned to the management_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 the lsb.modules and lsb.hosts files.

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 the LSF res and sbatchd daemons. Set the value to "Y" if you want the EGO service controller to start the res and sbatchd daemons, and restart if they fail. To avoid conflicts, leave this parameter undefined if you use a script to start LSF daemons.

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

Example

EGO_DAEMON_CONTROL="N"

Default

N (the res and sbatchd are started manually)

ENABLE_CGROUP

Syntax

ENABLE_CGROUP=Y | N

Description

Enables LSF to track processes' CPU and memory accounting based on Linux cgroup memory and cpuacct subsystems.

Set the value to Y if you want to use Linux cgroup to track process accounting. The installer sets the following initial configuration file parameter values in the lsf.conf file:
LSB_RESOURCE_ENFORCE="cpu memory"
LSF_PROCESS_TRACKING=Y
LSF_LINUX_CGROUP_ACCT=Y

Example

ENABLE_CGROUP=Y

Default

N (do not use Linux cgroup to track process accounting)

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 the LSF_HOST_ADDR_RANGE parameter in the lsf.cluster.cluster_name file 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 functions in the LSF cluster.

ENABLE_EGO="Y" causes the lsfinstall command to uncomment the LSF_EGO_ENVDIR parameter and sets the LSF_ENABLE_EGO="Y" parameter in the lsf.conf file.

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

Set the value to ENABLE_EGO="Y" if you want to take advantage of the following LSF features that depend on EGO:
  • LSF daemon control by EGO service controller
  • SLA scheduling with EGO enabled

Default

N (EGO is disabled in the LSF cluster)

ENABLE_GPU

Syntax

ENABLE_GPU=Y | N

Description

Enables LSF to support GPUs so that applications can use GPU resources in a Linux environment. LSF supports parallel jobs that require GPUs based on availability.

Set the value to Y if you want to run parallel jobs that request GPU resources in Linux environments. The installer sets the following initial configuration file parameter values in the following configuration files:
  • lsf.conf:
    LSB_RESOURCE_ENFORCE="gpu"
  • lsf.cluster.cluster_name:
    Begin ResourceMap
  RESOURCENAME      LOCATION
  ngpus             ([default])
  ngpus_shared      ([default])
  ngpus_excl_t      ([default])
  ngpus_excl_p      ([default])
  ...
  gpu_topology      ([default])
End ResourceMap

    There are also several resources that are added to the file, but are commented out by default. The resources that are commented out are not shown here.

  • lsf.shared:
    Begin Resource
RESOURCENAME  TYPE    INTERVAL INCREASING  CONSUMABLE  DESCRIPTION            # Keywords   
   ngpus             Numeric         60     N           N           (Number of GPUs)
   ngpus_shared      Numeric         60     N           Y           (Number of GPUs in Shared Mode)
   ngpus_excl_t      Numeric         60     N           Y           (Number of GPUs in Exclusive  Thread Mode)
   ngpus_excl_p      Numeric         60     N           Y           (Number of GPUs in Exclusive  Process Mode)
   ...
   gpu_topology      String          60     ()          ()          (GPU topology on host)
End Resource

    There are also several resources that are added to the file, but are commented out by default. The resources that are commented out are not shown here.

Example

ENABLE_GPU=Y

Default

N (do not support GPUs)

ENABLE_STREAM

Syntax

ENABLE_STREAM="Y" | "N"

Description

Enables LSF event streaming.

Enable LSF event streaming if you intend to install IBM Spectrum LSF Analytics or IBM Spectrum LSF Application Center.

Default

N (Event streaming is disabled)

LSF_ADD_SERVERS

Syntax

LSF_ADD_SERVERS="host_name [host_name...]"

Description

List of extra LSF server hosts.

The hosts in the LSF_MASTER_LIST parameter are always LSF server hosts. Use the LSF_ADD_SERVERS parameter to specify extra server hosts. Specify a list of host names two ways:
  • Host names that are separated by spaces
  • The name of a file that contains 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 lsf_server_hosts file contains a list of hosts:
hosta
hostb
hostc
hostd

Default

Only hosts in the LSF_MASTER_LIST parameter are LSF server hosts.

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 the lsf.cluster.cluster_name file to include the host model and type of each client that is listed in the LSF_ADD_CLIENTS parameter.

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 lsf_client_hosts file 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. This user name cannot be the root user account.

Typically, this account is named lsfadmin. This account owns the LSF configuration files and log files for job events. This account also has permission to reconfigure LSF and to control batch jobs that are submitted by other users. The primary LSF administrator 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 cannot configure the root account as the primary LSF administrator.

Valid values

Existing user accounts

Example

LSF_ADMINS="lsfadmin user1 user2"

Default

None. This is a 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 that contains 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. This is a required variable.

LSF_DYNAMIC_HOST_WAIT_TIME

Syntax

LSF_DYNAMIC_HOST_WAIT_TIME=seconds

Description

Time in seconds that the server host LIM waits after startup before it calls the management host LIM to dynamically add the server host.

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

Specify a 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 management host LIM.

Example

LSF_DYNAMIC_HOST_WAIT_TIME=60

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

Default

Server host 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 enable or disable based on the edition of the product. The entitlement file for LSF Standard Edition is lsf_std_entitlement.dat. For LSF Express Edition, the file is lsf_exp_entitlement.dat. For LSF Advanced Edition, the file is 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 the LSF_ENTITLEMENT_FILE parameter to the full path to the entitlement file you downloaded.

After 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. This is a 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 management or management candidates in the cluster.

You must specify at least one valid server host to start the cluster. The first host that is listed is the LSF management 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 that contains all LSF package names to be installed. This name list applies only to the silent installation mode. Supports keywords all, ALL, and All, which can install all packages in the directory that is specified by the LSF_TARDIR parameter.

Example

LSF_SILENT_INSTALL_TARLIST="ALL" | "lsf<version>_linux2.6-glibc2.3-x86_64.tar.Z"

Default

None

LSF_TARDIR

Syntax

LSF_TARDIR="/path"

Description

Full path to the directory that contains the LSF distribution TAR files.

Example

LSF_TARDIR="/usr/share/lsf_distrib"

Default

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

LSF_TOP

Syntax

LSF_TOP="/path"

Description

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

Valid values

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

Example

LSF_TOP="/usr/share/lsf"

Default

None. This is a 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 that contains the patch backup directory must have sufficient disk space to back up your files, which is approximately 400 MB per binary type if you want to be able to install and roll back one enhancement pack and a few more fixes. It cannot be the root directory (/).

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

If you need to change the directory after installation, edit the PATCH_BACKUP_DIR parameter in the LSF_TOP/patch.conf directory 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 exists, it must be writable by lsfadmin.

The location is saved as the PATCH_HISTORY_DIR parameter in the LSF_TOP/patch.conf directory. 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 that you want to do the silent installation and accept the license agreement.

Default

N