slave.config

About slave.config

Dynamically added LSF hosts that will not be master candidates are slave hosts. Each dynamic slave host has its own LSF binaries and local lsf.conf and shell environment scripts (cshrc.lsf and profile.lsf). You must install LSF on each slave host.

The slave.config file contains options for installing and configuring a slave host that can be dynamically added or removed.

Use lsfinstall -s -f slave.config to install LSF using the options specified in slave.config.

Template location

A template slave.config is located in the installation script directory created when you 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 LSF installation.

Important:

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

Format

Each entry in slave.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_EGO
EP_BACKUP
LSF_ADMINS
LSF_ENTITLEMENT_FILE
LSF_LIM_PORT
LSF_SERVER_HOSTS
LSF_TARDIR
LSF_LOCAL_RESOURCES
LSF_TOP
SILENT_INSTALL
LSF_SILENT_INSTALL_TARLIST

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.

All hosts in the cluster must use the same value for this parameter (this means the value of EGO_DAEMON_CONTROL in this file must be the same as the specification for EGO_DAEMON_CONTROL in install.config).

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_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)

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_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.

Valid Values

Existing user accounts

Example

LSF_ADMINS="lsfadmin user1 user2"

Default

None—required variable

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. 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_LIM_PORT

Syntax

LSF_LIM_PORT="port_number"

Description

TCP service port for slave host.

Use the same port number as LSF_LIM_PORT in lsf.conf on the master host.

Default

7869

LSF_SERVER_HOSTS

Syntax

LSF_SERVER_HOSTS="host_name [ host_name ...]"

Description

Required for non-shared slave host installation. This parameter defines a list of hosts that can provide host and load information to client hosts. If you do not define this parameter, clients will contact the master LIM for host and load information. List of LSF server hosts in the cluster to be contacted.

Recommended for large clusters to decrease the load on the master LIM. Do not specify the master host in the list. Client commands will query the LIMs on the LSF_SERVER_HOSTS, which off-loads traffic from the master LIM.

Define this parameter to ensure that commands execute successfully when no LIM is running on the local host, or when the local LIM has just started.

You should include the list of hosts defined in LSF_MASTER_LIST in lsf.conf; specify the primary master host last. For example:

LSF_MASTER_LIST="lsfmaster hostE"

LSF_SERVER_HOSTS="hostB hostC hostD hostE lsfmaster"

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

Examples

List of host names:

LSF_SERVER_HOSTS="hosta hostb hostc hostd"

Host list file:

LSF_SERVER_HOSTS=:lsf_server_hosts

The file lsf_server_hosts contains a list of hosts:

hosta hostb hostc hostd

Default

None

LSF_TARDIR

Syntax

LSF_TARDIR="/path"

Description

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

Example

LSF_TARDIR="/usr/local/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_LOCAL_RESOURCES

Syntax

LSF_LOCAL_RESOURCES="resource ..."

Description

Defines instances of local resources residing on the slave host.

For numeric resources, define name-value pairs:
```
"[resourcemap value*resource_name]"
```
For Boolean resources, define the resource name in the form:
```
"[resource resource_name]"
```

When the slave host calls the master host to add itself, it also reports its local resources. The local resources to be added must be defined in lsf.shared.

If the same resource is already defined in lsf.shared as default or all, it cannot be added as a local resource. The shared resource overrides the local one.

Tip:

LSF_LOCAL_RESOURCES is usually set in the slave.config file during installation. If LSF_LOCAL_RESOURCES are already defined in a local lsf.conf on the slave host, lsfinstall does not add resources you define in LSF_LOCAL_RESOURCES in slave.config. You should not have duplicate LSF_LOCAL_RESOURCES entries in lsf.conf. If local resources are defined more than once, only the last definition is valid.

Important:

Resources must already be mapped to hosts in the ResourceMap section of lsf.cluster.cluster_name. If the ResourceMap section does not exist, local resources are not added.

Example

LSF_LOCAL_RESOURCES="[resourcemap 1*verilog] [resource linux]"

Default

None

LSF_TOP

Syntax

LSF_TOP="/path"

Description

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

Important:

You must use the same path for every slave host you install.

Valid value

The path to LSF_TOP cannot be the root directory (/).

Example

LSF_TOP="/usr/local/lsf"

Default

None—required variable

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.

Default

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