From f1205340bb96dd0116410a32485b587bcf0c9fee Mon Sep 17 00:00:00 2001 From: micafer Date: Fri, 23 Apr 2021 08:50:35 +0200 Subject: [PATCH] Remove old doc --- monitoring/doc/README.md | 97 ---------------------------------------- 1 file changed, 97 deletions(-) delete mode 100644 monitoring/doc/README.md diff --git a/monitoring/doc/README.md b/monitoring/doc/README.md deleted file mode 100644 index 17f1678f7..000000000 --- a/monitoring/doc/README.md +++ /dev/null @@ -1,97 +0,0 @@ -# IM MONITORING PROBE - -## 1 INTRODUCTION - -The monitorization agent is a client-side software, that connects with IM to probe an IM instance. Agent does not need any open ports, just gather data from IM via IM API REST by GET, POST, PUT and DELETE http requests. Agent is composed by scripts that use IM API, and loads configurations from files that must be edited correctly by an administrator. - -## 2 FILE STRUCTURE - -The agent is composed by a principal python script named probeim.py, one support library IMinfrastructureOper.py and a directory conf with two configuration files, test.radl and authorizationHeader.txt. - -```sh -├── conf -│ ├── test.radl -│ └── authorizationHeader.txt -├── IMinfrastructureOper.py -└── probeim.py -``` - -### 2.1 SCRIPTS - -* File [probeim.py](https://github.com/grycap/im/blob/master/monitoring/probeim.py) is the executable script that gathers all measured data and sends it to zabbix. -* File [IMinfrastructureOper.py](https://github.com/grycap/im/blob/master/monitoring/IMinfrastructureOper.py) contains functionalities related to interaction with IM environment through its API. Here we can throw actions like creating infrastructure, listing infrastructure, creating VM, deleting infrastructure, and get the status of each of these actions. - -### 2.2 CONFIGURATION - -* authorizationHeader.txt - -Example from /conf [here](https://github.com/grycap/im/blob/master/monitoring/conf/authorizationHeader.txt) - -* test.radl - -Example from /conf [here](https://github.com/grycap/im/blob/master/monitoring/conf/test.radl) - -## 3 DATA SOURCES - -| METHOD /URL| Items| -| ------ | ------ | -| GET /infrastructures| List_inf | -| POST /infrastructures| Create_inf | -| PUT /infrastructures//start | Start_inf | -| POST /infrastructures/ - body: RADL document | Create_vm | -| DELETE /infrastructures// . -Sending build context to Docker daemon 35.33kB -Step 1/7 : FROM alpine:3.8 - ---> 0584b3d2cf6d -... -Successfully built afe963948e10 -[root@localhost improbe]# - -``` - -After image was created, set up required parameters and run the docker container. - -```sh - -[root@localhost improbe]# TOKEN=eyJraWQiOiJyc2E... - -# If you don't want to pass the token set it to the string 'None' -[root@localhost improbe]# TOKEN='None' - -[root@localhost improbe]# IM_URL=http://server.com/:8800 - -[root@localhost improbe]# docker run --name MY_improbe_CONTAINER -e TOKEN=$TOKEN -e IM_URL=$IM_URL -d / - -``` \ No newline at end of file