10.4.3 Installing and setting up PFM - Web Console
- Organization of this subsection
(1) Process flow for installation and setup
|
In the procedure explanation, the image indicates the tasks to be performed on the executing node, and the image
indicates the tasks to be performed on the standby node. In addition, the image
indicates the setup items required for specific environments, and optional setup items for when you want to change the default
settings.
(2) Installation procedure
![[Figure]](GRAPHICS/ZU115920.GIF)
Perform a new installation of PFM - Web Console on the executing node and the standby node. The installation procedure is the same as for a non-cluster system.
For details on the installation procedure, see the chapter describing installation and setup (in UNIX) in the Job Management Partner 1/Performance Management Planning and Configuration Guide.
- Notes:
-
-
Install PFM - Web Console on the local disk, not the shared disk.
-
Install each PFM - Web Console for both the executing node and the standby node in a location with the same path.
-
(3) Setup procedure
When using PFM - Web Console on a logical host, the environment configurations on the executing node and the standby node have to be the same.
(a) Registering agent information in PFM - Web Console
![[Figure]](GRAPHICS/ZU105006.GIF)
To perform integrated management of PFM - Agent or PFM - RM in a cluster system, register the agent information of PFM - Agent or PFM - RM in PFM - Web Console for the executing node and the standby node.
PFM - Manager version 09-00 or later automatically registers PFM - Agent or PFM - RM, so no additional setup is required for the PFM - Agent or PFM - RM information. However, if the release date of PFM - Agent or PFM - RM is later than that of PFM - Manager, PFM - Agent, or PFM - RM must be registered manually. For details on the release dates for PFM - Manager, PFM - Agent, and PFM - RM, see the Release Notes for each program.
- Notes:
-
-
You do not need to register PFM - Agent or PFM - RM when you add the same version of PFM - Agent or PFM - RM with the same product ID to a Performance Management system in which the PFM - Agent or PFM - RM information has been already registered.
-
Set up the latest version of PFM - Agent or PFM - RM if you install a different version of PFM - Agent or PFM - RM with the same product ID on a different host.
-
To perform an additional setup of agent information in PFM - Web Console, see the process flow shown in Figure 10-23.
-
Copy the setup files.
Copy the PFM - Agent or PFM - RM setup file to the following locations on the PFM - Web Console executing node and standby node.
/opt/jp1pcwebcon/setup/
The files to copy and the procedure for copying the files are the same as when performing an additional setup for PFM - Manager. For details, see the chapter describing installation and setup (in UNIX) in the Job Management Partner 1/Performance Management Planning and Configuration Guide.
-
Execute the setup command on the standby node.
Execute the jpcwagtsetup command on the standby node to register the agent information.
Execute the command as follows:
jpcwagtsetup
For details on the jpcwagtsetup command, see the chapters that describe commands in the manual Job Management Partner 1/Performance Management Reference.
- Supplemental information:
-
When you register the agent information of PFM - Agent or PFM - RM in PFM - Web Console, you must restart PFM - Web Console. However, because PFM - Web Console restarts on the standby node when a failover occurs, you do not need to restart PFM - Web Console on the standby node after step 2.
(b) Setting up PFM - Manager for the connection destination ![[Figure]](GRAPHICS/ZU115920.GIF)
On the standby node, set the IP address or host name for the PFM - Manager that serves as the connection destination for PFM - Web Console in the initialization file (config.xml). If the PFM - Manager that serves as the connection destination is running on a cluster system, set the logical IP address or the logical host name.
-
Open the initialization file (config.xml).
Use a text editor or XML editor to open the /opt/jp1pcwebcon/conf/config.xml file.
-
Set the IP address or host name for the PFM - Manager host serving as the connection destination.
Enter the following tag immediately after the <vserver-connection> tag within the <vsa> tag:
<param name="host" value="IP-address-or-host-name"/>
For example, if the IP address of the PFM - Manager host is 10.210.24.56, perform the following settings:
<vsa> <vserver-connection> <param name="host" value="10.210.24.56"/> <!-- The host computer name to which PFM View Server uses. Specifiable values: 1024 to 65535 Default: 22286 --> <param name="port" value="22286"/> </vserver-connection>
-
Save the initialization file (config.xml) you edited in step 2.
- Important note
-
If areas other than those specified are changed in the initialization file (config.xml), PFM - Web Console might not operate correctly.
(c) Setting up PFM - Web Console (logical host) ![[Figure]](GRAPHICS/ZU115920.GIF)
Set the logical IP address or logical host name for PFM - Web Console in the initialization file (config.xml) on the standby node.
-
Open the initialization file (config.xml).
Use a text editor or XML editor to open the /opt/jp1pcwebcon/conf/config.xml file.
-
Set the logical IP address or logical host name for the PFM - Web Console host.
Enter the following tag in the <vserver-connection> tag within the <vsa> tag:
<param name="ownHost" value="logical-IP-address-or -logical-host-name"/>
For example, if the logical IP address of the PFM - Web Console host is 10.210.26.18, make the following settings:
<vsa> <vserver-connection> <param name="host" value="10.210.24.56"/> <!-- The host computer name to which PFM View Server uses. Specifiable values: 1024 to 65535 Default : 22286 --> <param name="port" value="22286"/> <param name="ownHost" value="10.210.26.18"/> </vserver-connection>
-
Save the initialization file (config.xml) you edited in step 2.
- Important note
-
-
If areas other than those specified are changed in the initialization file (config.xml), PFM - Web Console might not operate correctly.
-
The XML tags are commented out using <!-- --> tags, for example <!-- <param name="ownHost" value="logical-IP-address-or-logical-host-name"/> -->. Uncomment the tags when you specify a value.
-
(d) Setting up the storage location for bookmark definition information ![[Figure]](GRAPHICS/ZU115920.GIF)
Set the storage directory for bookmark definition information in the initialization file (config.xml) on the standby node. Specify an installation directory on the shared disk to ensure that bookmark definition information is inherited when a failover occurs.
To set the storage location for bookmark definition information:
-
Open the initialization file (config.xml).
Use a text editor or XML editor to open the /opt/jp1pcwebcon/conf/config.xml file.
-
Set the directory for storing the bookmark definition information.
Set the storage directory in the <bookmark> tag immediately after the <format> tag within the <vsa> tag in the initialization file (config.xml).
The directory you set will be created automatically when the PFM - Web Console service starts.
For example, use the following setting to make environment-directory/jp1pcwebcon/common/bookmarks the storage directory.
</format> <bookmark> <!-- The directory where bookmark repository is stored. Default : <install directory>/bookmarks --> <param name="bookmarkRepository" value="environment-directory/jp1pcwebcon/common/bookmarks"/> </bookmark> </vsa>
-
Save the initialization file (config.xml) you edited in step 2.
- Important note
-
-
If areas other than those specified are changed in the initialization file (config.xml), PFM - Web Console might not operate correctly.
-
The XML tags are commented out using <!-- --> tags, for example <!-- <param name="bookmarkRepository" value=""/> -->. Uncomment the tags when you specify a value.
-
(e) Setting the storage location for process monitoring definition templates ![[Figure]](GRAPHICS/ZU115920.GIF)
Set the storage folder for process monitoring definition templates in the initialization file (config.xml) on the standby node. Specify a directory on the shared disk to ensure that the process monitoring definition templates are inherited by the standby node when a failover occurs.
-
Open the initialization file (config.xml).
Open the file installation-folder\conf\config.xml in a text editor or XML editor.
-
Set the directory in which to store process monitoring definition templates.
Set the storage directory in the <process-monitoring> tag within the <vsa> tag in the initialization file (config.xml).
The directory you specify will be automatically created when the PFM - Web Console service starts.
For example, use the following setting to make environment-directory/jp1pcWebCon/processMonitoringTemplates the storage folder:
<process-monitoring> <!-- The directory where templates of process monitoring are stored. Default : <install directory>/processMonitoringTemplates --> <param name="processMonitoringTemplatesRepository" value="environment-directory/jp1pcWebCon/processMonitoringTemplates"/> </process-monitoring> </vsa>
-
Save the initialization file (config.xml) you edited in step 2.
- Important note
-
-
If you change an area in the initialization file (config.xml) other than the one specified, PFM - Web Console might not operate correctly.
-
The XML tags are commented out using <!-- --> tags, for example <!-- <param name="processMonitoringTemplatesRepository" value=""/> -->. Uncomment the tags when you specify a value.
-
(f) Setting usrconfig.cfg ![[Figure]](GRAPHICS/ZU115920.GIF)
If the language setting of the system locale differs from that of the usrconf.cfg file, change the setting of the usrconf.cfg file on the standby node.
-
Use a text editor or a similar tool to open the usrconf.cfg file.
The usrconf.cfg file is stored in the following folder:
Installation folder\CPSB\CC\web\containers\PFMWebConsole\usrconf
-
Edit the usrconf.cfg file.
If, for example, the system locale is Japanese and the language setting of the usrconf.cfg file is English, and you need to change the setting to Japanese, set the usrconf.cfg file as follows:
#for PFM WebConsole add.jvm.arg=-Duser.language=ja add.jvm.arg=-Duser.country=JP add.jvm.arg=-DprGB18030check=false
For details about how to change the settings of the usrconf.cfg file, see the chapter on setting the language environment in the Job Management Partner 1/Performance Management Planning and Configuration Guide.
(g) Copying the settings file to the executing node
![[Figure]](GRAPHICS/ZU115910.GIF)
Copy the initialization file (config.xml) edited in (b), (c),(d), and (e) to the executing node.
Copy the file to the following location on the executing node:
/opt/jp1pcwebcon/conf/
If the settings of the usrconf.cfg file on the standby node were changed in (f), you need to copy the file to the executing node. Copy the file to the following location on the executing node:
Installation folder\CPSB\CC\web\containers\PFMWebConsole\usrconf
(h) Make sure the shared disk is online ![[Figure]](GRAPHICS/ZU115910.GIF)
Make sure that the shared disk is online on the execution node. If the shared disk is not online, use the cluster software and the volume manager to bring it online.
(i) Performing an additional setup for PFM - Agent or PFM - RM information
![[Figure]](GRAPHICS/ZU105006.GIF)
Use the setup file copied in (a) to perform an additional setup of the agent information for PFM - Agent or PFM - RM on the execution node.
-
Stop the PFM - Web Console service on the executing node.
Use the jpcwstop command to stop the services if the PFM - Web Console services are not registered with the cluster software. To perform a forced stop, execute the jpcwstop command with the -immediate option.
When making changes to the Performance Management configuration such as adding PFM - Agent or PFM - RM after the services are registered with the cluster software, use the cluster software to stop the services. For details on changing the configuration of the cluster system, see 10.5 Changing the cluster system configuration (in UNIX).
-
Execute the setup command on the executing node.
Execute the command as follows:
jpcwagtsetup
For details on the jpcwagtsetup command, see the chapters that describe commands in the manual Job Management Partner 1/Performance Management Reference.
-
Start the PFM - Web Console service on the executing node.
Start the PFM - Web Console service that you stopped in step 1.
(4) Configuring the cluster software
Set up PFM - Web Console in the cluster software. Perform this task on both the executing node and the standby node.
(a) Registering PFM - Web Console with the cluster software
![[Figure]](GRAPHICS/ZU115920.GIF)
If you intend to use PFM - Web Console in a logical host environment, register PFM - Web Console with the cluster software. Also, set up the environment so that PFM - Web Console is started and stopped based on instructions from the cluster software.
Generally, the following four command items are required when registering an application in the cluster software: Start, Stop, Monitor operations, and Forced stop.
The following table lists and describes the settings for PFM - Web Console.
Item |
Explanation |
---|---|
Start |
Execute the following command to start PFM - Web Console: /opt/jp1pcwebcon/tools/jpcwstart |
Stop |
Execute the following command to stop PFM - Web Console: /opt/jp1pcwebcon/tools/jpcwstop |
Forced stop |
Execute the following command to perform a forced stop of PFM - Web Console: /opt/jp1pcwebcon/tools/jpcwstop -immediate |
Monitor operations |
Use the ps command to check if the following process is running. ps -ef | grep "process-name" | grep -v "grep process-monitored" For details on process names, see 10.6.1(3) Service names. |
- Note
-
-
Do not configure PFM - Web Console to start automatically when the OS starts. When PFM - Web Console is registered in the cluster system, it is started and stopped by the cluster software.
-
When running PFM - Web Console in a Japanese language environment, configure the cluster software to run a script that sets the LANG environment variable before it executes the command that starts PFM - Web Console.
-
If the cluster software uses command return values to determine execution results, specify settings so that the command return values from PFM - Web Console are converted to the values that can be correctly interpreted by the cluster software. For details on the command return values for PFM - Web Console, check the reference documentation for each command.
-
If you execute a jpcwstop command while PFM - Web Console is being used, it might delay the stop processing.
To successfully register the jpcwstop command in the cluster software, create a script to wait for several minutes if a value of 4 is returned by the command, and then to execute the jpcwstop command again to register the command.
-
When you use the ps command to identify the process name and logical host name, the command sometimes fails to acquire the information, in which case the information might appear in square brackets. Read the manual page for the ps command in your operating system and execute the command again.
-
(b) Checking starting and stopping from the cluster software
![[Figure]](GRAPHICS/ZU115920.GIF)
Check whether the cluster software is operating correctly by using it to issue start and stop requests to PFM - Manager on each node.