ego.conf

The ego.conf file contains the configuration information for the Symphony cluster. The configuration file is also used to connect to a Symphony cluster from a client machine that is not part of the cluster.

Location

This file is installed with Symphony and is located in %SOAM_HOME%\conf\ on Windows, and in $SOAM_HOME/conf/ on Linux.

Structure

You cannot change the file name ego.conf.

Note:

To connect to multiple clusters from the same client machine, configure different ego.conf files and rename them to ego.conf when you need to use them.

Parameters

EGO_ADJUST_SHARE_TO_WORKLOAD

Syntax

EGO_ADJUST_SHARE_TO_WORKLOAD=Y | N

Description

Specifies how resoureces are reclaimed and distributed.

Valid values

Specify one of the following:
Y

Specifies that share ratio is to always be honored when two or more consumers are competing for resources. Whenever consumers compete for resources, resources are reclaimed and distributed in proportion to share ratio. Workload among all consumers is taken into account and resource distribution is adjusted according to workload.

N

When set to n or undefined, resources are distributed according to configured share ratio but resource distribution/reclaim is not adjusted according to workload. When two consumers compete for resources, consumers that have not received up to their share ratio can only reclaim resources up to their share ratio. When consumers have reached their share ratio, distribution of additional resources to consumers is done in First-Come, First-Served order.

EGO_AUDIT_LOG_INHERIT_PERMISSION (Windows only)

Syntax

EGO_AUDIT_LOG_INHERIT_PERMISSION=Y | N

Description

Specifies that all files in the audits directory will inherit the permission from the parent (audits directory).

Valid values

Specify one of the following:
Y

Specifies that file permission is inherited from the parent directory.

N

Specifies that file permission is not inherited from the parent directory.

EGO_CHAN_KEEPALIVE_TIME

Syntax

EGO_CHAN_KEEPALIVE_TIME=Y | N

Description

Controls how long the TCP connection between management hosts and compute hosts can remain idle (no traffic) before TCP sends a Keep-Alive message.

Valid values

Specify a numeric value of 180 seconds or more.

EGO_DATA_MAXSIZE

Syntax

EGO_DATA_MAXSIZE=file_size_in_Mbytes

Description

Limits the maximum size of the allocation event data file (named ego.stream by default) where the event logger stores event data. When a data file exceeds this size, the events logger archives the file and creates a new data file. The events logger maintains one archive file and overwrites the old archive with the new archive.

If your system logs a large number of events, you should increase the maximum file size to see more archived event data. If your disk space is insufficient for storing these files, you should decrease the maximum file size, or change the file path to a location with sufficient storage space.

For a production cluster, the average data file switch time, i.e., the time it takes the data file to reach its maximum size and switch to the archive, should be greater than 3 minutes. If the switch time is too frequent, increase the file size. Note that the file size also impacts the data file writing speed so if the file is too large, writing speed will slow down.

Valid values

positive integer

Default

10 Mbytes

EGO_DEFINE_NCPUS

Syntax

EGO_DEFINE_NCPUS=procs | cores | threads

Description

If defined, enables an administrator to define a value other than the number of cores available. Follow one of the three equations below for an accurate value.

  • EGO_DEFINE_NCPUS=procs-ncpus=number of processors

  • EGO_DEFINE_NCPUS=cores-ncpus=number of processors x number of cores

  • EGO_DEFINE_NCPUS=threads-ncpus=number of processors x number of cores x number of threads.

Default

EGO_DEFINE_NCPUS=cores

EGO_DISCIPLINE_TIMEOUT

Syntax

EGO_DISCIPLINE_TIMEOUT=time_in_seconds

Description

Adds time to all grace periods in seconds. A grace period is the time the system waits before reclaiming resources from a borrowing consumer when a lending consumer requests them back. This time period allows any running work to finish running before the resource is reclaimed.

This parameter adds time to any grace period, cluster wide. All consumers have a grace period. The grace period’s default is 120 seconds.

Default

EGO_DISCIPLINE_TIMEOUT=120

EGO_DISTRIBUTION_INTERVAL

Syntax

EGO_DISTRIBUTION_INTERVAL=time_in_seconds

Description

Specifies intervals after which EGO will allocate resources. Requests are queued until the next distribution interval end is reached.

Default

EGO_DISTRIBUTION_INTERVAL=0, EGO will allocate resources as requests for them are made.

EGO_DYNAMIC_HOST_TIMEOUT

Syntax

EGO_DYNAMIC_HOST_TIMEOUT= time_hours | time_minutes

Description

Enables automatic removal of dynamic hosts from the cluster and specifies the timeout value (minimum 10 minutes). To improve performance in very large clusters, you should disable this feature and remove unwanted hosts from the host cache file manually.

Specifies the length of time the system waits for a dynamic host that is unavailable before the master host removes it from the cluster.

Default

Not defined. Unavailable hosts are never removed from the cluster.

Example

EGO_DYNAMIC_HOST_TIMEOUT=60

A dynamic host is removed from the cluster when it is unavailable for 60 hours.

EGO_DYNAMIC_HOST_TIMEOUT=60m

A dynamic host is removed from the cluster when it is unavailable for 60 minutes.

EGO_DYNAMIC HOST_WAIT_TIME

Syntax

EGO_DYNAMIC_HOST_WAIT_TIME= wait_time | first_wait_time,subsequent_wait_time

Description

When LIM starts on a host, if the master host already recognizes the host (for example, a static host or a dynamic host that had previously started and joined the cluster), it does not need to send a join request to the master LIM. The master LIM sends acknowledgement signals to all hosts that the master host already recognizes.

