Readme File for IBM® Spectrum Symphony 7.3.1 RFE SPCS-I-959
Readme File for: IBM Spectrum Symphony
Product Release: 7.3.1
Update Name: Interim Fix 601596
Fix ID: sym-7.3.1-build601596-jpmc
Publication Date: June
20, 2023
Enhancement to support the EGO_SERVICE_CREDENTIAL parameter to log onto the IBM Spectrum
Symphony Host Factory REST server for authentication.
Contents
1.
Scope
2.
Installation and configuration
3.
Uninstallation
4.
List of files
5.
Product notifications
6.
Copyright and trademark information
Before you install this enhancement to your cluster, note the following
requirements:
|
Operating system |
Linux 64-bit |
|
Product version |
IBM Spectrum Symphony 7.3.1 |
Follow these instructions to
download and install this interim fix on the management hosts in your cluster.
System requirements
Linux
x86_64
Installation
a.
Source the host environment:
(bash) >
source $EGO_TOP/profile.platform
(csh) >
source $EGO_TOP/cshrc.platform
b. Log on to the primary host as the
cluster administrator:
> egosh user logon -u Admin -x password
c. Stop the HostFactory
service:
> egosh service stop HostFactory
d.
On each management host, create a directory (for example, /symfixes) and download the hfcore-1.1.0.0_x86_64_build601596.tar.gz package to the directory.
e. Use the egoinstallfixes command to install the hfcore-1.1.0.0_x86_64_build601596.tar.gz package:
> egoinstallfixes /symfixes/hfcore-1.1.0.0_x86_64_build601596.tar.gz --silent
Important: Running
the egoinstallfixes command automatically backs up the current binary files to a fix backup
directory. For recovery purposes of the original file, do not delete this
backup directory. For more information on using this command, see the egoinstallfixes command reference.
f.
Use
the pversions command to verify the installation:
> pversions -b 601596
Configuration
a. On one management host, modify $EGO_CONFDIR/../../hostfactory/conf/hostfactoryconf.json file, by adding the HF_REST_AUTH_EGO_SERVICE_CREDENTIAL parameter
with a value of Y as: "HF_REST_AUTH_EGO_SERVICE_CREDENTIAL":
"Y", for example:
{
"HF_LOGLEVEL":
"LOG_TRACE",
"HF_LOG_MAX_FILE_SIZE": 10,
"HF_LOG_MAX_ROTATE":
5,
"HF_REQUESTOR_POLL_INTERVAL": 30,
"HF_HOUSEKEEPING_LOOP_INTERVAL": 30,
"HF_REST_TRANSPORT":
"TCPIPv4SSL",
"HF_REST_LISTEN_PORT":
9443,
"HF_REST_TRANSPORT_ARG": "$EGO_DEFAULT_TS_PARAMS",
"HF_REQUESTOR_ACTION_TIMEOUT": 240,
"HF_PROVIDER_ACTION_TIMEOUT": 300,
"HF_DB_HISTORY_DURATION": 90,
"HF_REST_RESULT_DEFAULT_PAGESIZE": 2000,
"HF_REST_RESULT_MAX_PAGESIZE": 10000,
"HF_DEMAND_BATCH_LIMIT":
100,
"HF_RETURN_BATCH_LIMIT": 100,
"HF_REST_AUTH_EGO_SERVICE_CREDENTIAL":
"Y"
}
If you configure an
unsupported value for HF_REST_AUTH_EGO_SERVICE_CREDENTIAL,
the HostFactory service will fail to start. Valid values are Y or N.
b.
On one
management host, modify the custom service profile (for example custom.xml) under the $EGO_CONFDIR/../../eservice/esc/conf/services directory, and set the NeedCredential parameter as TRUE, in the <ServiceDefinition> section:
<sc:NeedCredential>TRUE</sc:NeedCredential>
c.
Run the egosh
service command so that the service profile
updates take effect:
> egosh service modify service_name -f custom.xml
where:
o
service_name is the service name defined in the custom.xml file.
o
custom.xml is the service profile file which defines
the service_name.
d.
Determine
the EGO_SERVICE_CREDENTIAL value by checking /proc/process_id/environ.
For example:
EGO_SERVICE_CREDENTIAL=Version:1.0#133#Admin#xwf0stvx-93y7-7ode-i3sv-hkldtobzbtfy
where:
o
process_id is the process id of the custom service.
e.
Call
the Host Factory RESTful API using curl and the EGO_SERVICE_CREDENTIAL value. Here is an example of getting host templates:
curl
--header 'hfegoservicetoken: Version:1.0#133#Admin#xwf0stvx-93y7-7ode-i3sv-hkldtobzbtfy' --cacert
/opt/ibm/spectrumcomputing/wlp/usr/shared/resources/security/cacert.pem
--tlsv1.2 -X GET https://myprimaryhost.example.com:9443/platform/rest/hostfactory/provider/awsinst/templates
If required, follow these instructions to uninstall this enhancement from management hosts in your cluster.
a.
Source the host environment:
(bash) >
. $EGO_TOP/profile.platform
(csh) >
source $EGO_TOP/cshrc.platform
b. Log on to the primary host as the
cluster administrator:
> egosh user logon -u Admin -x password
c. Stop the HostFactory
service:
> egosh service stop HostFactory
d.
Log on to each management host and roll back
this enhancement:
> egoinstallfixes -r 601596
e.
Remove this
enhancement configurations from $EGO_CONFDIR/../../hostfactory/conf/hostfactoryconf.json and $EGO_CONFDIR/../../eservice/esc/conf/services/custom.xml
files.
f.
Start the HostFactory service:
> egosh service start HostFactory
To receive information about product solution and patch updates automatically, subscribe to product notifications on the My Notifications page http://www.ibm.com/support/mynotifications/ on the IBM Support website (http://support.ibm.com). You can edit your subscription settings to choose the types of information you want to get notification about, for example, security bulletins, fixes, troubleshooting, and product enhancements or documentation changes.
© Copyright IBM Corporation 2023
U.S. Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
IBM®, the IBM logo and ibm.com® are trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at "Copyright and trademark information" at www.ibm.com/legal/copytrade.shtml.