How to Monitor the Kubernetes/OpenShift Cluster Using eG Enterprise?

To monitor the Kubernetes/OpenShift cluster using eG Enterprise, you need to first manage it.

eG Enterprise does not automatically discover the Kubernetes/OpenShift cluster. To manage the cluster therefore, you need to manually add it to the eG Enterprise system using the eG admin interface. For this, follow the steps below:

  1. Login to the eG admin interface.

  2. Figure 1 then appears prompting you to pick what you want to monitor. Select Kubernetes / OpenShift from Figure 1.

    Choosing to Monitor Kubernetes / OpenShift

    Figure 1 : Choosing to monitor Kubernetes / OpenShift

  3. Since eG Enterprise monitors Kubernetes/OpenShift clusters in an agentless manner, eG Enterprise automatically displays the remote agents that may pre-exist in the target environment (see Figure 2). From the list in Figure 2, select the remote agent you want to use for monitoring the Kubernetes/OpenShift cluster, by clicking on it.

    Remote Agent to Monitor Kubernetes cluster

    Figure 2 : Selecting the remote agent that should monitor the Kubernetes cluster

  4. This will invoke Figure 3, using which you can configure the details of the Kubernetes cluster you want to monitor.

    Adding Kubernetes/OpenShift Cluster

    Figure 3 : Adding a Kubernetes/OpenShift Cluster

  5. In Figure 3, specify the following:

    • Provide a unique NICK NAME for the Kubernetes/OpenShift Cluster you want to monitor.

      Note:

      eG Enterprise provides monitoring support to Kubernetes on Linux platforms only, and not on Windows.

    • Specify the PORT at which the cluster listens. The default port is 6443.
    • The eG agent requires an authentication bearer token to access the Kubernetes API, run API commands on the cluster, and pull metrics of interest. The steps for generating this token have been detailed in How Does eG Enterprise Monitor a Kubernetes/OpenShift Cluster? You will also find these steps displayed in the right panel of Figure 3. Once you generate a token by following the displayed (or documented) steps, copy the token and paste it against AUTHENTICATION TOKEN in Figure 3.
    • The Kubernetes API server exists on the master node of a Kubernetes/OpenShift cluster. This means that the eG agent should connect to the master node to use the API. To enable this connection, specify the IP address of the master node in the LOAD BALANCER / MASTER NODE IP text box in Figure 3. Some Kubernetes/OpenShift clusters may support multiple master nodes. When monitoring such a cluster, you will have to configure the eG agent with the IP address of the load balancer that is managing the cluster. In other words, you will have to specify the IP address of the load balancer in the LOAD BALANCER / MASTER NODE IP text box of Figure 3. In this case, the load balancer will route the eG agent's connection request to any available master node in the cluster, thus enabling the agent to connect with the API server on that node. To determine the IP address of the master node/load balancer, follow the steps detailed in the How Does eG Enterprise Monitor a Kubernetes/OpenShift Cluster? topic.

    • Finally, click the Update button in Figure 3 to add the component to eG Enterprise.