# Plugin openshift.

# Introduction

**Ver. 10-02-2022**

With this plug-in we will be able to view data and monitor our openshift nodes and pods.  
  
**Type:** Server plug-in

# Compatibility

<table border="1" id="bkmrk-sistemas-donde-se-ha" style="border-collapse: collapse; width: 100%; height: 56px;"><tbody><tr style="height: 28px;"><td style="width: 50%; height: 28px;">**Systems where tested**</td><td style="width: 50%; height: 28px;">CentOS 7, Fedora

</td></tr><tr style="height: 28px;"><td style="width: 50%; height: 28px;">**Systems where it should work**</td><td style="width: 50%; height: 28px;">Any linux system

</td></tr></tbody></table>

# Pre requisites

\- Have openshift CLI(oc) installed.

Information about cli installation can be found in the official documentation:

https://docs.openshift.com/container-platform/4.9/cli\_reference/openshift\_cli/getting-started-cli.html

  
\- Have a project created in openshift.

\- 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)

```
./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.

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)

\- Have the perl tools plugin in a folder called PandoraFMS.

\- Have installed the Pandora software agent

# Parameters

The plugin makes use of the following parameters:

<table border="1" id="bkmrk-cli-path-del-binario" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 50%;">**cli**</td><td style="width: 50%;">Path of the openshift oc binary</td></tr><tr><td style="width: 50%;">**user**</td><td style="width: 50%;">Your user name</td></tr><tr><td style="width: 50%;">**password**</td><td style="width: 50%;">Your password</td></tr><tr><td style="width: 50%;">**ip**</td><td style="width: 50%;">Ip of your environment (complete route with port)</td></tr><tr><td style="width: 50%;">**project**</td><td style="width: 50%;">openshift project</td></tr><tr><td style="width: 50%;">**mode**</td><td style="width: 50%;">xml sending mode (leave tentacle as default)</td></tr><tr><td style="width: 50%;">**tentacle ip**</td><td style="width: 50%;">Ip of pandora to send data to</td></tr><tr><td style="width: 50%;">**tentacle port**</td><td style="width: 50%;">Tentacle port number (default: 41121)</td></tr></tbody></table>

<table border="1" id="bkmrk-agent_openshift-para" style="border-collapse: collapse; width: 100%; height: 486px;"><tbody><tr style="height: 29px;"><td style="width: 50%; height: 29px;">**agent\_openshift**</td><td style="width: 50%; height: 29px;">To enable this agent, it creates modules with the number of deployments, services...etc. Leave it to 1 to enable it.</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">**agent\_node**</td><td style="width: 50%; height: 29px;">To enable one agent per node. Leave on 1 to enable it.</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">**agent\_pod**</td><td style="width: 50%; height: 29px;">To enable one agent per pod. Leave on 1 to enable it.</td></tr><tr style="height: 46px;"><td style="width: 50%; height: 46px;">**agent\_pod\_stats**</td><td style="width: 50%; height: 46px;">To enable an agent with the metrics of each pod. Leave on 1 to enable it.</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">**agent\_deployment**</td><td style="width: 50%; height: 29px;">To enable one agent per deployment. Leave on 1 to enable it.</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">**agent\_imagestreams**</td><td style="width: 50%; height: 29px;">To enable an agent with modules for each imagestreams, the number of imagestreams is determined with top\_imagestreams\_count. Set to 1 to enable it.</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">**agent\_csv  
</td><td style="width: 50%; height: 29px;">To enable an agent to create a module to monitor cluster service version.</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">**agent\_component\_status**</td><td style="width: 50%; height: 29px;">To enable an agent to create a module to monitor component status.</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">**agent\_operators**</td><td style="width: 50%; height: 29px;">To enable an agent to create a module to monitor operators.</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">**agent\_replication\_controller**</td><td style="width: 50%; height: 29px;">To enable an agent that will create a module for each replication controller in our environment. Leave to 1 to enable it.</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">**agent\_apiservice**</td><td style="width: 50%; height: 29px;">To enable an agent that will create a module for each service of our API. Leave to 1 to enable it.</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">**agent\_services**</td><td style="width: 50%; height: 29px;">To enable an agent that will create a module for each service in our environment. Leave to 1 to enable it.</td></tr><tr style="height: 46px;"><td style="width: 50%; height: 46px;">**top\_imagestream\_count**</td><td style="width: 50%; height: 46px;">Number of imagestreams to monitor in your environment. Default 11.</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">**prefix**</td><td style="width: 50%; height: 29px;">Customized name for the created agents</td></tr><tr style="height: 46px;"><td style="width: 50%; height: 46px;">**as\_server\_plugin**</td><td style="width: 50%; height: 46px;">If it is to be used as a server plugin, set it to 1 to activate it, if it is used as an agent plugin, set it to 0.</td></tr></tbody></table>

You will have to edit the conf by setting the required value.

Example:

```
# oc cli config
cli=/home/alejandro/Descargas/cli/oc
user=developer
password=developer
ip=https://<ip>:6443/
project=prueba
# transfer configuratios
mode=tentacle
tentacle_ip=192.168.1.200
tentacle_port=41121
# enabled metrics block
agent_openshift=1
agent_node=1
agent_pod=1
agent_pod_stats=1
agent_deployment=1
agent_imagestreams=1
agent_apiservice=1
agent_services=1
agent_replication_controller=1
agent_component_status=1
agent_csv=0
agent_operators=1
top_imagestreams_count=11
# define 
as_server_plugin=1
prefix=prueba
```

# Manual execution

The plugin can be executed manually by calling the perl plugin and the conf file:

```
<path pandora_openshift.pl> <pandora_openshift.conf>
```

If the conf option, as\_server\_plugin is set to 1 it will show a number on the screen, specifically a 9 if everything is correct.

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

If it is executed with as\_server\_plugin at 0 it will not return anything by terminal, unless there is some error that will paint a module in xml with the part that fails in the description.

# Configuration in Pandora FMS

**As agent plugin**

To be able to monitor from Pandora FMS with the plugin, we must call it from the conf of the software agent that is in the following path :

```
/etc/pandora/pandora_agent.conf
```

we will call it in the last line of the conf with the command module\_plugin , followed by the path of the perl plugin and the path of the conf file.

```
module_plugin perl <path .pl> <path .conf>
```

This can also be done from the console if remote configuration is enabled.

**As a server plugin**

Installation from console

To register the plugin, from the console, go to the "register plugin" section.

**[![register_plugin.png](https://pandorafms.com/guides/public/uploads/images/gallery/2022-04/scaled-1680-/register-plugin.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2022-04/register-plugin.png)**

Click on select file.

**[![register_plugin2.png](https://pandorafms.com/guides/public/uploads/images/gallery/2022-04/scaled-1680-/register-plugin2.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2022-04/register-plugin2.png)**

The .pspz2 file to be uploaded will be selected.

[![register1_openshift.png](https://pandorafms.com/guides/public/uploads/images/gallery/2022-04/scaled-1680-/register1-openshift.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2022-04/register1-openshift.png)

A message will appear informing that you have successfully registered.

[![register2_openshift.png](https://pandorafms.com/guides/public/uploads/images/gallery/2022-04/scaled-1680-/register2-openshift.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2022-04/register2-openshift.png)

Once the plugin is registered, we will see it in the plugins section.

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

You can access the plugin menu by clicking on the plugin title.

[![register3_openshift.png](https://pandorafms.com/guides/public/uploads/images/gallery/2022-04/scaled-1680-/register3-openshift.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2022-04/register3-openshift.png)

In parameters we will see the macro used by the plugin, this is not necessary to touch it

[![register4_openshift.png](https://pandorafms.com/guides/public/uploads/images/gallery/2022-04/scaled-1680-/register4-openshift.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2022-04/register4-openshift.png)

In the Default value field, we must enter the path to our .conf file.

[![register5_openshift.png](https://pandorafms.com/guides/public/uploads/images/gallery/2022-04/scaled-1680-/register5-openshift.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2022-04/register5-openshift.png)

Manual installation

Go to servers &gt; plugins:

[![image-1629974405286.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-08/scaled-1680-/image-1629974405286.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-08/image-1629974405286.png)

Click on add:

[![image-1629974430627.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-08/scaled-1680-/image-1629974430627.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-08/image-1629974430627.png)

We put the name and description of your choice:

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

We enter as command the execution with the path of the plugin:

```
/path_pandora_openshift path_pandora_openshift.conf
```

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

# Modules generated by the plugin

The plugin will generate :

\* prefix is a conf parameter that we can customize by adding any name we want.

\- One agent for each node of the environment with name : prefix\_OS\_Node\_&lt;node name&gt;.

Each node agent will have the following modules :

<table border="1" id="bkmrk-status-roles-age-ver" style="border-collapse: collapse; width: 100%; height: 203px;"><tbody><tr style="height: 29px;"><td style="width: 100%; height: 29px;">Status</td></tr><tr style="height: 29px;"><td style="width: 100%; height: 29px;">Roles</td></tr><tr style="height: 29px;"><td style="width: 100%; height: 29px;">Age</td></tr><tr><td style="width: 100%;">Versión</td></tr><tr style="height: 29px;"><td style="width: 100%; height: 29px;">cpu cores</td></tr><tr style="height: 29px;"><td style="width: 100%; height: 29px;">cpu %</td></tr><tr style="height: 29px;"><td style="width: 100%; height: 29px;">memory bytes</td></tr><tr style="height: 29px;"><td style="width: 100%; height: 29px;">memory %</td></tr></tbody></table>

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

\- One agent for each pod in the environment with name : prefix\_OS\_Pod\_&lt;pod name&gt;.

Each pod agent will have the following modules:

<table border="1" id="bkmrk-status-restarts-read" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 100%;">Status</td></tr><tr><td style="width: 100%;">Restarts</td></tr><tr><td style="width: 100%;">Ready</td></tr><tr><td style="width: 100%;">Age</td></tr></tbody></table>

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

\- An agent with name: prefix\_OS\_POD\_Stats

It will create a cpu(cores) module and a memory module for each pod.

<table border="1" id="bkmrk-%3Cnombre-pod%3E_cpu-%28co" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 100%;">&lt;nombre-pod&gt;\_Cpu (cores)</td></tr><tr><td style="width: 100%;">&lt;nombre-pod&gt;\_Memory (bytes)</td></tr></tbody></table>

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

\- One agent for each deployment with name :prefix\_ OS\_Deployment\_&lt;deployment-name&gt;.

Each Deployment agent will have the following data :

<table border="1" id="bkmrk-age-avalaible-ready-" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 100%;">Age</td></tr><tr><td style="width: 100%;">Avalaible</td></tr><tr><td style="width: 100%;">Ready</td></tr><tr><td style="width: 100%;">Up to date</td></tr></tbody></table>

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

\- An agent named "prefix\_OS\_Imagestreams\_stats" with modules for each imagestream in our environment (the number is configured in the .conf).

The agent OS\_Imagestreams\_stats will contain the following modules for each Imagestream:

<table border="1" id="bkmrk-nombre-imagestream--" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 100%;">&lt;nombre imagestream&gt; - storage</td></tr><tr><td style="width: 100%;">&lt;nombre imagestream&gt; - images</td></tr></tbody></table>

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

**- An agent with name "prefix\_OS\_Api\_service" with modules for each element of our api.**

<table border="1" id="bkmrk-elemento-api" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 100%;">Elemento API</td></tr></tbody></table>

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

**- An agent named "prefix\_OS\_Replication controllers with the following modules for each replication controller:**

<table border="1" id="bkmrk-replication-controll" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 100%;">&lt;Replication controller nombre&gt; Desired</td></tr><tr><td style="width: 100%;">&lt;Replication controller nombre&gt; Current</td></tr><tr><td style="width: 100%;">&lt;Replication controller nombre&gt; Ready</td></tr><tr><td style="width: 100%;">&lt;Replication controller nombre&gt; Age</td></tr></tbody></table>

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

**- An agent named "prefix\_OS\_Services" with a module for each service in our environment.**

<table border="1" id="bkmrk-servicio" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 100%;">Servicio</td></tr></tbody></table>

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

**- In addition, the plugin will generate an agent called "prefix\_Openshift" with modules that will indicate the number of certain elements in our environment.**

The Openshift agent will contain the following modules:

<table border="1" id="bkmrk-services-deployments" style="border-collapse: collapse; width: 100%; height: 87px;"><tbody><tr style="height: 29px;"><td style="width: 100%; height: 29px;">Services</td></tr><tr style="height: 29px;"><td style="width: 100%; height: 29px;">Deployments</td></tr><tr style="height: 29px;"><td style="width: 100%; height: 29px;">Namespaces</td></tr><tr><td style="width: 100%;">Nodes</td></tr><tr><td style="width: 100%;">Pods</td></tr><tr><td style="width: 100%;">Imagestreams</td></tr><tr><td style="width: 100%;">Replication controllers</td></tr></tbody></table>

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

**Example of agent view after plugin execution**

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

# Possible problems

**Error from server (ServiceUnavailable)**

```
Error from server (ServiceUnavailable): the server is currently unable to handle the request (get nodes.metrics.k8s.io)
Error from server (ServiceUnavailable): the server is currently unable to handle the request (get pods.metrics.k8s.io)
```

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

This error occurs because the commands that take the metrics from the nodes and pods cannot be invoked.

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

Most likely it is because the metric server or the monitoring option in the openshift environment is disabled, or has been disabled. Make sure the server is running, you can see more data about this error from the openshift console which will indicate if there is a problem with monitoring.

**Permissions**

The plugin has internal openshift CLI commands that need permissions to run from the pandora agent.

It is recommended to give permissions to both the perl plugin and the conf with :

```
chmod 755 pandora_openshift.pl
chmod 755 pandora_openshift.conf
```

At the same time, the cli binary must also have the correct permissions, in this case root:root so that the pandora agent can execute it.

```
chown root:root /path_oc
chmod 755 /path_oc
```

# Error control

The plugin works modularly, so if for some reason it fails to send the data, through terminal commands we can see where it is failing. We will be able to see that part of the environment that we are getting the data is having problems to send the data (pods, nodes, deployments, etc).

**With the parameter as\_server\_plugin of the conf to 0**

Executing the plugin by terminal, if any part fails when sending the data it will print a module and in the description we will see which agent is the one that fails.

```
<path pandora_openshift.pl> <path pandora_openshift.conf>
```

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

In this example we have painted a module in xml by terminal that tells us in the description that it has had problems with the pod\_stats agent.

**With the parameter as\_server\_plugin of the conf to 1**

If we execute manually the plugin by terminal with the option as\_server\_plugin to 1, this will paint by terminal a number, this number indicates in which part the plugin has failed.

<table border="1" id="bkmrk-9-ha-ejecutado-todo-" style="border-collapse: collapse; width: 100%; height: 290px;"><tbody><tr style="height: 29px;"><td style="width: 50%; height: 29px;">9</td><td style="width: 50%; height: 29px;">You have executed everything perfectly</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">8</td><td style="width: 50%; height: 29px;">Failed in openshift agent</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">7</td><td style="width: 50%; height: 29px;">Failed in replication controllers agent</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">6</td><td style="width: 50%; height: 29px;">Failed agent services</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">5</td><td style="width: 50%; height: 29px;">Agent api services failed</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">4</td><td style="width: 50%; height: 29px;">Failed in the imagestreams agent</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">3</td><td style="width: 50%; height: 29px;">Failed in deployments agents</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">2</td><td style="width: 50%; height: 29px;">You have failed in the agent pod stats</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">1</td><td style="width: 50%; height: 29px;">Failed in pod agents</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">0</td><td style="width: 50%; height: 29px;">Failed in node agents</td></tr></tbody></table>