Cluster Server Agent For Ibm Infosphere Datastage Installation and Configuration Guide
Cluster Server Agent For Ibm Infosphere Datastage Installation and Configuration Guide
Cluster Server Agent For Ibm Infosphere Datastage Installation and Configuration Guide
Linux, Solaris
7.0
Veritas InfoScale Availability Agents
Last updated: 2017-06-30
Legal Notice
Copyright © 2017 Veritas Technologies LLC. All rights reserved.
Veritas and the Veritas Logo are trademarks or registered trademarks of Veritas Technologies
LLC or its affiliates in the U.S. and other countries. Other names may be trademarks of their
respective owners.
This product may contain third party software for which Veritas is required to provide attribution
to the third party (“Third Party Programs”). Some of the Third Party Programs are available
under open source or free software licenses. The License Agreement accompanying the
Software does not alter any rights or obligations you may have under those open source or
free software licenses. Refer to the third party legal notices document accompanying this
Veritas product or available at:
https://www.veritas.com/about/legal/license-agreements
The product described in this document is distributed under licenses restricting its use, copying,
distribution, and decompilation/reverse engineering. No part of this document may be
reproduced in any form by any means without prior written authorization of Veritas Technologies
LLC and its licensors, if any.
The Licensed Software and Documentation are deemed to be commercial computer software
as defined in FAR 12.212 and subject to restricted rights as defined in FAR Section 52.227-19
"Commercial Computer Software - Restricted Rights" and DFARS 227.7202, et seq.
"Commercial Computer Software and Commercial Computer Software Documentation," as
applicable, and any successor regulations, whether delivered by Veritas as on premises or
hosted services. Any use, modification, reproduction release, performance, display or disclosure
of the Licensed Software and Documentation by the U.S. Government shall be solely in
accordance with the terms of this Agreement.
http://www.veritas.com
Technical Support
Technical Support maintains support centers globally. All support services will be delivered
in accordance with your support agreement and the then-current enterprise technical support
policies. For information about our support offerings and how to contact Technical Support,
visit our website:
https://www.veritas.com/support
You can manage your Veritas account information at the following URL:
https://my.veritas.com
If you have questions regarding an existing support agreement, please email the support
agreement administration team for your region as follows:
Japan CustomerCare_Japan@veritas.com
Documentation
Make sure that you have the current version of the documentation. Each document displays
the date of the last update on page 2. The latest documentation is available on the Veritas
website:
https://sort.veritas.com/documents
Documentation feedback
Your feedback is important to us. Suggest improvements or report errors or omissions to the
documentation. Include the document title, document version, chapter title, and section title
of the text on which you are reporting. Send feedback to:
xyz@veritas.com
You can also see documentation information or ask a question on the Veritas community site:
http://www.veritas.com/community/
https://sort.veritas.com/data/support/SORT_Data_Sheet.pdf
Contents
Index .................................................................................................................... 37
Chapter 1
Introducing the agent for
IBM InfoSphere DataStage
This chapter includes the following topics:
■ Supported software
Supported software
For information on the software versions that the Cluster Server agent for IBM
InfoSphere DataStage supports, see the Veritas Services and Operations Readiness
Tools (SORT) site: https://sort.veritas.com/agents.
component processes are present in the process table. Process check cannot
detect whether processes are in the hung or stopped states.
■ Secondary or Detail monitoring
In this mode, the agent runs a utility to verify the status of the InfoSphere
DataStage component. The agent detects application failure if the monitoring
routine reports an improper function of the InfoSphere DataStage component
processes. When this application failure occurs, the InfoSphere DataStage
component service group fails over to another node in the cluster.
In addition to these levels of application monitoring, the agent for IBM InfoSphere
DataStage is IMF-aware and uses asynchronous monitoring framework (AMF)
kernel driver for IMF notification.
Thus, the agent ensures high availability for InfoSphere DataStage components.
Online
The online function performs the following tasks:
■ Verifies that the required attributes are set correctly.
■ Verifies that the InfoSphere DataStage component is not already online. If the
component is online, the online operation exits immediately.
■ If any InfoSphere DataStage component processes remain, the operation kills
these processes using the user name associated with the specific resource.
■ Depending on the InfoSphere DataStage component that is configured, the
agent attempts to start the InfoSphere DataStage component with the command:
ASBNodeAgent InfoSphereInstanceDir/ASBNode/bin/NodeAgents.sh\
start
ASBLoggingAgent InfoSphereInstanceDir/ASBNode/bin/NodeAgents.sh\
startLogging
Offline
The offline function performs the following tasks:
■ Verifies that the required attributes are set correctly.
■ Verifies that the InfoSphere DataStage component is not offline.
If the instance is already offline, the operation verifies if any processes belonging
to this InfoSphere resource exist.
■ Depending on the InfoSphere DataStage component that is configured, the
agent attempts to stop the InfoSphere DataStage component with the command:
ASBNodeAgent InfoSphereInstanceDir/ASBNode/bin/NodeAgents.sh\
stopAgent
ASBLoggingAgent InfoSphereInstanceDir/ASBNode/bin/NodeAgents.sh\
stop
Monitor
The monitor function monitors the states of the InfoSphere servers on all nodes
within the cluster. The operation performs the following tasks:
■ The monitor function conducts a first-level check to determine that the InfoSphere
server processes are running on the system in the cluster. If the first-level check
does not find these processes running on the node, the check exits immediately
and reports the instance as OFFLINE.
The agent for InfoSphere also supports Intelligent Monitoring Framework (IMF)
in the first-level check. IMF enables intelligent resource monitoring. See “How
the agent supports intelligent resource monitoring” on page 8. You can use
the MonitorFreq key of the IMF attribute to specify the frequency at which the
agent invokes the monitor function.
■ If in-depth monitoring is enabled, the monitor operation conducts a second-level
check. During this check, the agent attempts to see if the InfoSphere DataStage
component is listening on the port of a particular host by using the socket method.
■ Depending upon the value of the MonitorProgram attribute, the monitor operation
can perform a customized check using a user-supplied monitoring utility.
Clean
In case of a failure or after an unsuccessful attempt to bring an InfoSphere
DataStage component online or take an InfoSphere DataStage component offline,
the clean operation performs the following tasks:
■ Depending on the InfoSphere DataStage component that is configured, the
agent attempts to gracefully shut down the InfoSphere DataStage component
with the command:
Introducing the agent for IBM InfoSphere DataStage 11
IBM InfoSphere DataStage agent functions
ASBNodeAgent InfoSphereInstanceDir/ASBNode/bin/NodeAgents.sh\
stopAgent
ASBLoggingAgent InfoSphereInstanceDir/ASBNode/bin/NodeAgents.sh\
stop
imf_init
This function initializes the IBM InfoSphere DataStage agent to interface with the
AMF kernel driver, which is the IMF notification module for the agent for IBM
InfoSphere DataStage. This function runs when the agent starts up.
imf_getnotification
This function gets notifications about resource state changes. This function runs
after the agent initializes with the AMF kernel module. This function continuously
waits for notification and takes action on the resource upon notification.
imf_register
This function registers or unregisters resource entities with the AMF kernel module.
This function runs for each resource after the resource goes into a steady
state—online or offline.
Chapter 2
Installing, upgrading, and
removing the agent for
IBM InfoSphere DataStage
This chapter includes the following topics:
■ Before you install the Cluster Server agent for IBM InfoSphere DataStage
To install or update the ACC Library package, locate the library and related
documentation in the Agent Pack tarball,
See “Installing the ACC library” on page 13.
Note: The LogDbg attribute should be used to enable debug logs for the
ACCLib-based agents when the ACCLib version is 6.2.0.0 or later and VCS version
is 6.2 or later.
Linux cd1/linux/generic/vcs/application/acc_library/version_library/rpms
Solaris cd1/solaris/dist_arch/vcs/application/acc_library/version_library/pkgs
Installing, upgrading, and removing the agent for IBM InfoSphere DataStage 14
Installing the agent in a VCS environment
4 If you downloaded the individual ACCLib tar file, navigate to the pkgs directory
(for AIX and Solaris), or rpms directory (for Linux).
5 Install the package. Enter Yes, if asked to confirm overwriting of files in the
existing package.
Linux # rpm -i \
VRTSacclib-VersionNumber-GA_GENERIC.noarch.rpm
Note: The LogDbg attribute should be used to enable debug logs for the
ACCLib-based agents when the ACCLib version is 6.2.0.0 or later and VCS
version is 6.2 or later.
Linux cd1/linux/generic/vcs/application/infosphere_agent/
vcs_version/version_agent/rpms
Solaris cd1/solaris/dist_arch/vcs/application/infosphere_agent/
vcs_version/version_agent/pkgs
If you downloaded the individual agent tar file, navigate to the pkgs directory
(for AIX and Solaris), or rpms directory (for Linux).
4 Log in as a superuser.
Installing, upgrading, and removing the agent for IBM InfoSphere DataStage 15
Uninstalling the agent in a VCS environment
6 After installing the agent package, you must import the agent type configuration
file.
# haconf -makerw
3 Remove all InfoSphere resources from the cluster. Run the following command
to verify that all resources have been removed:
4 Remove the agent type from the cluster configuration by running the following
command from any node in the cluster:
Removing the agent’s type file from the cluster removes the include statement
for the agent from the main.cf file, but the agent's type file is not removed
from the cluster configuration directory. You can remove the agent’s type file
later from the cluster configuration directory.
Installing, upgrading, and removing the agent for IBM InfoSphere DataStage 16
Removing the ACC library
5 Save these changes. Then set the cluster configuration mode to read-only by
running the following command from any node in the cluster:
6 Use the platform's native software management program to remove the agent
for IBM InfoSphere DataStage from each node in the cluster.
Run the following command to uninstall the agent:
■ About configuring the Cluster Server agent for IBM InfoSphere DataStage
You can import the agent types file using the Cluster Server graphical user interface
or via the command line interface.
To import the agent types file using the VCS graphical user interface
1 Start the Cluster Manager and connect to the cluster on which the agent is
installed.
2 Click File > Import Types.
3 In the Import Types dialog box, select the following file:
Linux /etc/VRTSagents/ha/conf/InfoSphere/InfoSphereTypes.cf
4 Click Import.
5 Save the VCS configuration.
The InfoSphere agent type is now imported to the VCS engine.
You can now create InfoSphere resources. For additional information about
using the VCS GUI, refer to the Cluster Server Administrator's Guide.
To import the agent types file using the Cluster Server command line interface
(CLI):
1 Log on to any one of the systems in the cluster as the superuser.
2 Run the following command:
# sh /etc/VRTSagents/ha/conf/InfoSphere/InfoSphereTypes.cmd
3 To verify that the agent types file is successfully imported to the VCS engine,
run the following command:
# hatype -display InfoSphere
Attribute Description
ResLogLevel Specifies the logging detail that the agent performs for the resource.
The valid values are as follows:
Example: INFO
Component Specifies the engine tier component for which the resource must
be configured.
The possible values are as follows:
■ DSEngine
■ ASBNodeAgent
■ ASBLoggingAgent
Example: DSEngine
User The OS user to run commands for starting engine tier components,
such as DSEngine, ASBNode Agent and ASB Logging Agent.
InfoSphereInstanceDir The absolute path of the directory where the DataStage instance
of the InfoSphere Information Server is installed.
Example: /opt/IBM/InformationServer
Configuring the agent for IBM InfoSphere DataStage 20
InfoSphere agent attributes
Attribute Description
InfoSphereInstance The unique identification tag (ITAG) or the instance name that was
specified when the instance was created.
Example: ade
EnvFile Full path of the file that the agent sources to set the environment
before executing any DataStage server commands.
Example:
/opt/IBM/InformationServer/Server/DSEngine/dsenv
Note: The dsenv file does not work on RHEL7 and SLES12
systems, because the $DSHOME variable is not exported correctly.
Instead, you can use the dsenv.multi.u file.
For example:
/opt/IBM/InformationServer/Server/DSEngine/dsenv.multi.u
Table 3-2 lists the optional attributes for the InfoSphere agent.
Attribute Description
HostName The virtual host name for this InfoSphere instance. The client side
components use this host name to connect to the server side
components.
This attribute is used for in-depth monitoring of InfoSphere
DataStage components.
Attribute Description
LevelTwoMonitorFreq This type-level attribute specifies the frequency at which the agent
for this resource type must perform second-level or detailed
monitoring. You can also override the value of this attribute at the
resource level. The value indicates the number of monitor cycles
after which the agent will monitor the InfoSphere DataStage
component in detail.
For example, the value 5 indicates that the agent will monitor the
InfoSphere DataStage component in detail after every five online
monitor intervals.
Default: 0
IMFRegList An ordered list of attributes whose values are registered with the
IMF notification module. The attribute values can be overriden at
the resource level.
Key Description
Default: 2
MonitorFreq This key value specifies the frequency at which the agent invokes the
monitor agent function. The value of this key is an integer.
You can set this key to a non-zero value for cases where the agent
requires to perform both poll-based and intelligent resource monitoring.
If the value is 0, the agent does not perform poll-based process check
monitoring.
After the resource registers with the AMF kernel driver, the agent calls
the monitor agent function as follows:
Default: 5
RegisterRetryLimit If you enable intelligent resource monitoring, the agent invokes the
imf_register agent function to register the resource with the AMF kernel
driver.
The value of the RegisterRetryLimit key determines the number of times
the agent must retry registration for a resource. If the agent cannot register
the resource within the limit that is specified, then intelligent monitoring
is disabled until the resource state changes or the value of the Mode key
changes.
Default: 3
Configuring the agent for IBM InfoSphere DataStage 23
Enabling and disabling intelligent resource monitoring manually
InfoSphereInstance Yes - -
EnvFile Yes - -
3 If required, change the values of the MonitorFreq key and the RegisterRetryLimit
key of the IMF attribute.
4 Save the VCS configuration.
# haconf -dump -makero
2 To disable intelligent resource monitoring for all the resources of a certain type,
run the following command:
# hatype -modify InfoSphere IMF -update Mode 0
■ Meeting prerequisites
Meeting prerequisites
Before installing the agent for IBM InfoSphere DataStage, ensure that the following
prerequisites are met.
For example, you must install the ACC library on VCS before installing the agent
for IBM InfoSphere DataStage.
Troubleshooting the agent for IBM InfoSphere DataStage 26
Reviewing error log files
See “Before you install the Cluster Server agent for IBM InfoSphere DataStage”
on page 12.
■ <ISInstallDir>/logs
■ <ISInstallDir>/ASBNode/logs
■ <ISInstallDir>/ASBNode/install/logs
4 Test the identified resource. The function reproduces the problem that you are
attempting to diagnose.
5 Set the ResLogLevel attribute back to INFO for the identified resource:
# haconf -dump
■ If you have configured the required attributes to enable the IBM InfoSphere
DataStage agent for IMF, but the agent is still not IMF-enabled, restart the agent.
The imf_init function runs only when the agent starts up, so when you restart
the agent, imf_init runs and initializes the IBM InfoSphere DataStage agent to
interface with the AMF kernel driver.
■ You can run the following command to check the value of the MonitorMethod
attribute and to verify that a resource is registered for IMF.
# hares -value resource MonitorMethod system
The MonitorMethod attribute specifies the monitoring method that the agent
uses to monitor the resource:
■ Traditional—Poll-based resource monitoring
■ IMF—Intelligent resource monitoring
■ You can use the amfstat to see a list of registered PIDs for an InfoSphere
resource.
The amfstat command shows the PIDs monitored by the InfoSphere DataStage
agent.
■ Run the following command to set the ResLogLevel attribute to TRACE. When
you set ResLogLevel to TRACE, the agent logs messages in the
InfoSphere_A.log file.
# hares -modify ResourceName ResLogLevel TRACE
■ Run the following command to view the content of the AMF in-memory trace
buffer.
# amfconfig -p dbglog
Known issues
This release of the agent for IBM InfoSphere DataStage has the following known
issues:
Problem
An error message might appear when you run the hares -offline command to
take a resource offline.
Description
When a resource is taken offline, it is unregistered from the AMF module. However,
the imf_register function attempts to unregister the resource again.
This results in an error message from the engine log.
imf_register entry point failed with exit code(1)
Workaround
It is safe to ignore this error message.
Appendix A
Sample Configurations
This appendix includes the following topics:
■ About sample configurations for the agents for IBM InfoSphere DataStage
type InfoSphere (
static boolean AEPTimeout = 1
static str AgentFile = "/opt/VRTSvcs/bin/Script51Agent"
static str AgentDirectory = "/opt/VRTSagents/ha/bin/InfoSphere"
static str ArgList[] = { ResLogLevel, State, IState, Component,
User, InfoSphereInstanceDir, EnvFile, InfoSphereInstance,
Hostname, Port, MonitorProgram }
str ResLogLevel = INFO
Sample Configurations 31
Sample configuration files
str Component
str User
str InfoSphereInstanceDir
str EnvFile
str InfoSphereInstance
str Hostname
int Port
str MonitorProgram
)
include "types.cf"
include "InfoSphereTypes.cf"
cluster infosphere_clus (
UserNames = { admin = chiGheHe }
Administrators = { admin, a }
)
system NodeA(
)
system NodeA (
)
group InfoSphere_grp (
SystemList = { NodeA = 0, NodeB = 1 }
)
InfoSphere infosphereASB_res (
ResLogLevel = TRACE
Component = ASBNodeAgent
User = root
InfoSphereInstanceDir = "/opt/IBM/InformationServer"
Hostname = localhost
Port = 31532
)
InfoSphere infosphere_res (
ResLogLevel = TRACE
Sample Configurations 32
Sample configuration files
Component = DSEngine
User = dsadm
InfoSphereInstanceDir = "/opt/IBM/InformationServer"
EnvFile = "/opt/IBM/InformationServer/Server/DSEngine
/dsenv"
InfoSphereInstance = ade
Hostname = localhost
Port = 31539
)
InfoSphere infospherelog_res (
ResLogLevel = TRACE
Component = ASBLoggingAgent
User = root
InfoSphereInstanceDir = "/opt/IBM/InformationServer"
Hostname = localhost
Port = 31533
)
Volume vol_res (
Volume = infosphere_dg_vol
DiskGroup = infosphere_dg
)
DiskGroup dg_res (
DiskGroup = infosphere_dg_vol
)
Mount mount_res (
MountPoint = "/opt/IBM/InformationServer"
BlockDevice = “/dev/vx/dsk/infosphere_dg
/infosphere_dg_vol"
FSType = ext4
MountOpt = rw
FsckOpt = "-y"
)
IP ip_res (
Device = eth0
Address = "10.209.76.140"
NetMask = "255.255.252.0"
)
NIC nic_res (
Device = eth0
)
Sample Configurations 33
Sample service group configurations
Component DSEngine
Sample Configurations 35
Sample service group configurations
User Dsadm
Hostname localhost
Port 31539
InfoSphereInstanceDir /opt/IBM/InformationServer
InfoSphereInstance ade
EnvFile /opt/IBM/InformationServer/Server/DSEngine/dsenv
Component ASBNodeAgent
User Root
Hostname localhost
Port 31532
InfoSphereInstanceDir /opt/IBM/InformationServer
InfoSphereInstance -
EnvFile -
Component ASBLoggingAgent
User Root
Hostname localhost
Port 31533
InfoSphereInstanceDir /opt/IBM/InformationServer
Sample Configurations 36
Sample service group configurations
InfoSphereInstance -
EnvFile -
Index
A T
about ACC library 13 troubleshooting
ACC library meeting prerequisites 25
installing 13 reviewing error log files 26
removing 16 reviewing cluster log files 26
agent using InfoSphere log files 26
attributes 18 using trace level logging 26
clean function 10 using correct software 25
configuration 31
features 7 U
importing agent types file 17
uninstalling agent, VCS environment 15
installing, VCS environment 14
monitor function 10
offline function 9
online function 9
overview 6
service group configuration 33
type definition 30
uninstalling, VCS environment 15
agent configuration file
importing 17
agent functions
imf_getnotification 11
imf_init 11
imf_register 11
agent installation
general requirements 12
steps to install 14
I
Intelligent Monitoring Framework (IMF)
troubleshooting 27
L
logs
reviewing cluster log files 26
reviewing error log files 26
using InfoSphere logs 26
using trace level logging 26