Configuring OpenShift monitor type

Before configuring monitoring of your OpenShift environment, ensure that you run the envChecker utility and get a report of the number of instances of nodes, projects, pods, and containers that can be monitored. To continue getting monitored metrics, ensure that you filter instances carefully. For more information, see Pre-requisites-to-configure-OpenShift-monitor-type.

To start monitoring your OpenShift environment with the KM, after installing the KM, configure the monitor type where you configure how to access the environment and the entities to monitor. 

1. Perform one of the following actions:
   1. In BMC Helix Operations Management, go to Configuration > Monitoring Policies > Create Policy.
   2. In TrueSight Operations Management, go to Configuration > Infrastructure Policies > Create Policy.
2. Click Add Monitoring Configuration.
3. From the Monitoring Solution list, select OpenShift.
4. From the Monitor Profile and Monitor Type lists, select OpenShift.

5. In the OpenShift Monitoring Configuration section, click Add.
   The following table lists the fields that are displayed on the OpenShift Cluster Details page.

   Field	Description
   OpenShift Cluster Details
   Environment name	Enter a name that identifies this set of OpenShift cluster monitoring configuration. A top-level container is created with this name. This container holds all monitored OpenShift instances. Note: If you edit the name after data collection is started, new instance is created on the Devices page and data collection will begin under the new instance. You will not be able to collate data of both the instances.
   Master Node	Type the host name or the IP address of the OpenShift master node.
   Port Number	Type the port number to connect to the OpenShift master node. The default port number is 6443.
   Authentication Type	Select the authentication type to connect to the OpenShift cluster. Certificate Token
   Client Certificate File Path (.pfx) and Client Certificate Password	(Certificate-based authentication) Type the absolute path of the client certificate file on the PATROL Agent server. The certificate file must be in .pfx format. Use this sample script to create the .pfx client certificate for OpenShift monitoring. Note: The client certificate file must reside on the host where the PATROL Agent is running. BMC PATROL default account must have read permission for the client certificate file. For example C:\cert\client-cert.pfx or /opt/bmc/cert/client-cert.pfx. And then type the password to access the file.
   Authentication Token	(Token-based authentication) Type the bearer token to connect to the OpenShift cluster. Use this sample script to create a service account and get the bearer token.
   Proxy Server Configuration
   Use Proxy Configuration	Select this option to enable the proxy configuration.
   Server Name	Type the name or the IP address of the proxy server that is being used to route the HTTP requests.
   Port	Type the proxy server port number that is being used to connect to the specified proxy server.
   Proxy Server Authentication (Optional)	Click this tab to configure the proxy authentication. It is optional to add username and password to access the proxy server.
   Username	Type the username to log in to the proxy server.
   Password	Type the password to the specified proxy server.
   Filter Configuration
   Monitor Nodes	Select the check box to monitor nodes.
   Monitor Cluster Operators	Select the check box to monitor cluster operators.
   Monitor Containers	Select the check box to monitor containers.
   Project Filter
   Project Filter type	In this section, you configure the projects that you want to or not want to monitor. Select if you want to configure projects to be included or excluded from monitoring.
   Project Filter	Type the project name that you want to include or exclude from monitoring. You can enter the exact project name or a regular expression matching multiple projects. To add multiple entries, enter a pipe-separated (|) list of the projects. Filtering examples: Example 1 To filter a project with exact name like Production, enter \bProduction\b Example 2 To filter projects starting with Pro, enter ^Pro.* Example 3 To filter all projects that contain the word duct, enter *duct.* Example 4 To filter all projects that end with ion, enter .*ion$
   Device Mapping	Node: Select this option to enable device mapping of nodes. The KM creates the node device by resolving the DNS from its IP address. If device mapping is disabled for nodes, the nodes are displayed as instances in their respective hierarchy below the PATROL Agent device. Pod: Select this option to enable device mapping of pods. The KM creates the device by using the pod name. If device mapping is disabled for pods, the pods are displayed as instances in their respective hierarchy below the PATROL Agent device. Container: Select this option to enable device mapping of containers. The KM creates the container device by concatenating pod and container names. For example, <pod-name>-<container-name>. If device mapping is disabled for containers, the containers are displayed as instances in their respective hierarchy below the PATROL Agent device. Note: After you save the configuration, restart the PATROL Agent to apply the changes.
   Administration
   JVM Arguments	Type the additional Java Virtual Machine arguments for the Java collector. For example: For Java memory settings: -Xms256m -Xmx1024m.
   Logging
   Enable Logging	Select this option to enable the debug. The log files are located at <PATROL_HOME>/ve3/log location on the PATROL Agent server.

6. After saving the OpenShift cluster configuration, in the JAVA Path field, type the path to the JRE directory on the PATROL Agent server.
   For example, if the JAVA location on the PATROL Agent server is /usr/java/jdk1.8.0_45/jre/bin/java path, specify /usr/java/jdk1.8.0_45/jre as the value in this field.
   If the specified path does not exist or if this field is left blank, the KM searches for the JRE in the following order:
   • <PATROL_HOME>/openjdk directory
   • <PATROL_HOME>/jre64 directory