# 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
```