HP Serviceguard Developer's Toolbox Version B.12.00.00 For HP-UX and Linux

When the tkit_module.sh is called with the start argument by the Serviceguard master
control script, it executes the application start script. The application start script is written by
the user for the application intended to be integrated with Serviceguard. The application start
script must return a zero if the application starts successfully, and a non-zero value if the
application fails to start.
When the tkit_module.sh is called with stop argument, it executes the application stop
script. Application stop script is written by the user for the application intended to be integrated
with Serviceguard. The application start script must return a zero if the application starts
successfully, and a non-zero value if the application fails to start.
Apart from these arguments, the user is required to call the tkit_module.sh script with the
toolbox_monitor argument in the service_cmd of the package configuration file. This
call is automatically generated in the package configuration file when it is created using the
Toolbox module. When the tkit_module.sh script is called with the toolbox_monitor
argument, it runs a monitor_function within which it monitors the health of the application.
This Toolbox contains the following:
◦ The Toolbox template
◦ The test tool
To integrate an application with Serviceguard, customize the Toolkit template for the specific
application. Copy the customized scripts to the package directory on each of the nodes in
the cluster that will be configured to run the application.
Configuring Toolkits
The following section describes the implementation details of the Toolkit framework modules and
modifications required for easily incorporating the application specific details. For more information,
see the sample Toolkit scripts in Appendix A: “MySQL Toolkit scripts” (page 15).
Toolkit package configuration file (pkg.conf)
You must generate the pkg.conf using the cmmakepkg command by including the Toolbox
module as described in the “Application integration with HP Serviceguard” (page 6) section. This
file contains all the configuration variables required for a package including user configured
variables. The following section describes only the Toolbox specific variables.
NOTE: In Serviceguard Version 11.19 and later, all the Toolbox specific configuration variables
mentioned in this section are prefixed with tkit/toolbox/toolbox/ in Linux and
ecmt/toolbox/toolbox/ in HP-UX.
• Toolkit Configuration Directory (TKIT_CONF_DIR)
The Toolkit configuration directory is the place where the package configuration file resides.
For ease of use, you can consider placing the user written application start and application
stop scripts in this directory.
• Maintenance Flag (TKIT_MAINTENANCE_FLAG)
You can set the value of this parameter to either yes or no to enable or disable maintenance
operations respectively.
When set to yes, the tkit_module.sh determines the existence of the MAINTENANCE_FILE
file in the Toolkit configuration directory, where MAINTENANCE_FILE= toolbox.debug.
If the toolbox.debug file exists and TKIT_MAINTENANCE_FLAG is set to yes, the application
monitoring is suspended, and application maintenance can be performed without halting the
package. This means the application can be halted or started without bringing down the
10 High Availability (HA) Toolkits