Pre-requisites to configure OpenShift monitor type

Before you configure monitoring of OpenShift environment, perform the following:

• • Verifying ports accessibility by PATROL Agent
  • Understanding monitoring scope

Verifying ports accessibility by PATROL Agent

Ensure that the ports that you use to connect to the cluster (default 6443) and all cluster nodes (10250; cannot be changed) are accessible by the PATROL Agents that you have selected for monitoring your OpenShift environment. 

Understanding monitoring scope

To understand what nodes, projects, pods, and containers that you can monitor in your environment, run the envChecker utility available in the following folder:

Windows: %PATROL_HOME%\ve3\bin

Linux: $PATROL_HOME/../ve3/bin

The utility also helps you to confirm if your connection with OpenShift is established correctly. It lists the number of instances of nodes, projects, pods, and containers that can be monitored in your environment. You can also select to include nodes, cluster operators, and containers to the report or not. You also get the option to filter (include or exclude) projects in the report.

To continue getting uninterrupted monitoring results, configure filtering of these instances carefully in the Infrastructure or Monitor policy.

To run the utility

1. Go to the directory where the utility is available, run the following command:
   Windows: envChecker.bat
   Linux: envChecker.sh
2. Enter the IP address or host name of the master node.
3. Enter the port to access the master node.
4. Enter a value to select authentication type — 1 for certificate or 0 for token.
5. Based on the authentication type that you selected, either enter client certificate file path and password or enter authentication token.
6. Type Y to use proxy server configuration or N otherwise.
7. If you have opted to use proxy server configuration, enter the server name, port, username, and password to access the server.
8. Type Y to include nodes in the report or N otherwise.
9. Type Y to include cluster operator instance count in the report or N otherwise.
10. Type Y to include container instance count in the report or N otherwise.
11. Type 0 to include or 1 to exclude projects in the report.
12. Based on the option you entered, enter regular expressions to filter projects in the report.
    For example, to include all projects that begin with production, first type 0 and then enter the following regular expression: ^prod.*

13. Press Enter.
    The following image shows a sample output of the utility:
    
    You can find this information in the envChecker_report.log file in the following folders:

    Windows : %PATROL_HOME%\ve3\log

    Linux: $PATROL_HOME/../ve3/log

When you contact BMC Support to troubleshoot an issue, share the output of the utility with BMC Support.