# Openshift

# Introduction

The purpose of this plugin is to monitor Openshift nodes and pods, through key metrics related to CPU, memory, status of these and the containers of a pod, which are essential to keep track of these resources.

The plugin connects to the Openshift REST API and monitors the environment using the aforementioned metrics, generating an agent for each zone and instance via XML that it sends to the pandora server.

# Prerrequisites

- Openshift API connectivity

The plugin must be able to reach the API remotely in order to extract the information.

- Obtaining Bearer token

It can be obtained with the following CLI command, after logging in with this one:

```
./oc whoami -t
```

- **The openshift user account must have cluster-reader permissions.**

The cli commands to add permissions are as follows (these must be given from a privileged account)

Add a role to a user :

```
oc adm policy add-role-to-user <role> <user_name>
```

Remove a role from a user :

```
oc adm policy remove-role-from-user <role> <user_name>
```

Add a role to a user for all projects:

```
oc adm policy add-cluster-role-to-user <role> <user_name>
```

Remove a user role for all projects:

```
oc adm policy remove-cluster-role-from-user <role> <user_name>
```

Example :

[![image-1644427009267.png](https://pandorafms.com/guides/public/uploads/images/gallery/2022-02/scaled-1680-/image-1644427009267.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2022-02/image-1644427009267.png)

- **The cluster-monitoring option must be activated.**

This can be done with the following command :

```
./crc config set enable-cluster-monitoring true
```

Example:

[![openshiftmonitoing.png](https://pandorafms.com/guides/public/uploads/images/gallery/2022-02/scaled-1680-/openshiftmonitoing.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2022-02/openshiftmonitoing.png)

To be able to have enabled a minimum of 14 gb is requested, so if we have configured the environment with less, and we activate the cluster-monitoring option we will have to add more to the machine, the minimum is 14336 in mb.

- **This file can be applied directly to configure the necessary permissions.**

```
oc apply -f https://github.com/kubernetes-sigs/metrics-server/releases/download/v0.4.1/components.yaml
```

- You need to run this apiservice: v1beta1.metrics.k8s.io and the metrics server.

```
oc get apiservice
```

- **Tiene que estar activada la opción cluster-monitoring**

The command to specify the memory is :

```
./crc config set memory 14336
```

Example:

[![change memory.png](https://pandorafms.com/guides/public/uploads/images/gallery/2022-02/scaled-1680-/change-memory.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2022-02/change-memory.png)

# Parameters and configuration

**Parameters**

<table border="1" id="bkmrk---conf-ruta-al-archi"><tbody><tr><td>--conf</td><td>Conf path file  
</td></tr></tbody></table>

**Conf file (--conf)**

```
ip = < IP or Kubernetes host >
port = < Kubernetes host port >
token = < Authentication token bearer >
connection = < Connection mode, normal or proxy >
proxy = < Connection url >
interval = < Interval in seconds for agents and for metrics analysis >
agent_group_name = < Name of the target group for the created agents >
prefix = < Prefix for the name of the agents >
transfer_mode = < transfer mode, tentacle or local >
data_dir = < (Only enabled if transfer_mode is local) Destination path for each agent's XML, by default "/var/spool/pandora/data_in/" >
tentacle_ip = < IP of the destination machine for the created agents >
tentacle_port = < Port of tentacle, default : 41121 >

deployments = < Activate with 1 to enable the monitoring of deployments >
nodes = < Activate with 1 to enable nodes monitoring >
pods = < Activate with 1 to enable pods monitoring >
```

<span style="text-decoration: underline;">Example</span>

```
ip               = 192.168.49.2
port             = 8443
token            = eyJhbGciOiJSUzI1NiIsImtpZCI6IkVpeVhfTFFzSWpmcGtjZzM0blZrZDY3YUtMbzNqTWZmcmdLZ2NKblVHbTgifQ.eyJpc3MiOiJrdWJlcm5ldGVzL3NlcnZpY2VhY2NvdW50IiwisInN1YiI6InN5c3RlbTpzZXJ2aWNlYWNjb3VudDpkZWZhdWx0OmRlZmF1bHQifQ.aC1lPbS5kYR9Fg9hXJaPiQ8cHzjdWlaAfXdPlmPok6LRX0_OZESEhw8to4PZrz2vzt_BUbawUR0NOpHadujHIx7as4Jm8UCRHgmGseyB7mae9vRMFiD1B4EeH5L8lvucydlV2Avx1IV9SyssbypwGCH_jg7tfKz4EMz5aBfgipliRwFaRGdQMX5sjz4AknGxcb2UVOe9LFb_xC-awDEjaGvm_F0tSLxtyGPoJmsvknNmEC9hJLG_AU8Z9Ke5I5oTvEzRmUCqrKz6319p-x9aaF6yUfOFtlnQlLhIz2xkOs8DkkJ1Rk59i2MolzXGwmlGgWkgc7qCgvqXQNjDeX3ySA
connection       = normal
proxy            = http://localhost:8080
interval         = 300
agent_group_name = kubernetes
prefix           = kube.
transfer_mode    = tentacle
data_dir         = /var/spool/pandora/data_in
tentacle_ip      = 172.42.42.101
tentacle_port    = 41121

deployments      = 1
nodes            = 1
pods             = 1
```

# Manual execution

The format of the plugin execution is as follows:

```
./pandora_openshift --conf < Conf path file >
```

Example:

```
./pandora_openshift --conf /usr/share/pandora_server/util/plugin/openshift.conf
```

The execution will return an output in JSON format with information about the execution, and will generate an XML file for each monitored agent that will be sent to the Pandora FMS server by the transfer method indicated in the configuration.

For example:

```
{"summary": {"Total agents": 84, "Nodes agents": 3, "Pods agents": 43, "Deployments agents": 37}}
```

# Discovery

This plugin can be integrated with Pandora FMS Discovery.

To do so, you must load the ".disco" package that you can download from the Pandora FMS library:

[https://pandorafms.com/library/](https://pandorafms.com/library/)

[![image.png](https://pandorafms.com/guides/public/uploads/images/gallery/2024-01/scaled-1680-/lQlimage.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2024-01/lQlimage.png)

Once loaded, openshift environments can be monitored by creating Discovery tasks from the Management &gt; Discovery &gt; Applications section.

The following minimum data will be requested for each task:

- Openshift host : openshift host.
- Openshift port : Openshift port.
- Openshift token: Openshift token.
- Tentacle IP: IP of the Tentacle server to send the agents' data to. Normally this parameter will not be modified.
- Tentacle port: Tentacle server port to send the data to. Normally this parameter will not be modified.

[![image.png](https://pandorafms.com/guides/public/uploads/images/gallery/2024-01/scaled-1680-/ikHimage.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2024-01/ikHimage.png)

It is also possible to adjust the task configuration to customize the desired monitoring:

- Scan Deployments : If enabled, it will monitor the deployments and create an agent for each one of them.
- Scan Nodes: If enabled, it will monitor the nodes and will create an agent for each one of them.
- Scan Pods: If enabled, it will monitor the pods and will create an agent for each one of them.

[![image.png](https://pandorafms.com/guides/public/uploads/images/gallery/2024-01/scaled-1680-/bazimage.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2024-01/bazimage.png)

The successfully completed tasks will have an execution summary with the following information:

- Total agents : Total number of agents generated by the task.
- Nodes agents : Total number of node agents.
- Pods agents : Total number of pod agents.
- Deployment agents: Total number of application agents.

# Agent and modules generated by the plugin

The execution of the plugin will create the following agents and modules:

- Global agent

<table border="1" id="bkmrk-%3C-prefix.kubernetes-" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 99.8765%;"></col></colgroup><tbody><tr><td>&lt; prefix.Openshift &gt;</td></tr></tbody></table>

**Modules**

<table border="1" id="bkmrk-api-status-%3C-endpoin" style="border-collapse: collapse; width: 100%; height: 208.578px;"><colgroup><col style="width: 99.8765%;"></col></colgroup><tbody><tr style="height: 29.7969px;"><td style="height: 29.7969px;">Api status</td></tr><tr><td>APIServices count</td></tr><tr><td>APIServices Status</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">&lt; Endpoint healthz&gt;</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">Services count  
</td></tr><tr><td>List Services  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">Namespaces count  
</td></tr><tr><td>List Namespaces  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">&lt; Component status healthz &gt;</td></tr><tr><td>Replication controllers count  
</td></tr><tr><td>Replication controllers status  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">Deployments</td></tr></tbody></table>

- One agent for each deployment

<table border="1" id="bkmrk-%3C-prefix.-nombre-dep" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 100%;"></col></colgroup><tbody><tr><td>&lt; prefix. deployment name &gt;</td></tr></tbody></table>

**Modules**

<table border="1" id="bkmrk-replicas-updated-rep" style="border-collapse: collapse; width: 100%; height: 208.578px;"><colgroup><col style="width: 99.8765%;"></col></colgroup><tbody><tr style="height: 29.7969px;"><td style="height: 29.7969px;">Replicas</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">Updated replicas</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">Ready replicas</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">Avalaible replicas</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">Unavalaible replicas</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">Available</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">Progressing</td></tr></tbody></table>

- A agent for each node

<table border="1" id="bkmrk-%3C-prefix.-nombre-nod" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 100%;"></col></colgroup><tbody><tr><td>&lt; prefix. Node name &gt;</td></tr></tbody></table>

**Modules**

<table border="1" id="bkmrk-pods-pods-%28%25%29-cpu-%28c" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 99.8765%;"></col></colgroup><tbody><tr><td>Pods</td></tr><tr><td>Pods (%)</td></tr><tr><td>CPU (cores)</td></tr><tr><td>CPU (%)</td></tr><tr><td>Memory (bytes)</td></tr><tr><td>Memory (%)</td></tr><tr><td>Condition &lt; condition &gt; status</td></tr></tbody></table>

- A agent for each pod

<table border="1" id="bkmrk-%3C-prefix.-nombre-pod" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 99.8765%;"></col></colgroup><tbody><tr><td>&lt; prefix. Pod name &gt;</td></tr></tbody></table>

**Modules**

<table border="1" id="bkmrk-pod-status-%3Cconditio" style="border-collapse: collapse; width: 100%; height: 208.6px;"><colgroup><col style="width: 99.8765%;"></col></colgroup><tbody><tr style="height: 29.8px;"><td style="height: 29.8px;">Pod status</td></tr><tr style="height: 29.8px;"><td style="height: 29.8px;">&lt;Condition status&gt;</td></tr><tr style="height: 29.8px;"><td style="height: 29.8px;">Containers</td></tr><tr style="height: 29.8px;"><td style="height: 29.8px;">Container &lt;nombre contenedor&gt; CPU (cores)</td></tr><tr style="height: 29.8px;"><td style="height: 29.8px;">Container &lt;nombre contenedor&gt; CPU (%)</td></tr><tr style="height: 29.8px;"><td style="height: 29.8px;">Container &lt;nombre contenedor&gt; Memory (bytes)</td></tr><tr style="height: 29.8px;"><td style="height: 29.8px;">Container &lt;nombre contenedor&gt; Memory (%)</td></tr></tbody></table>