Creating a deployment environment by using the monConfig script

You can use the monConfig.sh or monConfig.bat script to create a deployment environment for the clusters and servers across which the IBM® Business Monitor components and monitor models can be deployed.

Before you begin

Before creating clusters and configuring the IBM Business Monitor components, ensure that you have performed the following tasks:
  • You have installed IBM Business Monitor.
  • You have created the IBM Business Monitor deployment manager profile or augmented an existing deployment manager profile with IBM Business Monitor.
  • You have created the MONITOR database.
  • You have started the deployment manager.
  • You have created and federated at least one IBM Business Monitor custom profile or augmented an existing custom profile with IBM Business Monitor.
  • You have started the custom profile or profiles.
If you are using Solaris, you must additionally update the app_server_root/bin/wsadmin.sh file to set the MaxPermSize Java virtual machine (JVM) parameter to an appropriate value. Although tests have shown that a value of 256M is sufficient for the monConfig.sh script to run, your system resources and requirements might require you to set a different MaxPermSize value. In the wsadmin.sh file, modify the PERF_JVM_OPTIONS line to set the MaxPermSize value, as shown in the following example:
PERF_JVM_OPTIONS="-Xms256m -Xmx256m -XX:MaxPermSize=256m" ;;

About this task

To create a deployment environment, you can run the monConfig script with a set of mandatory parameters. The monConfig script requires input from a properties file that is customized with the configuration values for your deployment environment. Two sample properties files that are named monconfig_singleCluster.properties and monconfig_threeCluster.properties are provided with your IBM Business Monitor installation.

These files are formed of name-value pairs of configuration settings for the IBM Business Monitor clusters and cluster members to be created. You can customize a copy of the properties file with your required settings to create a deployment environment with a single cluster topology or three cluster topology.

Procedure

  1. To create your own properties file for a single cluster topology, make a copy of the monconfig_singleCluster.properties sample file and save it to the current or another location. To create your own properties file for a three cluster topology, make a copy of the monconfig_threeCluster.properties sample file and save it to the current or another location. The sample files are stored in the following directory:
  2. Use a text editor to edit the newly created file and customize it with the configuration settings for the clusters and cluster members to be created.

    In the set of properties that are provided at the end of the file, numbers (for example, 1, 2, and 3) are used as identifiers for each cluster and associated cluster member and node, as in clusterName.1.memberName.1.memberNode.1. Although you can replace these numeric values with string values as indicated in the comments, for simplicity, you might prefer to retain the numbers in the property names. You must specify a value for each property. You can also replicate the properties if you want to specify configuration settings for additional cluster members and nodes.

    The following table describes the required values for each property. The # character in the property name represents an identifier such as a number or string, which is used to associate cluster members with a cluster and node.
    Table 1. Entries for defining the clusters and cluster members in the deployment environment
    Property Description
    clusterName.# Specify a unique name that identifies the cluster.

    A clusterName.# entry is required for each cluster to be created, where # is unique for each cluster.

    clusterName.#.capabilities Specify a value that identifies the cluster type.

    For a three-cluster topology, a clusterName.#.capabilities property is required for each cluster to be created. The values for the three clusters are application, messaging, and support.

    For a single-cluster topology, you can specify any of the following values: application, support, or messaging.

    clusterName.#.memberName.# Specify a name for the application server that you are defining as a cluster member. The name must be unique within the node.

    A clusterName.#.memberName.# entry is required for each cluster member to be created in a cluster. By default, the workload (or weight) is evenly distributed across all members in a cluster.

    clusterName.#.memberName.#.memberNode.# Set this value to the name of an existing node on which you want to configure and run the cluster member.

    A clusterName.#.memberName.#.memberNode.# entry is required to associate each cluster member with a federated node.

    For examples of how you can customize the property names and values for a single and three-cluster topology, see Example: Property settings for creating deployment environments with a single cluster or three clusters.

  3. Save and close the properties file.
  4. From the command line, change to the following directory where the monConfig script is located:
  5. Run monConfig by using the following syntax:
    • For Windows operating systemmonConfig.bat -d dmgr_profile_name -u dmgr_was_admin_username
      -p dmgr_was_admin_password -c directory_path\\customized_monconfig.properties

    • For UNIX operating systemFor Linux operating systemmonConfig.sh -d dmgr_profile_name -u dmgr_was_admin_username
      -p dmgr_was_admin_password -c /directory_path/customized_monconfig.properties
    where:
    • dmgr_profile_name represents the name of the deployment manager profile.
    • dmgr_was_admin_username represents the user ID for a WebSphere® Application Server administrator.
    • dmgr_was_admin_password represents the password for dmgr_was_admin_username.
    • directory_path/customized_monconfig.properties represents the fully qualified path to your customized properties file for a single or three cluster topology.
      For Windows operating systemNotes for specifying directory paths in the syntax:
      • Directory paths that have spaces must be enclosed in double quotation marks. You must also use the escaped Windows directory separator (\\).
      • Directory paths that do not have spaces can alternatively use the UNIX directory separator (/).

    For more information about running the monConfig script, and example usage, see monConfig script.

  6. Review the log file for the monConfig script, which is written to the following location on the deployment manager node, to confirm that there were no errors:

Results

The deployment environment is created with a single cluster or three clusters to support the deployment of applications and the messaging and support infrastructures.