SOAM section
The SOAM section of the application profile contains configuration related to system behavior such as session manager, service instance manager, and how IBM® Spectrum Symphony writes data to disk.
Description: Defines system behavior settings.
Description: Configuration related to session manager behavior. The SSM is known as the application manager within MapReduce workload.
- balanceSessionAssignment
- Description: The balanceSessionAssignment attribute inhibits the SSM from
balancing resource assignments across the sessions. When the value of the environment variable is
set to false, the SSM is prevented from balancing resource assignments. Therefore, the SSM improves
the dispatch performance of session stacking. When the value of the environment variable is set to
true, resource assignments are balanced, and the session stacking dispatch performance feature is
disabled. Restriction:
- Do not use this feature when sessions specify a ResourceGroupFilter or ServiceToSlotRatio requirement where specific types of resources might be scarce. An unbalanced assignment in this case can cause the starvation of sessions that have stricter ResourceGroupFilter and ServiceToSlotRatio requirements.
- Only the Linux® 64-bit operating systems support this attribute.
- IBM Spectrum Symphony Developer Edition does not support this attribute.
Where used:
Required or optional: Optional
Valid values: true or false
Default value: true
Related attributes:- ResourceGroupName: The resource group from which resources are requested to run session managers.
- disableFlowControl
- Description: For internal system use only.
- enableOptimizedHostQueue
- Description: Enables or disables data affinity for SOA workload to improve performance for
task-level data-aware scheduling.
Where used:
Required or optional: Required
Valid values: true or false
Default value: false
- inactiveTimeout
- Description: Defines the period of time, in seconds, that an SSM can be inactive in the cluster
before it shuts itself down. Before shutting down gracefully, the SSM notifies SD not to restart the
SSM and to release the existing allocation. An SSM is considered inactive when it has no active
sessions, client connections, or history data writing. If this parameter is set, it overrides
SSM_INACTIVE_TIMEOUT in the SD service profile. If this parameter is set to 0, a non-valid value, or
not defined, this feature is disabled.
Where used:
Required or optional: Optional
Valid values: 1 to 2147483647
Default value: No timeout
Related attributes:- SSM_INACTIVE_TIMEOUT: Same definition as inactiveTimeout except it is a cluster-wide setting.
- queryThread
- Description: The maximum number of threads that SSM can offer when SD queries it.
Where used:
Required or optional: Optional
Valid values: 1 to 1000
Default value: 1
- resourceGroupName
- Description: The resource group from which resources are requested to run session managers. This
resource group should be a management host resource group and must be an existing resource group in
EGO. Specify a single resource group, not multiple groups.
Not required for IBM Spectrum Symphony Developer Edition.
Where used:
Required or optional: Optional
Default value: If the resource group is not defined, the system selects resources from the ManagementHosts group to start the session manager.
Related attributes:- resReq in : Specifies the criteria for selecting resources to start the session manager. Resources will only be selected from resource groups specified by resourceGroupName .
- resReq
- Description: String that describes criteria for selecting resources allocated to the session
director to start the session manager.
This is not applicable for IBM Spectrum Symphony Developer Edition.
Where used:
Required or optional: Optional
Default value: "" (empty): SSM can run on any hosts in the resource group configured in resourceGroupName in the section. By default, the resourceGroupName is ManagementHosts.
Synopsis: "select(select_string)""select(select_string) order(order_string)"
Related attributes:- resourceGroupName in : The resource group from which resources are requested to run session managers.
Synopsis description: A resource requirement string describes the criteria for defining a set of resources to run session managers. Session managers should run on management hosts. If you have changed the default value of resourceGroupName, you must indicate the select string
"select(mg)"so that only management hosts are selected to run the session managers. Running the session manager on a management host is essential for reliability and recovery. The entire resource requirement string cannot contain more than 512 characters.Synopsis options:- select(select_string)
- Specifies the criteria for selecting the resources. The selection string filters out the
resources that do not meet the criteria, resulting in a list of one or more eligible
resources.
The parentheses must be typed as shown.
- order(order_string)
- Specifies the sort order for selecting the best resource from the list of eligible resources.
The most appropriate resource is listed first, the least is listed last.
The parentheses must be typed as shown.
select synopsis: select(expression)select(expression operator expression)select((expression operator expression) operator expression)
select description: The selection string (resource_name operator value) is a logical expression used to select one or more resources to match one or more criteria. Any resource that satisfies the criteria is selected.- resource_name
- The following resources can be used as selection criteria.
- Static resources
- Static resources are built-in resources that represent host information that does not change
over time, such as the maximum RAM available to user processes or the number of processors in a
machine. Most static resources are determined at start-up time, or when hardware configuration
changes are detected.
Static resources can be used to select appropriate hosts based on binary architecture, relative CPU speed, and system configuration.
Note: The resources ncpus, ncores, nprocs, nthreads, maxmem, maxswp, and maxtmp are not static on Linux hosts that support dynamic hardware reconfiguration.Index Measures Units Determined by type host type string configuration model host model string configuration hname host name string configuration cpuf CPU factor relative configuration server host can run remote jobs Boolean configuration rexpri execution priority nice(2) argument configuration ncpus number of processors processors LIM ndiks number of local disks disks LIM maxmem maximum RAM MB LIM maxswp maximum swap space MB LIM maxtmp maximum space in /tmp MB LIM - CPU factor (cpuf)
- The CPU factor is the speed of the host's CPU relative to other hosts in the cluster. If one processor is twice the speed of another, its CPU factor should be twice as large. CPU factors are defined by the cluster administrator. For multiprocessor hosts, the CPU factor is the speed of a single processor.
- Server
- The server static resource is Boolean. It has the following values:
- 1 if the host is configured to run jobs from other hosts.
- 0 if the host is a client for submitting jobs to other hosts.
- operator
- The following operators can be used in selection strings. If you are using the selection string
in an XML format, you must use the applicable escape characters in the XML Equivalence column. The
operators are listed in order of decreasing precedence:
Operator XML Equivalent Syntax Meaning ! Not applicable !a Logical NOT: 1 if a==0, 0 otherwise * Not applicable a*b Multiply a and b / Not applicable a / b Divide a by b + Not applicable a+b Add a and b - Not applicable a-b Subtract b from a > &gt; a > b 1 if a is greater than b, 0 otherwise < < a < b 1 if a is less than b, 0 otherwise >= &gt;= a >= b 1 if a is greater than or equal to b, 0 otherwise <= <= a <= b 1 if a is less than or equal to b, 0 otherwise == Not applicable a == b 1 if a is equal to b, 0 otherwise != Not applicable a != b 1 if a is not equal to b, 0 otherwise && && a && b Logical AND: 1 if both a and b are non-zero, 0 otherwise || Not applicable a || b Logical OR: 1 if either a or b is non-zero, 0 otherwise - value
- Specifies the value to be used as criteria for selecting a resource. Value can be numerical, such as when referring to available memory or swap space, or it can be textual, such as when referring to a specific type of host.
Example: Simple selection expression using static resources. The following example selects resources with total memory greater than 500 MB:select(maxmem > 500)Example: Compound selection expression using static resources. The following example selects resources with total memory greater than 500MB and total swap space greater than or equal to 300 MB:select(maxmem > 500 && maxswp >=300)order synopsis: order(order_string)
order description: The order string acts on the results of a select string, sorting the selected resources to identify the most favorable resources, and eliminate the least desirable resources. Resources are sorted into ascending order based on the result of an arithmetical expression. The result orders the resources from smallest to largest.- order_string
- Specify an arithmetic expression that expresses the desired outcome.
You can create an expression using operators and numbers.
Use the following operators:- +
- add
- –
- subtract-
- *
- multiply
- /
- divide
Example: Order resources based on available swap space. The following example orders the selected resources based on their available swap space, but sorts by descending order, ordering hosts with the greatest amount of available swap space first:order(0-swp) - simHeartbeatInterval
-
Description: Specifies the heartbeat interval (in seconds) at which the SSM iterates through a list of SIM connections in memory. If an SIM connection does not receive a protocol message within this interval, the SSM sends a heartbeat message to the SIM.
Where used:
Required or optional: Optional
Valid values: 60 to 2147483647. If this value is not configured, the configuration is not enabled.
Default value: 180
- simNoResponseTimeout
- Description: When the simHeartbeatInterval parameter is
defined, specifies the interval that the SSM waits for any protocol message from the SIM. If neither
a pre-existing message nor a heartbeat response message is received from the SIM within this
configured interval, the SSM releases the resources associated with this SIM and terminates the SIM
if it is running.
Where used:
Required or optional: Optional
Valid value: If this value is lower than 120, the application profile fails to register. Valid value is (simHeartbeatInterval*2) to 4294967295. If the value specified is lower than the minimum but higher than 120, it is set to the minimum; if the value specified is higher than the maximum, it is set to the maximum.
If simHeartbeatInterval is not configured, simNoResponseTimeout is ignored.
Default value: Response timeout is not defined
- shutDownTimeout
- Description: Number of seconds to wait for the session manager to shut down before the session
director considers it as timed out and restarts the session manager.
The session manager should shut down within the timeout period when the related application is unregistered or disabled.
Where used:
Required or optional: Optional
Valid values: 1 to 4294967295
Default value: 300
- SSMHDFSRenewalPluginCmd
- Description: Startup command including path that launches the plug-in process for Kerberos-based
authentication. When security is enabled for Hadoop, the Kerberos plug-in acquires Kerberos
credentials required to access secure HDFS and to authenticate users for MapReduce job submission.
It also renews the delegation tokens while a job is running.Note: SSMHDFSRenewalPluginCmd only applies to MapReduce workload.Parameter SSMHDFSRenewalPluginCmd supports substitution with the following variables:Syntax for the command:
- SOAM_HOME
- PMR_HOME
- VERSION_NUM
- EGO_CONFDIR
- EGO_TOP
- EGO_MACHINE_TYPE
SSMHDFSRenewalPluginCmd="path_to_plugin $HADOOP_HOME path_to_kerberos_config_file"where:- path_to_plugin specifies the location of the Kerberos plug-in
- $HADOOP_HOME specifies the HDFS installation directory
- path_to_kerberos_config_file specifies the location of the Kerberos configuration file (sec_ego_kerberos.conf)
For example:SSMHDFSRenewalPluginCmd="${SOAM_HOME}/mapreduce/{PMR_VERSION}/${EGO_MACHINE_TYPE}/plugin/TokenRenewal4HDFS.sh $HADOOP_HOME ${EGO_CONFDIR}"Where used:
Required or optional: Optional
Valid values: Any location accessible on your network or local disk.
- SSMResPubCacheEnabled
- Description: Specifies whether caching is enabled for results received from the plug-in so that
subsequent calls for the same attributes will return cached values.
Where used:
Required or optional: Optional
Valid values: true or false
Default value: true
- SSMResPubPluginCmd
- Description: Start-up command including path that launches the data-aware scheduling plug-in
process. This process is used in conjunction with an external application to request the location
and cost values for preferred user-defined service attributes.
The rack-aware scheduling plug-in (DAS4HDFS.sh) used in the previous release to query the HDFS rack topology is no longer required. If your application profile has been configured for the HDFS plug-in, IBM Spectrum Symphony will ignore the configuration. For more information on rack-aware scheduling, refer to Working with the MapReduce framework and IBM Spectrum Symphony.
Parameter SSMResPubPluginCmd supports substitution with the following IBM Spectrum Symphony variables:- SOAM_HOME
- PMR_HOME
- VERSION_NUM
- EGO_CONFDIR
- EGO_SHARED_TOP
- EGO_MACHINE_TYPE
Here are examples of the configuration in the application profile for SSMResPubPluginCmd:SSMResPubPluginCmd="${SOAM_HOME}/${VERSION_NUM}/${EGO_MACHINE_TYPE}/bin/MyPlugin"Here is the same configuration, with example values:SSMResPubPluginCmd="${SOAM_HOME}/mapreduce/{PMR_VERSION}/ ${EGO_MACHINE_TYPE}/plugin/DAS4HDFSRack.sh $HADOOP_HOME"In addition to the data-aware scheduling plug-in for an HDFS file system, you can use the GPFS-FPO data-aware scheduling plug-in to obtain information for files located on GPFS-FPO clusters. Use the following environment variables to start up the GPFS-FPO data-aware scheduling plug-in process:
- GPFS_FPO_MMLSNSD: Specify the absolute path of the GPFS-FPO command, mmlsnsd. This value is mandatory. If not set, IBM Spectrum Symphonylogs an error to $SOAM_HOME/logs/plugin.Das.GpfsFpo.hostname.log and the plug-in exits.
- GPFS_FPO_MMLSDISK: Specify the absolute path of the GPFS-FPO command, mmlsdisk. This value is mandatory. If not set, IBM Spectrum Symphonylogs an error to $SOAM_HOME/logs/plugin.Das.GpfsFpo.hostname.log and the plug-in exits.
- -d DIRECTORIES: Optionally, to reduce the response time for location queries, pre-cache file
locations in specified directories. Specify a list of directories, each separated by a comma (,), in
the GPFS-FPO file system. The location information of all
files in these directories will be cached into the plug-in process when the location cache is
enabled. Note the following rules for the directories:
- Each directory must be an absolute path.
- Any excess slashes (/), or slashes at the end of the directory paths, will be stripped. For example, the plug-in interprets /gpfs/d1//d2,/gpfs///d3/d4/ as /gpfs/d1/d2,/gpfs/d3/d4.
- Directory paths and names with excess dots (.), quotation marks ("), blank spaces, and wildcard characters are not supported.
- Directory names are case sensitive.
- -p POLLING_INTERVAL: Optionally, periodically update cached information (for newly-added files and changes to the GPFS-FPO disk and host information). Specify the amount of time, in seconds, that the plug-in should poll for periodic cache updates. Valid values are 0 to 2147483647. The default value is 0, to indicate that periodic cache updates are disabled.
- -c CACHE_ENABLED: Optionally, to reduce the response time for location queries, enable or disable location caching. Valid values are true or false. The default value is true, which enables location caching so that the plug-in always queries location information. Specify false if you want the plug-in to query the location information on-demand.
- -e CACHE_ENTRIES: Optionally, specify the maximum number of items permitted in the cache. This limits the plug-in process and prevents it from running out of memory. Valid values are 1 to 4294967295. The default value is 10000. If the cache reaches this maximum, the plug-in logs a warning message to $SOAM_HOME/logs/plugin.Das.GpfsFpo.hostname.log.
For example, here is the configuration in the application profile for SSMResPubPluginCmd:
Here is the same configuration, with example values:<SSM SSMResPubPluginCmd="<plugin_path GPFS_FPO_MMLSNSD GPFS_FPO_MMLSDISK [-d DIRECTORIES] [-p POLLING_INTERVAL] [-c CACHE_ENABLED] [–e CACHE_ENTRIES]> "enableOptimizedHostQueue="true"/><SSM SSMResPubPluginCmd="</…/gpfs_fpo_das_plugin /usr/lpp/mmfs/bin/mmlsnsd /usr/lpp/mmfs/bin/mmlsdisk -d /gpfs/f1 -p 120 -c true -e 10000>" enableOptimizedHostQueue="true"/>Where used:
Required or optional: Optional
Valid values: Any location accessible on your network or local disk.
- SSMResPubPluginCmdTimeout
- Description: Number of seconds the SSM waits for a response from the plug-in. The response may
be an acknowledgment of successful initialization when the plug-in process is started, or it may be
following a request for the value of a user-defined attribute.
Where used:
Required or optional: Optional
Valid values: 1 to 4294967295
Default value: 30
- startUpTimeout
- Description: Number of seconds to wait for the session manager to start up before the session
director considers it as timed out.
When the process times out, the session director requests EGO to replace the session manager host and tries again to start a new session manager.
The session manager is started when IBM Spectrum Symphony is started if prestartApplication is true for the enabled application. Otherwise, the session manager is started when a client connects to an enabled application, which does not have running session manager and prestartApplication is false.
Where used:
Required or optional: Optional
Valid values: 1 to 4294967295
Default value: 60
Related attributes:- preStartApplication: Influences when the session manager and service instance manager are started, when IBM Spectrum Symphony starts or when IBM Spectrum Symphony receives a request from a client of this application
- workDir
- Description: Absolute path in which the session manager process stores data for operations,
including paging, journaling and history files.
Paging, journaling, and history data files are saved in subdirectories under the workDir if a relative path is configured for the paging, journaling, and data history paths.
This is not applicable in IBM Spectrum Symphony Developer Edition. In IBM Spectrum Symphony Developer Edition, the working directory of the session manager is as follows:- Windows: %SOAM_HOME%\work
- Linux: $SOAM_HOME/work
Where used:
Required or optional: Optional
Valid values: Any accessible absolute path on the network or local disk. To facilitate the session manager recovery, workDir should be set to a directory on a shared file system.
Default value: By default, the session manager working directory is the same for all applications. If applications are configured to write to the same directory, the operating system user accounts assigned to start the session manager must have access to that directory. It is recommended that all operating system execution users who start the session managers be in the same primary user group.
If a shared directory is configured in the cluster, the default working directory for the session manager points to the shared location in the host on which session manager runs is ${EGO_SHARED_TOP}/soam/work.
If there is no shared directory configured in the cluster, then the default working directory points to the local location in the host on which session manager runs, as follows:- Windows: %EGO_CONFDIR%\..\..\soam\work
- Linux: $EGO_CONFDIR/../../soam/work
Description: For internal system use only.
- description
- Description: For internal system use only.
- maxValue
- Description: For internal system use only.
- minValue
- Description: For internal system use only.
- name
- Description: For internal system use only.
Description: For internal system use only.
- name
- Description: For internal system use only.
- value
- Description: For internal system use only.
- elementName
- Description: Specifies how the system responds to changes in the amount of physical memory,
virtual memory, or virtual address space on the session manager host:
- AvailableMemory: The boundary manager monitors the amount of physical memory available on the host.
- AvailableVirtualAddressSpace: The boundary manager monitors the amount of virtual address space the session manager can use to map memory for each process. It is possible for the host to have more than enough memory available, which is physical memory plus swap memory, but the process cannot access anymore because it has no available address space to map this memory to. The maximum configurable size of virtual address space is 2G (for 32 bit operating systems) and 8T (for 64 bit operating systems).
- ProcessMemory: The boundary manager monitors the amount of physical memory that is available for each process. The maximum configurable size of process memory is 2G (for 32 bit operating systems) and 8T (for 64 bit operating systems).
Where used:
Required or optional: Optional
Valid values: AvailableMemory , AvailableVirtualAddressSpace, or ProcessMemory
Related attributes:- name (event): Multiple boundary events are associated with each elementName
- value (event): A value is assigned to each boundary event
- name (param): The MaxSizeReference parameter is associated with AvailableVirtualAddressSpace and ProcessMemory
- value (param): A value is assigned to the MaxSizeReference parameter
- name
- Description: Specifies the name of the boundary parameter. The boundary parameter and its
associated value are used as a reference against which boundary events are triggered for
AvailableVirtualAddressSpace and ProcessMemory.
The system monitors the boundaries defined to ensure the robust functionality of the session manager. Messages are logged to the session manager log file and administrators are notified through event notification when new events are triggered.
For a description of system reactions when boundary events occur, refer to the description for .
Where used:
Required or optional: Optional
Valid values: MaxSizeReference
Default value: The following describes the element names, event names, and their default boundary values:elementName or event name BEV_PROACTIVE BEV_SEVERE BEV_CRITICAL BEV_HALT AvailableMemory 50 40 25 15 AvailableVirtualAddressSpace 50 40 25 15 ProcessMemory 0 0 0 0 Related attributes:- elementName: The name of the system resource monitored by the boundary manager
- value (param): The minimum value the system resource can reach before the event is triggered
- value
- The value is used in conjunction with events BEV_PROACTIVE, BEV_SEVERE, BEV_CRITICAL, BEV_HALT.
When the value of MaxSizeReference is defined, the percentage
associated with the boundary events is a ratio based on this value instead of the default value:
- For element AvailableVirtualAddressSpace, the value of MaxSizeReference defines the maximum virtual address space in MB. If the value of MaxSizeReference is not defined or is not valid, the default value of 2 G (for 32-bit operating systems) and 8 T (for 64-bit operating systems) is used.
- For element "ProcessMemory", the value of MaxSizeReference defines the quota of the memory size for the SSM in MB. If the value of MaxSizeReference is not defined or is not valid, the default value of 2 G (for 32-bit operating systems) and 8 T (for 64 -bit operating systems) is used.
Where used:
Required or optional: Optional
Valid values: 0 or more; if 0 is defined, the default value is used (8 T for 64-bit operating systems and 2 G for 32-bit operating systems)
Default value: The following describes the element names, event names, and their default boundary values:elementName or event name BEV_PROACTIVE BEV_SEVERE BEV_CRITICAL BEV_HALT AvailableMemory 50 40 25 15 AvailableVirtualAddressSpace 50 40 25 15 ProcessMemory 0 0 0 0 Related attributes:- elementName: Specifies the resource (ProcessMemory or AvailableVirtualAddressSpace) to which the boundary applies.
- name (param): Specifies the boundary for which a value is assigned.
- name
- Description: Specifies the name of the boundary event that triggers a system response when the
value of the event is reached.
The system monitors the boundaries defined, available memory, and available session manager. Messages are logged to the session manager log file and administrators are notified through event notification when new events are triggered.
Memory low conditions can be caused by any of the following reasons:- Running too many memory-consuming processes on the session manager host
- Too many unprocessed input and output messages
- Too many unfinished sessions or tasks
The following describes system reactions when a boundary limit is reached:Boundary event Messages Workload processing changes System processing changes BEV_PROACTIVE INFO The SSM starts to page data, which can lead to slower input handling. The impact is dependent on message size, disk speed, etc. Starts scheduling common data and input/output messages for paging. BEV_SEVERE WARNING - The SSM starts to release already paged data from memory. This will impact the time to dispatch tasks as they must be read back into memory before being dispatched.
- The session manager allows clients to create new sessions and submit new tasks. These actions were prohibited by the session manager after the BEV_CRITICAL event was triggered.
Assigns higher priority to paging write requests, memory is released once the messages are paged out BEV_CRITICAL WARNING - New connections from the client to the session manager are rejected
- New session creations and tasks submissions are held until a lesser level event is triggered such as BEV_SEVERE or BEV_PROACTIVE
Assigns higher priority to paging write requests BEV_HALT FATAL - All new session and client requests are rejected
- Processing of existing requests is stopped
- Runs in maintenance mode
- Only cluster administrator can access workload through the console
- Once memory drops down, and BEV_SEVERE or BEV_PROACTVE is triggered, the session manager resumes work
Memory low conditions can be corrected by the following solutions:- Running the session manager on a dedicated management host
- Adding more physical memory or increasing the amount of assigned swap memory
- Terminating any faulty sessions that are consuming excessive amounts of memory
- Terminating any nominal sessions to release memory
Where used:
Required or optional: Optional
Valid values: BEV_PROACTIVE, BEV_SEVERE, BEV_CRITICAL, or BEV_HALT
Related attributes:- elementName: The name of the system resource monitored by the boundary manager
- value (event): The minimum value the system resource can reach before the event is triggered
- value
- Description: Specifies the value of a boundary event as a percentage of the entire resource
available.
When the availability of the resource monitored falls under the boundary event value, it triggers a system response to ensure the session manager has enough memory to function.
Where used:
Required or optional: Optional
Valid values: 0 or more
Default value: The following describes the element names, event names, and their default boundary values:elementName or event name BEV_PROACTIVE BEV_SEVERE BEV_CRITICAL BEV_HALT AvailableMemory 50 40 25 15 AvailableVirtualAddressSpace 50 40 25 15 ProcessMemory 0 0 0 0 Related attributes:- elementName: Specifies the resource to which the boundary applies.
- name (event): Specifies the boundary event for which a value is assigned.
Description: For internal system use only.
- name
- Description: For internal system use only.
- value
- Description: For internal system use only.
Description: Configures the scheduling tree policy for sharing application resources.
Description: Specifies the order in which policy tags will be scheduled. The nesting of PolicyTag elements within the SchedulingOrder element corresponds to levels in the scheduling tree, as follows:
- The outer-most XML elements are closest to the root in the scheduling tree.
- The inner-most XML elements are closest to the leaves in the scheduling tree.
- optional
- Description: Determines whether the policy’s scheduling rules are optional.
Where used:
Required or optional: Optional
Valid values: true or false
Default value: false, to indicate scheduling rules must be followed.
- type
- Description: Identifies a level in the tag-based scheduling hierarchy or tree. Each level in the
hierarchy represents a category of items, which is identifiable by policy tag type. Scheduling
hierarchies of up to 5 levels of policy tag types are supported.
You must order the policy tag types in the application profile to specify the order in which resources will flow down the tree.
Where used:
Required or optional: Required
Valid values: A string of no more than 32 characters long containing only alphanumeric characters, underscore characters (_), and hyphens (-). It cannot begin with a hyphen.
Description: Specifies which policy tags are valid at runtime and defines how resources are to be distributed among competing tags. The relative priority of a policy tag value is used in scheduling to determine how many resources that policy tag node deserves compared to its siblings.
- dynamicPriority
- Description: Determines whether to base the policy’s scheduling order using dynamic
prioritization.
Where used:
Required or optional: Optional
Valid values: true or false
Default value: false, to indicate no dynamic prioritization.
- priority
- Description: Determines a policy tag’s share ratio for resources. The root node in the hierarchy
distributes resources to its children proportionally, based on the relative priorities of its child
tags (or child sessions at the end of the tree).
Where used:
Required or optional: Optional
Valid values: 1 to 10000
Default value: 1
- scheduling
- Description: Determines how to schedule the policy’s scheduling rules.
Where used:
Required or optional: Required
Default value: Proportion
- type
- Description: Identifies a level in the tag-based scheduling hierarchy or tree. Each level in the
hierarchy represents a category of items, which is identifiable by policy tag type. Scheduling
hierarchies of up to 5 levels of policy tag types are supported.
Where used:
Required or optional: Required
Valid values: A string of no more than 64 characters long containing only alphanumeric characters, underscore characters (_), and hyphens (-). It cannot begin with a hyphen.
- value
- Description: A unique identifier to distinguish policy tags at the same level in the same branch
of the hierarchy. At session creation time, the application specifies a policy tag value for every
level (policy tag type) in the hierarchy. This determines the session's position in the scheduling
tree.
Configure the value with an * (asterisk), if you want the IBM Spectrum Symphony client to be able to create a session with a policy tag value that has not been explicitly configured for the specified policy tag type. The policy tag value will be dynamically added to the scheduling tree.
Where used:
Required or optional: Required
Valid values: A string of no more than 64 characters long containing only alphanumeric characters, underscore characters (_), and hyphens (-). It cannot begin with a hyphen.
targetServices- Description: Set the expected number of slots (for a service) in a session, under a
PolicyTag parameter, so that the scheduler will try to allocate the number of
slots to it. When there are multiple sessions, the scheduler will use first come first serve logic
to try to allocate slots to each session. The targetServices attribute does not
take effect if the slot be considered has enough resources (that is, there are still free slots
remaining after the scheduler calculates and allocates the expected number of slots for all
sessions, which indicates that there are enough slots, and sessions can finish in a timely manner,
without blocking other waiting sessions. In this case, the scheduler reallocates all slots, ignoring
the targetServices value. Note the following characteristics about the targetServices attribute:
- The targetServices attribute only applies when optional attribute is not configured for the parameter, and when the dynamicPriority and scheduling attributes are not configured for the parameter. If these attributes are set, then the targetServices attribute is ignored.
- The targetServices attribute is only applicable when editing your application profile manually; it is not available when using the cluster management console to edit the application profile.
Where used:
For nested PolicyTag sections, this targetServices attribute only takes effect for the last (lowest) PolicyTag level of the R_TagHierarchy share policy in the SOAM section; it will be ignored if configured on higher levels. In the following example, the targetServices attribute is set and used from at thePolicyTag type="UserAccount"level, not thePolicyTag type="UserGroup"orPolicyTag type="Project"levels (if thetargetServicesattribute was set at these levels, the value would be ignored):<Policy> <SchedulingOrder> <PolicyTag type="Project"> <PolicyTag type="UserGroup"> <PolicyTag type="UserAccount"/> </PolicyTag> </PolicyTag> </SchedulingOrder> <SchedulingRules> <PolicyTag type="Project" value="Project1" priority="9"> <PolicyTag type="UserGroup" value="UserGroup1" priority="2"> <PolicyTag type="UserAccount" value="smith"targetServices="4"/>
<PolicyTag type="UserAccount" value="adams" targetServices="6"/>
</PolicyTag>
<PolicyTag type="UserGroup" value="UserGroup2" priority="7">
<PolicyTag type="UserAccount" value="jacobs" targetServices="4"/>
<PolicyTag type="UserAccount" value="henry" targetServices="6"/>
</PolicyTag>
</PolicyTag>
</SchedulingRules>
</Policy>Required or optional: Optional
Valid values: 0 to 2147483647, where value 0 indicates that this features is disabled and without a maximum number of slots for the services.
Default value: 0
Description: Specifies a set of configurable parameters to monitor the health of the cluster at the application level through SNMP alerts.
- enableMonitoring
- Description: Enables or disables application-level monitoring through SNMP alerts. If set to
true and thresholds are defined in additional parameters, IBM
Spectrum Symphony monitors
conditions for a breach and generates an SNMP alert when the conditions exist beyond a configured
threshold.
Where used:
Required or optional: Optional
Valid values: true or false
Default value: false , to indicate application-level monitoring is disabled.
- pollInterval
- Description: When application-level monitoring is enabled through
enableMonitoring, specifies the interval (in seconds) at which IBM
Spectrum Symphony collects samples
of a threshold breach.
Where used:
Required or optional: Optional
Valid values: 1 to 2147483647
Default value: 30
- samplesOverThreshold
- Description: When application-level monitoring is enabled through
enableMonitoring, specifies the number of consecutive samples that match a
threshold breach. If threshold conditions are breached for the value specified by this parameter, an
SNMP alert is generated. An SNMP alert is generated only when all of the following conditions are met:
- the ratio of used slots ratio is less than usedSlotsRatio,
- the number of pending tasks is more than zero, and
- the number of consecutive samples over threshold is greater than samplesOverThreshold.
Where used:
Required or optional: Optional
Valid values: 1 to 4294967295
Default value: 10
- usedSlotsRatio
- Description: When application-level monitoring is enabled through
enableMonitoring, specifies the ratio of used slots for an application. The
used slots ratio is calculated as the sum of slots used by running tasks and slots used for
initialization and uninitialization divided by the number of allocated slots (slots running tasks
plus slots used for initialization and uninitialization, divided by allocated slots). When the used
slots ratio is less than the value specified by this parameter, the threshold is set to be
breached.An SNMP alert, however, is generated only when all of the following conditions are met:
- the ratio of used slots ratio is less than usedSlotsRatio,
- the number of pending tasks is more than zero, and
- the number of consecutive samples over threshold is greater than samplesOverThreshold.
Where used:
Required or optional: Optional
Valid values: 0 or 1
Default value: 0.8
- blockHostOnStartupFail
- Description: Defines whether to block this host for the application when the service instance
manager fails to start up. If set to true, then if the service instance manager
cannot start up, the host is added to the blocked hosts list and is no longer used for the
application, unless the host is explicitly unblocked through the cluster management console.
IBM Spectrum Symphony Developer Edition blocks slots rather than hosts. Slots can be unlocked by disabling and enabling your application.
Where used:
Required or optional: Optional
Valid values: true or false
Default value: true, to indicate that the host is added to the blocked hosts list if the service instance manager cannot start up.
- blockHostOnTimeout
- Description: Used with the startUpTimeout () attribute. Defines whether to block this host for the application when the service
instance manager times out on process startup. If set to true, when the service
instance manager times out on startup, the host is added to the blocked hosts list and is no longer
used for the application unless the host is explicitly unblocked through the cluster management console.
IBM Spectrum Symphony Developer Edition blocks slots rather than hosts. Slots can be unblocked by disabling and enabling your application.
Where used:
Required or optional: Optional
Valid values: true or false
Default value: true, to indicate that the host is added to the blocked hosts list for the application upon timeout.
Related attributes:- startUpTimeout ()
- blockHostOnVersionMismatch
- Description: For internal system use only.
- runSIMAsClusterAdmin
- Description: Specifies whether the SIM and Docker clients for IBM Spectrum Symphony Advanced Edition on Linux applications, run using the cluster
administrator user. For added security, set this environment variable to true, so
that IBM Spectrum Symphony always runs
the service instance manager (SIM) and any Docker client processes using the cluster administrator
user. Otherwise, the default value of false is used, allowing these processes to be
run by other users. With this setting, you only need to ensure that only the cluster administrator
user (rather than every possible execution user), has read and write access to the Docker socket
(docker.sock).If setting this runSIMAsClusterAdmin value to true, also note:
- You can configure the runSIMAsClusterAdmin settings using the CLI method of updating the application profile; the cluster management console method is not supported for runSIMAsClusterAdmin.
- Docker must be enabled for IBM Spectrum Symphony, by setting the enableDockerForServiceInstance value to true in the Consumer section of the application profile; otherwise, the consumer or application administrator will be unable to register the application profile and will receive errors.
- If you have enabled SELinux context switching for IBM Spectrum Symphony, and have set the runSIMAsClusterAdmin value to true, since the SIM and Docker client run as the cluster administrator user, these processes started by SIM will run with unconfined security context (rather than run with the security context of the consumer’s execution user); PEM will not switch context for processes which run as the cluster administrator user.
Where used:
Required or optional: Optional
Valid values: true or false
Default value: false
- serviceStartedCheck
- Description: For internal system use only.
- serviceToThreadRatio
- Description: The number of services required to share one working thread in a single SIM. The
services in one SIM that occupy the appropriate number of working thread is determined by this
ratio.
Where used:
Required or optional: Optional
Valid values: 1 to 2147483647
Default value: 4
- startUpTimeout
- Description: Number of seconds to wait for the service instance manager to start up before the
session manager considers it as timed out. This parameter works in conjunction with
blockHostOnTimeout.
After a session manager starts a service instance manager, if the service instance manager cannot contact the session manager within the startUpTimeout time, the session manager requests a new host from EGO and tries to start a new service instance manager on the new host.
Where used:
Required or optional: Optional
Valid values: 1 to 4294967295
Default value: 60
Related attributes:- blockHostOnTimeout: Determines whether the host is blocked if timeout occurs on SIM startup.
Description: Configuration related to system security.
- SDK_TRANSPORT_ARG
- Description: Security configuration for SIM if
TLS between SSM and SIM is enabled (by specifying a value for
SSM_SIM_TRANSPORT).
Where used:
Required or optional: Optional.
Valid values: The format for this parameter is the same as the one used in EGO_CLIENT_TS_PARAMS. For example,
SDK_TRANSPORT_ARG="SSL[…]"is valid. For details on EGO_CLIENT_TS_PARAMS, see IBM Spectrum Symphony and Transport Layer Security (TLS).Default value: None (to indicate that security is disabled)
- SSM_SDK_TRANSPORT
- Description: Enables or disables security between SSM and the SDK
client or SD (session director).
Where used:
Required or optional: Optional
Valid values: TCPIPv4 or TCPIPv4SSL. For example,
SSM_SDK_TRANSPORT=TCPIPv4SSLis valid.Default value: TCPIPv4
- SSM_SDK_TRANSPORT_ARG
- Description: Security configuration for SSM, if
TLS between SSM and SIM is enabled (by specifying a value for
SSM_SIM_TRANSPORT).
Where used:
Required or optional: Optional
Valid values: The format is the same as the one used in EGO_DEFAULT_TS_PARAMS. For example,
SSM_SDK_TRANSPORT_ARG="SSL […]"is valid. For details on EGO_DEFAULT_TS_PARAMS, see IBM Spectrum Symphony and Transport Layer Security (TLS).Default value: None
- ssmSimAuthConf
- Description: Configures the inter-daemon authentication plug-in used between SSM and
SIM.
Where used:
Required or optional: Optional
Valid values: Any string
Default value: None (to indicate that inter-daemon authentication is disabled)
- ssmSimAuthPlugin
- Description: Enables or disables the inter-daemon authentication plug-in between SSM and
SIM.
Where used:
Required or optional: Optional
Valid values: sec_ego_digest (for example,
ssmSimAuthPlugin="sec_ego_digest"is valid).Default value: None (to indicate that inter-daemon authentication is disabled)
- SSM_SIM_TRANSPORT
- Description: Enables or disables security between SSM and
SIM.
Where used:
Required or optional: Optional
Valid values: TCPIPv4 or TCPIPv4SSL. For example,
SSM_SIM_TRANSPORT=TCPIPv4SSLis valid.Default value: TCPIPv4
- ssmVemkdAuthConf
- Description: Specifies the configuration for the security plug-in indicated by
ssmVemkdAuthPlugin.
Where used:
Required or optional: Optional
Valid values: The valid configuration for the sec_ego_gsskrb security plug-in. You can specify the custom credential cache by defining KRB5CCNAME and a custom keytab file by defining KRB5_KTNAME.
Default value: None
- ssmVemkdAuthKrbUsername
- Description: Specifies the principal name that should be used for the Kerberos client. In this
context, SSM uses it as the client name when initializing authentication.To support a host-based service Kerberos principal in SSM, optionally configure
ssmVemkdAuthKrbUsernamewith the Kerberos principal in the formatprincipal/${host}. The following is an example, usingssm1as the principal name.... <Security ssmVemkdAuthKrbUsername="KRB5_KTNAME=..."ssmVemkdAuthKrbUsername= "ssm1/${host}" ssmVemkdAuthPlugin="sec_ego_gsskrb"/> ...Note:${host}is a literal string and not an actual host name. Do not use the actual host name; when the SSM is started on other hosts, it will not be able to authenticate or authorize with VEMKD.Once configured, when the SSM starts on a specific host, the principal will be expanded using the host's fully qualified domain name (FQDN). The FQDN is obtained by running the system utility hostname -f on the host on which SSM is starting (for example,
ssm1/host1.fqdn.mydomain.com).Authentication is achieved through Kerberos, and additional authorization is achieved using the host name from which the SSM is connecting, rather than the host part of the principal (that is, the part after /).
Assuming successful authentication and authorization, the SSM principal maps to an IBM Spectrum Symphony user account with host part removed. In the context of the previous example, it would map to the IBM Spectrum Symphony user
ssm1.The mapped IBM Spectrum Symphony user account must exist and should be the consumer administrator or user associated with this application.
Where used:
Required or optional: Optional
Valid values: The Kerberos supported principal name. For example,
SympingUser.Default value: None
- ssmVemkdAuthPlugin
- Description: Specifies the sec_ego_gsskrb security plug-in plug-in is used by SSM.
Where used:
Required or optional: Optional
Valid values: sec_ego_gsskrb (for example, s
smVemkdAuthPlugin="sec_ego_gsskrb"is valid).Default value: None. If not specified, SSM uses the security plug-in indicated by EGO_SEC_PLUGIN in ego.conf.
Description: Parameters related to sessions and tasks historical data storage.
- bigSessionWatermark
- Description: Defines the number of tasks needed in a session before SSM considers
this a big session, and thereby, starts using history files exclusive to the session.
Where used:
Required or optional: Optional
Valid values: 10000 to 100000
Default value: 10000
- delimiter
- Description: For internal system use only.
- fileSwitchSize
- Description: Maximum size, in megabytes (MB), the history file can reach before the file is
archived at the next polling interval. When the history file reaches the maximum size specified, the
file is renamed by appending a time stamp to the file name.
Data history file names have the following format: applicationName_session.soamdb or applicationName_task.soamdb.
After renaming, the file names would be similar to the following:- applicationName_session.soamdb.yyyy_mm_dd_hh_mm_ss_x
- applicationName_task.soamdb.yyyy_mm_dd_hh_mm_ss_x
Where used:
Required or optional: Optional
Valid values: 1 to 100
Default value: 100
Related attributes:- pollFrequency: The size of the file is checked at the time interval defined by pollFrequency
- fileSwitchTime
- Description: Maximum number of hours that can elapse before the history file is archived at the
next polling interval.
When the history file reaches the maximum age specified, the file is renamed by appending a time stamp to the file name.
Data history file names have the following format:
applicationName_session.soamdb or applicationName_task.soamdb
After renaming the file names would be similar to the following:- applicationName_session.soamdb.yyyy_mm_dd_hh_mm_ss_x
- applicationName_task.soamdb.yyyy_mm_dd_hh_mm_ss_x
Where used:
Required or optional: Optional
Valid values: 1 to 168 (1 week)
Default value: 24
Related attributes:- pollFrequency: The age of the file is checked at the time interval defined by pollFrequency
- fsyncInterval
-
Description: Enables file synchronization (fsync) of task and session history files and specifies the interval (in seconds) at which fsync is triggered; also disables fsync. With this parameter, fsync operations on history files are called in a new thread (distinct from the thread used to write records). The thread checks open history files individually, at the specified interval, and calls fsync on files with unflushed data.
Valid value is in the 0 to 2147483647 range. To disable fsync for task and session history files, specify the value as 0. To enable fsync for history files at a desired interval, specify a value in the 1 to 2147483647 range.
You can also configure the fsync interval for all applications by defining the SOAM_HISTORY_FSYNC_INTERVAL environment variable in the sd.xml file at:- Windows: Installation_top\eservice\esc\conf\services
- Linux: $EGO_TOP/eservice/esc/conf/services
When the environment variable is also defined, the value of SOAM_HISTORY_FSYNC_INTERVAL in the sd.xml file takes precedence over the value of fsyncInterval in the application profile's section.
Where used:
Required or optional: Optional
Valid values: 0 to 2147483647
Default value: 30s (seconds)
Related attributes:- sessionScaleDownDisabled: Disables scaling down of history information, enabling multiple files to be created to write history information.
- lastingPeriod
- Description: Number of hours the archived history files are retained before deleted.
Where used:
Required or optional: Optional
Valid values: 1 to 168 (1 week)
Default value: 96 hours (4 days)
Related attributes:- pollFrequency: The age of the file is checked at the time interval defined by pollFrequency
- lastingPeriodInSeconds
- Description: For internal system use only.
- maxSessionsPerTaskFile
- Description: Maximum number of sessions per set of files.
Where used:
Required or optional: Optional
Valid values: 1, 10, 100, 1000, or 10000.
Default value: 1000
- path
- Description: Absolute or relative path in which session and task historical files are stored. If
relative path is specified, the directory is located under session manager working directory. The
path should be accessible by both session director and session manager, so that the session and task
historical data can be retrieved by command line and the cluster management console.Note: Ensure the user account running the session director (cluster administrator), and the user account running the session manager for the application (operating system execution account assigned to the consumer) has access to the directory.By default, history files are saved under the following locations:
- For IBM Spectrum Symphony:
- Windows: %EGO_CONFDIR%\..\..\soam\work\history
- Linux: $EGO_CONFDIR/../../soam/work/history
- For IBM Spectrum Symphony Developer Edition:
- Windows: %SOAM_HOME%\work\history
- Linux: $SOAM_HOME/work/history
If you specify an absolute path, all the history files are saved in the specified path. An absolute path must be accessible by both session director and the session manager for this application.
You can define the SOAM_HOME and EGO_SHARED_TOP environment variables in the sd.xml configuration file. For example:<ego:EnvironmentVariable name="SOAM_HOME">C:\Program Files\IBM\SpectrumComputing</ego:EnvironmentVariable> <ego:EnvironmentVariable name="EGO_SHARED_TOP">C:\Program Files\IBM\SpectrumComputing</ego:EnvironmentVariable>If you have one application profile to be deployed to more than one cluster, you can also define environment variables in the sd.xml file, in the section corresponding to the machine type of your management host. You can set five variables (SOAM_APP_PROFILE_1 to SOAM_APP_PROFILE_5). For example:<ego:EnvironmentVariable name="SOAM_APP_PROFILE_1">C:\mydirectory\var1</ego:EnvironmentVariable> <ego:EnvironmentVariable name="SOAM_APP_PROFILE_2">C:\mydirectory\var2</ego:EnvironmentVariable> <ego:EnvironmentVariable name="SOAM_APP_PROFILE_3">C:\mydirectory\var3</ego:EnvironmentVariable> <ego:EnvironmentVariable name="SOAM_APP_PROFILE_4">var4</ego:EnvironmentVariable> <ego:EnvironmentVariable name="SOAM_APP_PROFILE_5">var5</ego:EnvironmentVariable>Then, within the , , and sections of the application profile, you can call the variables you previously defined. For example:<DataHistory fileSwitchSize="100" lastingPeriod="96" path="${SOAM_APP_PROFILE_1}\${SOAM_APP_PROFILE_4}\${SOAM_APP_PROFILE_5}\dh"/> <PagingTasksInput blockSize="4096" diskSpace="4294967296" path="${SOAM_HOME}\work\${SOAM_APP_PROFILE_4}\pti"/> <JournalingTasks blockSize="4096" diskSpace="4294967296" path="${EGO_SHARED_TOP}\jt"/>Where used:
Required or optional: Optional
Valid values: Any absolute or relative path on network or local disk which can be accessed by both session director and session manager.
Default value: By default, data history files are saved in the history directory under the session manager working directory.
Related attributes:- workDir (): The working directory of session manager.
- For IBM Spectrum Symphony:
- pollFrequency
- Description: Specifies the frequency, in seconds, at which the history files are polled to
determine if the current file should be archived.
Where used:
Required or optional: Optional
Valid values: 1 to 10
Default value: 10
Related attributes:- fileSwitchSize: Defines, according to file size, when old history files are archived and new history files are started
- fileSwitchTime: Defines, according to file age, when old history files are archived and new history files are started
- sessionScaleDownDisabled
- Description: Disables scaling down of task history files. With this parameter set to
FALSE, based on the number of sessions per task history file, as specified in an
application's maxSessionsPerTaskFile parameter, the task history of different
sessions (by default, 1000) is written to the same history file. When the size of the history file
exceeds its threshold, as specified in the fileSwitchSize parameter (by
default, 100 MB), the maximum number of sessions written to the task history file is scaled down by
a factor of 10. Eventually, scaling down bottoms out such that the history file becomes exclusive to
one session. With this parameter set to TRUE, session scale-down is disabled, so
that task history for the maximum number of sessions is always written to the one history file until
the file is switched.Note: Enabling session scale-down enhances SD query performance (when the service queries task history files), but it increases the number of task history files in your cluster based on your workload configuration (number of tasks per session and maxSessionsPerTaskFile). Disabling session scale-down keeps the number of active history files in your cluster steady.You can configure scaling down of task history for all applications by defining the SOAM_HISTORY_DISABLE_SESSION_SCALE_DOWN environment variable in the sd.xml file at:
- Windows: Installation_top\eservice\esc\conf\services
- Linux: $EGO_TOP/eservice/esc/conf/services
When the environment variable is also defined, the value of SOAM_HISTORY_DISABLE_SESSION_SCALE_DOWN in sd.xml takes precedence over the value of sessionScaleDownDisabled in the application profile's section.
Where used:
Required or optional: Optional
Valid values: TRUE or FALSE
Default value: FALSE
Related attributes:- fsyncInterval: Interval (in seconds) at which to trigger task history file synchronization (fsync)
Description: Parameters related to task input message paging configurations.
- bitmapBits
- Description: For internal system use only.
- blockSize
- Description: Specifies the number of bytes per block for paging. The block size should be large
enough to contain the largest message. If the block size is not large enough, the data is spread
across multiple blocks, which can slow down paging processes.
Consider the size of the largest input message when determining the optimal blocksize for paging input tasks
Where used:
Required or optional: Optional
Valid values: 1 to 4294967295
Default value: 4096 bytes (4 KB)
- diskSpace
- Description: Maximum amount of disk space, in bytes, dedicated to paging task input
messages.
Where used:
Required or optional: Optional
Valid values: 1 to 18446744073709551615
Default value: 4294967296 bytes (4 GB)
- path
- Description: Directory where paging files for task input are stored. The path to the file can be
specified as a relative or absolute path. If a relative path is specified, paging files are saved in
a subdirectory relative to the session manager working directory. The specified directory must be
accessible from all management hosts to facilitate session manager
failover.You can define the SOAM_HOME and EGO_SHARED_TOP environment variables in the sd.xml configuration file. For example:
<ego:EnvironmentVariable name="SOAM_HOME">C:\Program Files\IBM\SpectrumComputing</ego:EnvironmentVariable> <ego:EnvironmentVariable name="EGO_SHARED_TOP">C:\Program Files\IBM\SpectrumComputing</ego:EnvironmentVariable>If you have one application profile to be deployed to more than one cluster, you can also define environment variables in the sd.xml file, in the section corresponding to the machine type of your management host. You can set five variables (SOAM_APP_PROFILE_1 to SOAM_APP_PROFILE_5). For example:<ego:EnvironmentVariable name="SOAM_APP_PROFILE_1">C:\mydirectory\var1</ego:EnvironmentVariable> <ego:EnvironmentVariable name="SOAM_APP_PROFILE_2">C:\mydirectory\var2</ego:EnvironmentVariable> <ego:EnvironmentVariable name="SOAM_APP_PROFILE_3">C:\mydirectory\var3</ego:EnvironmentVariable> <ego:EnvironmentVariable name="SOAM_APP_PROFILE_4">var4</ego:EnvironmentVariable> <ego:EnvironmentVariable name="SOAM_APP_PROFILE_5">var5</ego:EnvironmentVariable>Then, within the , , and sections of the application profile, you can call the variables you previously defined. For example:<DataHistory fileSwitchSize="100" lastingPeriod="96" path="${SOAM_APP_PROFILE_1}\${SOAM_APP_PROFILE_4}\${SOAM_APP_PROFILE_5}\dh"/> <PagingTasksInput blockSize="4096" diskSpace="4294967296" path="${SOAM_HOME}\work\${SOAM_APP_PROFILE_4}\pti"/> <JournalingTasks blockSize="4096" diskSpace="4294967296" path="${EGO_SHARED_TOP}\jt"/>Where used:
Required or optional: Optional
Valid values: Any accessible absolute or relative path on network or local disk that can be accessed from all management hosts.
Default value: By default, paging files are saved in the pagingdirectory under the session manager working directory.
Related attributes:- workDir (): The working directory of session manager.
- pmeType
- Description: For internal system use only.
Description: For internal system use only.
- name
- Description: For internal system use only.
- readPriority
- Description: For internal system use only.
- removePriority
- Description: For internal system use only.
- writePriority
- Description: For internal system use only.
Description: Parameters related to task input message paging configurations for non- recoverable sessions.
- bitmapBits
- Description: For internal system use only.
- blockSize
- Description: Specifies the number of bytes per block for paging. The block size should be large
enough to contain the largest message. If the block size is not large enough, the data is spread
across multiple blocks, which can slow down paging processes.
Consider the size of the largest input message when determining the optimal blocksize for paging input tasks
Where used:
Required or optional: Optional
Valid values: 1 to 4294967295
Default value: 4096 bytes (4 KB)
- diskSpace
- Description: Maximum amount of disk space, in bytes, dedicated to paging task input
messages.
Where used:
Required or optional: Optional
Valid values: 1 to 18446744073709551615
Default value: 4294967296 bytes (4 GB)
- path
- Description: Directory where paging files for task input are stored. The path to the file can be
specified as a relative or absolute path. If a relative path is specified, paging files are saved in
a subdirectory relative to the session manager working directory. To speed up paging and session
manager recovery, the specified directory can be on the local drive since the paged data of
irrecoverable sessions does not need to be persisted at a shared location.
Where used:
Required or optional: Optional
Valid values: Any accessible absolute or relative path on network or local disk.
Default value: By default, paging files are saved in the pagingdirectory under the session manager working directory.
Related attributes:- workDir (): The working directory of session manager.
- pmeType
- Description: For internal system use only.
Description: For internal system use only.
- name
- Description: For internal system use only.
- readPriority
- Description: For internal system use only.
- removePriority
- Description: For internal system use only.
- writePriority
- Description: For internal system use only.
Description: Parameters related to task output message paging configurations.
- bitmapBits
- Description: For internal system use only.
- blockSize
- Description: Specifies the number of bytes per block for paging. The block size should be large
enough to contain the largest message. If the block size is not large enough, the data is spread
across multiple blocks, which can slow down paging processes.
Consider the size of the largest output message when determining the optimal blocksize for paging output tasks.
Where used:
Required or optional: Optional
Valid values: 1 to 4294967295
Default value: 4096 bytes (4 KB)
- diskSpace
- Description: Maximum amount of disk space, in bytes, dedicated to paging task output
messages.
Where used:
Required or optional: Optional
Valid values: 1 to 18446744073709551615
Default value: 4294967296 bytes (4 GB)
- path
- Description: Directory where paging files for task output are stored. The path to the files can
be specified as a relative or absolute path. If a relative path is specified, paging files are saved
in a subdirectory relative to the session manager working directory. The specified directory must be
accessible from all management hosts to facilitate session manager failover.
Where used:
Required or optional: Optional
Valid values: Data files can be stored on any storage device accessible on the network. To facilitate failover, working files should be stored on a shared file system.IBM Spectrum Symphony
Default value: By default, paging files are saved in the paging directory under the session manager working directory.
Related attributes:- workDir (): The working directory of session manager.
- pmeType
- Description: For internal system use only.
Description: For internal system use only.
- name
- Description: For internal system use only.
- readPriority
- Description: For internal system use only.
- removePriority
- Description: For internal system use only.
- writePriority
- Description: For internal system use only.
Description: Parameters related to task output message paging configurations for irrecoverable sessions.
- bitmapBits
- Description: For internal system use only.
- blockSize
- Description: Specifies the number of bytes per block for paging. The block size should be large
enough to contain the largest message. If the block size is not large enough, the data is spread
across multiple blocks, which can slow down paging processes.
Where used:
Required or optional: Optional
Valid values: 1 to 4294967295
Default value: 4096 bytes (4 KB)
- diskSpace
- Description: Maximum amount of disk space, in bytes, dedicated to paging task output
messages.
Where used:
Required or optional: Optional
Valid values: 1 to 18446744073709551615
Default value: 4294967296 bytes (4 GB)
- path
- Description: Directory where paging files for task output are stored. The path to the files can
be specified as a relative or absolute path. If a relative path is specified, paging files are saved
in a subdirectory relative to the session manager working directory. To speed up paging and session
manager recovery, the specified directory can be on the local drive since the paged data of
irrecoverable sessions does not need to be persisted at a shared location.
Where used:
Required or optional: Optional
Valid values: Any accessible absolute or relative path on network or local disk.
Default value: By default, paging files are saved in the paging directory under the session manager working directory.
Related attributes:- workDir (): The working directory of session manager.
- pmeType
- Description: For internal system use only.
- name
- Description: For internal system use only.
- readPriority
- Description: For internal system use only.
- removePriority
- Description: For internal system use only.
- writePriority
- Description: For internal system use only.
Description: Parameters related to common data paging configurations.
- bitmapBits
- Description: For internal system use only.
- blockSize
- Description: Specifies the number of bytes per block for paging. The block size should be large
enough to contain the largest message. If the block size is not large enough, the data is spread
across multiple blocks, which can slow down paging processes.
Where used:
Required or optional: Optional
Valid values: 1 to 4294967295
Default value: 2048 bytes (2 KB)
- diskSpace
- Description: Maximum amount of disk space, in bytes, dedicated to paging.
Where used:
Required or optional: Optional
Valid values: 1 to 18446744073709551615
Default value: 8589934592 bytes (8 GB)
- path
- Description: Directory where paging files are stored for common data. The path to the files can
be specified as a relative or absolute path. If a relative path is specified, common data files are
saved in a subdirectory relative to the session manager working directory. The specified directory
must be accessible from all management hosts to facilitate session manager failover.
Where used:
Required or optional: Optional
Valid values: Any accessible from all management hosts.
Related attributes:- workDir (): The working directory of session manager.
- pmeType
- Description: For internal system use only.
- name
- Description: For internal system use only.
- readPriority
- Description: For internal system use only.
- removePriority
- Description: For internal system use only.
- writePriority
- Description: For internal system use only.
Description: Parameters related to common data paging configurations.
- bitmapBits
- Description: For internal system use only.
- blockSize
- Description: Specifies the number of bytes per block for paging. The block size should be large
enough to contain the largest message. If the block size is not large enough, the data is spread
across multiple blocks, which can slow down paging processes.
Where used:
Required or optional: Optional
Valid values: 1 to 4294967295
Default value: 15360 bytes (15 KB)
- diskSpace
- Description: Maximum amount of disk space, in bytes, dedicated to paging.
Where used:
Required or optional: Optional
Valid values: 1 to 18446744073709551615
Default value: 4294967296 bytes (4 GB)
- path
- Description: Directory where paging files are stored for common data. The path to the files can
be specified as a relative or absolute path. If a relative path is specified, common data files are
saved in a subdirectory relative to the session manager working directory. The specified directory
must be accessible from all management hosts to facilitate session manager failover.
Where used:
Required or optional: Optional
Valid values: Any accessible from all management hosts.
Related attributes:- workDir (): The working directory of session manager.
- pmeType
- Description: For internal system use only.
- name
- Description: For internal system use only.
- readPriority
- Description: For internal system use only.
- removePriority
- Description: For internal system use only.
- writePriority
- Description: For internal system use only.
Description: Parameters related to common data paging configurations.
- bitmapBits
- Description: For internal system use only.
- blockSize
- Description: Specifies the number of bytes per block for paging. The block size should be large
enough to contain the largest message. If the block size is not large enough, the data is spread
across multiple blocks, which can slow down paging processes.
Consider the size of the largest common data message when determining the optimal block size for paging common data.
Where used:
Required or optional: Optional
Valid values: 1 to 4294967295
Default value: 102400 bytes (100 KB)
- diskSpace
- Description: Specifies the maximum amount of disk space, in bytes, dedicated to paging.
Where used:
Required or optional: Optional
Valid values: 1 to 18446744073709551615
Default value: 8589934592 bytes (8 GB)
- path
- Description: Directory where the files are stored for common data. The path to the files can be
specified as a relative or absolute path. If a relative path is specified, common data files are
saved in a subdirectory relative to the session manager working directory. The specified directory
must be accessible from all management hosts to facilitate session manager failover.
Where used:
Required or optional: Optional
Valid values: Data files can be stored on any storage device accessible on the network. To facilitate failover, IBM Spectrum Symphony working files should be stored on a shared file system.
Default value: By default, paging files are saved in the paging directory under the session manager working directory.
Related attributes:- workDir (): The working directory of session manager.
- pmeType
- Description: For internal system use only.
Description: For internal system use only.
- name
- Description: For internal system use only.
- readPriority
- Description: For internal system use only.
- removePriority
- Description: For internal system use only.
- writePriority
- Description: For internal system use only.
Parameters related to common data paging configurations for irrecoverable sessions.
- bitmapBits
- Description: For internal system use only.
- blockSize
- Description: Specifies the number of bytes per block for paging. The block size should be large
enough to contain the largest message. If the block size is not large enough, the data is spread
across multiple blocks, which can slow down paging processes.
Consider the size of the largest common data message when determining the optimal block size for paging common data.
Where used:
Required or optional: Optional
Valid values: 1 to 4294967295
Default value: 102400 bytes (100 KB)
- diskSpace
- Description: Specifies the maximum amount of disk space, in bytes, dedicated to paging.
Where used:
Required or optional: Optional
Valid values: 1 to 18446744073709551615
Default value: 8589934592 bytes (8 GB)
- path
- Description: Directory where the files are stored for common data. The path to the files can be
specified as a relative or absolute path. If a relative path is specified, common data files are
saved in a subdirectory relative to the session manager working directory. To speed up paging and
session manager recovery, the specified directory can be on the local drive since the paged data of
irrecoverable sessions does not need to be persisted at a shared location.
Where used: SOAMPagingCommonDataNonRec
Required or optional: Optional
Valid values: Any accessible absolute or relative path on network or local disk.
Default value: By default, paging files are saved in the paging directory under the session manager working directory.
Related attributes:- workDir (): The working directory of session manager.
- pmeType
- Description: For internal system use only.
Description: For internal system use only.
- name
- Description: For internal system use only.
- readPriority
- Description: For internal system use only.
- removePriority
- Description: For internal system use only.
- writePriority
- Description: For internal system use only.
Parameters related to common data updates paging configurations.
- bitmapBits
- Description: For internal system use only.
- blockSize
- Description: Specifies the number of bytes per block for paging. The block size should be large
enough to contain the largest message. If the block size is not large enough, the data is spread
across multiple blocks, which can slow down paging processes.
Consider the size of the largest common data update message when determining the optimal block size for paging common data updates.
Where used:
Required or optional: Optional
Valid values: 1 to 4294967295
Default value: 102400 bytes (100 KB)
- diskSpace
- Description: Specifies the maximum amount of disk space, in bytes, dedicated to paging.
Where used:
Required or optional: Optional
Valid values: 1 to 18446744073709551615
Default value: 8589934592 bytes (8GB)
- path
- Description: Directory where the files are stored for common data updates. The path to the files
can be specified as a relative or absolute path. If a relative path is specified, common data update
files are saved in a subdirectory relative to the session manager working directory. The specified
directory must be accessible from all management hosts to facilitate session manager
failover.
Where used:
Required or optional: Optional
Valid values: Data files can be stored on any storage device accessible on the network. To facilitate failover, IBM Spectrum Symphony working files should be stored on a shared file system.
Default value: By default, paging files are saved in the pagingdirectory under the session manager working directory.
Related attributes:- workDir (): The working directory of session manager.
- pmeType
- Description: For internal system use only.
Description: For internal system use only.
- name
- Description: For internal system use only.
- readPriority
- Description: For internal system use only.
- removePriority
- Description: For internal system use only.
- writePriority
- Description: For internal system use only.
Description: Parameters related to common data updates paging configurations for irrecoverable sessions.
- bitmapBits
- Description: For internal system use only.
- blockSize
- Description: Specifies the number of bytes per block for paging. The block size should be large
enough to contain the largest message. If the block size is not large enough, the data is spread
across multiple blocks, which can slow down paging processes.
Consider the size of the largest common data update message when determining the optimal block size for paging common data updates.
Where used:
Required or optional: Optional
Valid values: 1 to 4294967295
Default value: 102400 bytes (100 KB)
- diskSpace
- Description: Specifies the maximum amount of disk space, in bytes, dedicated to paging.
Where used:
Required or optional: Optional
Valid values: 1 to 18446744073709551615
Default value: 8589934592 bytes (8 GB)
- path
- Description: Directory where the files are stored for common data updates. The path to the files
can be specified as a relative or absolute path. If a relative path is specified, common data update
files are saved in a subdirectory relative to the session manager working directory. To speed up
paging and session manager recovery, the specified directory can be on the local drive since the
paged data of irrecoverable sessions does not need to be persisted at a shared location.
Where used:
Required or optional: Optional
Valid values: Any accessible absolute or relative path on network or local disk.
Default value: By default, paging files are saved in the paging directory under the session manager working directory.
Related attributes:- workDir (): The working directory of session manager.
- pmeType
- Description: For internal system use only.
Description: For internal system use only.
- name
- Description: For internal system use only.
- readPriority
- Description: For internal system use only.
- removePriority
- Description: For internal system use only.
- writePriority
- Description: For internal system use only.
Description: For internal system use only.
- bitmapBits
- Description: For internal system use only.
- blockSize
- Description: For internal system use only.
- diskSpace
- Description: For internal system use only.
- path
- Description: For internal system use only.
- pmeType
- Description: For internal system use only.
Description: For internal system use only.
- bitmapBits
- Description: For internal system use only.
- blockSize
- Description: For internal system use only.
- diskSpace
- Description: For internal system use only.
- path
- Description: For internal system use only.
- pmeType
- Description: For internal system use only.
Description: For internal system use only.
- bitmapBits
- Description: For internal system use only.
- blockSize
- Description: For internal system use only.
- diskSpace
- Description: For internal system use only.
- path
- Description: For internal system use only.
- pmeType
- Description: For internal system use only.
Description: For internal system use only.
- bitmapBits
- Description: For internal system use only.
- blockSize
- Description: For internal system use only.
- diskSpace
- Description: For internal system use only.
- path
- Description: For internal system use only.
- pmeType
- Description: For internal system use only.
Description: Specifies a set of parameters to run a retry task on a host other than the one on which the retry task failed, and to block hosts that have a higher task failure rate.
- heuristicHostBlock
-
Description: Enables or disables heuristic host blocking. When heuristic host blocking is enabled:
- For IBM Spectrum Symphony workload, the SSM monitors the task failure number on the host and blocks the hosts if its task failure number exceeds a threshold.
- For MapReduce workload, the application manager (SSM) monitors the task failure rate on each host in the cluster and blocks hosts if the task failure rate exceeds a threshold. The task fail rate is determined by the total number of task failures on a host in relation to the total number of task failures on other hosts that are being used by the application.
Where used:
Required or optional: Optional
Valid values: true or false
Default value:- For IBM Spectrum Symphony workload: false
- For MapReduce workload: true
- heuristicHostBlockJoinPeriod
-
Description: This value applies only to MapReduce workload. When heuristic host blocking is enabled for a MapReduce application, specifies the duration (in minutes) of a host’s failure factor that must be counted into the average value after the host joins the application manager (SSM).
Where used:
Required or optional: Optional
Valid values: 1 to 4294967295. A value of 0 resets the threshold to its default value.
Default value: 15
- heuristicHostBlockMonitorPeriod
-
Description: When heuristic host blocking is enabled, records the number of failed tasks on hosts for IBM Spectrum Symphony workload and the task failure factor for MapReduce workload in the latest specified period (in minutes). For example, if the monitoring period is set to three hours, the SSM monitors task failures in the last three hours on each host.
Where used:
Required or optional: Optional
Valid values: 1 to 4294967295. A value of 0 resets the monitoring period to its default value.
Default value: 180
- heuristicHostFailureFactorPercentThreshold
- Description: This value applies only to MapReduce workload. When heuristic host blocking is
enabled for a MapReduce application, specifies the number of task failures that a host must reach as
a percentage over the average number of task failures for all hosts assigned to the application
before the host is blocked. So if the threshold is set to 0.5 (50%), a host must have an amount of
task failures that exceeds the average of all hosts assigned to the application by 50% before it is
blocked.
Where used:
Required or optional: Optional
Valid values: Any double numeric data type. A value of 0 resets the threshold to its default value.
Default value: 0.5 (which is equivalent to 50%)
- heuristicHostFailureFactorThreshold
-
Description: When heuristic host blocking is enabled, specifies the number of task failures allowed per slot on a host for IBM Spectrum Symphony workload and the task failure factor allowed per slot on a host for MapReduce workload.
Where used:
Required or optional: Optional
Valid values: 1 to 4294967295. A value of 0 resets the threshold to its default value.
Default value:- For IBM Spectrum Symphony workload: 3
- For MapReduce workload: 1
- releaseAllSlotsOnBlockedHost
-
Description: Enables the release of slots assigned to a blocked host. When this attribute is enabled and a host is blocked, the SSM gradually releases any slots assigned to that host even as running tasks complete on the host.
Where used:
Required or optional: Optional
Valid values: true or false
Default value:- For IBM Spectrum Symphony workload: false
- For MapReduce workload: true
- retryTaskFailedHostListSize
- Description: To trace the hosts on which a retry task recently failed, IBM Spectrum Symphony maintains a retried-host
list for each task. This attribute configures the size of the retried-host list. If a retry task
fails on a host, that hostname is added to the retried-host list of this task. If the retried-host
list is full, the oldest entry in the list is replaced by the new one. The retried-host list of a
new task is empty.
Where used:
Required or optional: Optional
Valid values: 1 to 2147483647
Default value: 10
- retryTaskOnDiffHost
- Description: Enables or disables retry tasks from being assigned to the same host on which the
task failed. If IBM Spectrum Symphony
attempts a retry task again, that task is forced to run on a different compute host.
Where used:
Required or optional: Optional
Valid values: true or false
Default value: true
- retryTaskOnDiffHostLastingPeriod
- Specifies the interval (in seconds) after which a retry task can run again on a different
compute host,
if
the host is already assigned to SSM (the IBM Spectrum Symphony session manager). A value
of 0 disables retrying tasks on a different host; a positive value enables retrying tasks on the
host, every postiive_value seconds (for example, setting this parameter to
5 indicates retrying the task on a different host every five
seconds.
Where used:
Required or optional: Optional
Valid values: 0 to 2147483647
Default value:- For IBM Spectrum Symphony workload: 0, which disables retrying tasks on a different compute host
- For MapReduce workload: 30, which enables retrying tasks on a different compute host every 30 seconds
- version
- Description: The version of the IBM Spectrum Symphony middleware.
Where used: SOAM
Required or optional: Optional. When the version is not included, the application will run on the latest version of IBM Spectrum Symphony available in the cluster.
Valid values: 4.0 or higher
Example: version="7.3.2"