ego.cluster_name.entitlement.acct file

The ego.cluster_name.entitlement.acct file is installed with the IBM® Spectrum Symphony at:

• %EGO_CONFDIR\..\audit\ on Windows.
• $EGO_CONFDIR/../audit/ on Linux®.

Control the settings that determine core-hour usage metrics by configuring the following licensing parameters in ego.conf (see the ego.conf reference):

EGO_LICENSE_COREHOURS_MONITOR_INTERVAL_MINUTES

Interval at which core-hour usage is monitored and logged to the cluster.hostusage file; default is 5 minutes. The cluster.hostusage file (located at %EGO_CONFDIR%\..\work\data\ on Windows and $EGO_CONFDIR/../work/data/ on Linux) logs detailed core-hour metrics at a more frequent interval than that logged to the ego.cluster_name.entitlement.acct file and is also used for recovery purposes.

EGO_LICENSE_CORE_ENTITLEMENT

Maximum number of cores that can be entitled in a cluster. Default is 0, which indicates that all cloud hosts with the corehoursaudit resource attribute are counted only for core-hour usage. Define this parameter if you want to use a combination of perpetual licenses and variable use licenses for your cloud hosts. When defined, cloud hosts that join the cluster are licensed by cores, up to the specified entitlement. After all perpetual licenses are used, cloud hosts that join the cluster are licensed by core hours.

EGO_LICENSE_COREHOURS_CONSOLIDATION

Enables the collection of core-hour license usage information, that can later be consolidated with information from other clusters, to produce the usage of multiple clusters in one view. An administrator can then use this auditing information to calculate usage, and determine whether more licenses are required. Default is N to disable data collection and consolidation with other clusters.

To collect and consolidate usage information from all clusters, follow this flow:

1. Set EGO_LICENSE_COREHOURS_CONSOLIDATION=Y on each IBM Spectrum Symphony cluster that you want to consolidate usage information.
2. Regularly (that is, monthly) collect the cluster.hostusage file from each cluster, and place the files into a single work directory. Note that the maximum number of days to retain core-hour usage records in the cluster.hostusage file is 35 days (that is, the data is purged every 35 days); therefore, ensure that you collect the cluster.hostusage file from each cluster at least every 35 days. Alternatively, to retain records for more than 35 days, increase the EGO_LICENSE_WORK_FILE_PURGE_DAYS parameter to a value greater than 35 (the default is 2 days).
3. Run egolic commands to manage this information:
   • Run the egolic merge command to collect usage data for a specific cluster into a cluster.hostusage.cluster_name file. If the cluster.hostusage.cluster_name already exists, merges the new usage data with existing information.
   • Run the egolic report command to generate usage reports for all clusters. IBM Spectrum Symphony processes the data for the reports, using the values set in the $EGO_CONFDIR/egolic.json configuration file. (If the $EGO_CONFDIR location is not defined in the environment, the egolic.json will be in the current working directory.) This example egolic.json file shows the format of the file:

     {
         "logLevel": "LOG_INFO",
         "maxLogSizeMB": 100,
         "maxLogRotate":  10,
         "logDir": "${EGO_TOP}/kernel/log",
         "workDir": "${EGO_CONFDIR}/../work/data",
         "perpetualMaxCores": 1
     }
     

EGO_LICENSE_GPUCORE_ENTITLEMENT

Maximum number of GPU cores that can be entitled when a cluster is licensed for IBM Spectrum Symphony GPU Harvesting. Default is 0, which indicates that all cloud hosts with the corehoursaudit resource attribute are counted only for GPU core-hour usage. Define this parameter if you want to use a combination of GPU perpetual licenses and GPU variable use licenses for your cloud hosts. When defined, cloud hosts that join the cluster are licensed by GPU cores, up to the specified entitlement. After all GPU perpetual licenses are used, cloud hosts that join the cluster are licensed by GPU core hours.

EGO_LICENSE_WORK_FILE_PURGE_DAYS

Maximum number of days to retain core-hour usage records in the cluster.hostusage file; default is 2 days. Update this parameter if you want to retain the records for more than 2 days.

The license audit log file is an ASCII file with one record per line. The fields of each record are separated by blanks. The fields in order of occurrence are as follows:

timestamp

Time stamp of the logged event (in seconds since the epoch).

edition

The edition of IBM Spectrum Symphony. Valid values:

• SYM_STANDARD_EDITION
• SYM_ADVANCED_EDITION

version

The version of IBM Spectrum Symphony.

ncpus

Peak usage value in number of CPUs. Maximum CPUs in the past day for these hosts which are not tagged with the corehoursaudit resource attribute.

ngpus

If the IBM Spectrum Symphony GPU Harvesting add-on is entitled, peak usage value in number of GPUs. Maximum GPUs in the past day for these hosts which are not tagged with the corehoursaudit resource attribute.

corehours

Number of core hours that are used by cloud hosts during the last reporting interval for core-hour usage monitoring. The total core hours value in the past day for these hosts which are tagged with the corehoursaudit resource attribute.

gpuhours

If IBM Spectrum Symphony GPU Harvesting is entitled, number of GPU core hours used by cloud hosts during the last reporting interval for core-hour usage monitoring. The total GPU hours value in the past day for these hosts which are tagged with the corehoursaudit resource attribute.

hosthours

The total host hours value in the past day for these hosts which are tagged with the corehoursaudit resource attribute.

sockethours

The total socket hours value in the past day for these hosts which are tagged with the corehoursaudit.

hash

Line encryption that is used to authenticate the record.

Example when no GPU entitlement file is set:

1597410004 SYM_ADVANCED_EDITION 7.3.2 ncpus:32,corehours:1.1,hosthours:0.1,sockethours:0.1 37f632c725d635ab56d5908484789bd4ee5592f7
1597413600 SYM_ADVANCED_EDITION 7.3.2 ncpus:32,corehours:16.0,hosthours:1.0,sockethours:2.0 16b602832ac7621b7b36009961bcfb7f40ac81df
1597417202 SYM_ADVANCED_EDITION 7.3.2 ncpus:32,corehours:16.0,hosthours:1.0,sockethours:2.0 8df5b1a9c1ea0154c5995c3cc78e559176574c9b

Example when a GPU entitlement file is set:

1597305602 SYM_ADVANCED_EDITION 7.3.2  ncpus:76,ngpus:1,corehours:0.0,gpuhours:0.0,hosthours:0.0,sockethours:0.0 e9f198c810a3770f4f92fb6f68e3f777c467043f
1597309504 SYM_ADVANCED_EDITION 7.3.2  ncpus:76,ngpus:1,corehours:40.0,gpuhours:0.7,hosthours:1.3,sockethours:2.7 d5bbbf497fdb47f6993cd22842184d88e9416f07
1597312802 SYM_ADVANCED_EDITION 7.3.2  ncpus:16,ngpus:0,corehours:55.0,gpuhours:0.9,hosthours:1.8,sockethours:3.7 02eb17517cf56d18e8a9fbbcf661a723d10532a3