If LIM does not receive acknowledgement from the master, it will send the join request and wait for the EGO_DYNAMIC_HOST_WAIT_TIME for the acknowledgement again. Therefore, EGO_DYNAMIC_HOST_WAIT_TIME is the interval, in seconds, that the compute host waits for the master LIM acknowledgement so that it can join the cluster.

Once the acknowledgement signal is received, LIM on the compute host will start all other processes such as PEM, ELIM, etc, on the host. If there is no acknowledgement from the master LIM after 20 tries, the local LIM exits, i.e., the cluster join operation fails.

There are two ways to express EGO_DYNAMIC_HOST_WAIT_TIME. You can specify a value that applies to all attempts to join the cluster or you can specify two intervals for EGO_DYNAMIC_HOST_WAIT_TIME. The first interval applies to the first attempt (of the 20 attempts) and the second interval applies to each of the subsequent attempts.

Valid values

positive integer

Default

60 seconds

EGO_ENABLE_BASE_QUOTA

Syntax

EGO_ENABLE_BASE_QUOTA=Y | N

Description

Minimizes the number of reclaims that can occur when consumers are overusing resources from multiple resource groups.

Important:

For this feature to work, you must also enable EGO_ADJUST_SHARE_TO_WORKLOAD in ego.conf.

Valid values

Specify one of the following:
Y

Specifies that resources will be allocated to consumers according to their static share quota from each resource group first, followed by resources allocated according to the order of resource groups defined in ConsumerTrees.xml.

N

Disables this feature.

Default

N (not enabled).

EGO_ENABLE_CHAN_KEEPALIVE

Syntax

EGO_ENABLE_CHAN_KEEPALIVE=Y | N

Description

Determines whether firewall support is enabled between the management hosts and compute hosts. Enabling this feature allows periodic TCP Keep-Alive messages to pass between VEMKD on the management hosts and PEM on the compute hosts.

Restriction:

This parameter is not supported on Solaris management hosts.

Valid values

Specify one of the following:
Y

Enables TCP Keep-Alive messages to pass between management and compute hosts.

N

Disables firewall support.

Default

If the parameter is not set, firewall support is disabled.

EGO_HOST_COMMENT_ENFORCE

Syntax

EGO_HOST_COMMENT_ENFORCE=Y | N

Description

Determines whether a comment is required when requesting to close a host through PMC or CLI.

Valid values

Specify one of the following:
Y

Specifies that a comment is required for the close host operation to succeed.

N

Specifies that a comment is not required for the close host operation.

Default

If the parameter is not set, the comment is not required.

EGO_KD_CLIENT_PORT_RANGE

Syntax

EGO_KD_CLIENT_PORT_RANGE=port_number1,port_number2

Description

EGO tries to bind a local port number in the configured range when it works as a client. If there is no available port in the range, EGO uses a random port number allocated by the OS.

Valid values

port_number1 must be greater than 1024 and port_number2 must be greater than port_number1.

EGO_KD_PORT

Syntax

EGO_KD_PORT=port_number

Description

Specifies the port number to use to connect to the Symphony cluster.

Valid values

The port number must exactly match the port number specified in the master ego.conf in the cluster.

Default

If the port is not specified, it defaults to 7870.

EGO_MASTER_LIST

Syntax

EGO_MASTER_LIST="master_candidate1 master_candidate2 . . ."

Description

Specifies the hosts that are master host candidates in the cluster to which you want to connect.

Valid values

The host names indicated here must exactly match the host names specified in the master ego.conf, accessible from the master host under %EGO_CONFDIR% on Windows and $EGO_CONFDIR on Linux.

Specify a list of hosts separated by spaces.

EGO_PARENT_QUOTA

Syntax

EGO_PARENT_QUOTA=Y | N

Description

Modifies the allocation and reclaim behavior of consumers so that, when a child consumer releases its allocation to the free pool, any of its siblings that have a demand for resources gets them before other consumers do.

Default

EGO_PARENT_QUOTA=N

EGO_SEC_PLUGIN

Syntax

EGO_SEC_PLUGIN=sec_ego_default | external_plugin

Description

Specifies the security mechanism to use when connecting to the Symphony cluster.

Valid values

The value must exactly match the value specified in the actual ego.conf in the cluster. Specify one of the following:
sec_ego_default

Specifies to use the default authentication.

external_plugin

Specifies to use an external, third-party authentication.

Example

EGO_MASTER_LIST="hosta hostc hostd"
EGO_KD_PORT=7870
EGO_SEC_PLUGIN=sec_ego_default

EGO_STRIP_DOMAIN

Syntax

EGO_STRIP_DOMAIN=domain_suffix[:domain_suffix ...]

Description

(Optional) If all of the hosts in your cluster can be reached using short host names, you can configure EGO to use the short host names by specifying the portion of the domain name to remove. If your hosts are in more than one domain or have more than one domain name, you can specify more than one domain suffix to remove, separated by a colon (:).

For example, given this definition of EGO_STRIP_DOMAIN,
EGO_STRIP_DOMAIN=.foo.com:.bar.com

EGO accepts hostA, hostA.foo.com, and hostA.bar.com as names for host hostA, and uses the name hostA in all output. The leading period ‘.’ is required.

Example:
EGO_STRIP_DOMAIN=.platform.com:.generic.com

In the above example, EGO accepts hostA, hostA.platform.com, and hostA.generic.com as names for hostA, and uses the name hostA in all output.

Setting this parameter only affects host names displayed through EGO, it does not affect DNS host lookup.

Default

Not defined