OpenVino Alert - Manager

Table of Contents

• 1. Introduction
• 2. Bussines Logic
• 3. Prerequisites
  • 3.1. Hardware
  • 3.2. Software
  • 3.3. Checks
• 4. Building
  • 4.1. Build with Docker
    • 4.1.1. Prerequisites
    • 4.1.2. Installation
• 5. Usage
  • 5.1. Put Messages in the QUEUE
• 6. Docker Options

1. Introduction

This project consists on publish a containerized microservice that can receive messages and put them into a ZEROMQ queue.

2. Bussines Logic

This Microservice will receive the alarms that are being generate by Blindspot and it will put the alarm in the queue to be push throw another microservice directly to the cloud.

3. Prerequisites

This Microservice Runs on any Operative System, for any test we recommend Ubuntu in his latest version.

3.1. Hardware

The Microservice will run in any Device that can support an OS.

3.2. Software

The Microservice is written in Python so we need to any OS that support this language.

3.3. Checks

At this point you only need to ensure that you have an OS running with Python and Docker inside.

4. Building

4.1. Build with Docker

4.1.1. Prerequisites

• Docker. To install on Ubuntu, run:

sudo snap install docker

sudo groupadd docker

sudo usermod -aG docker $USER

4.1.2. Installation

1. Clone the repository at desired location:

git clone git@github.com:incluit/OpenVino-Alert-Manager.git

2. Change to the top git repository:

cd OpenVino-Alert-Manager

3. Build the docker:

make docker-build
make docker-run

5. Usage

5.1. Put Messages in the QUEUE

1. For sending simulated events to the Alert Manager, open a browser and paste the following url:

http://localhost:5000/piq/?param=[Message to put in the QUEUE]

Also, you can send the event message through console terminal as follows:

curl http://localhost:5000/piq/?param=MessageToPutInTheQUEUE

2. For verifying all sent messages check the log file inside Container (Only Linux System) by executing the following command:

docker exec -it docker-pub-server cat /app/logs/subscriber.log

6. Docker Options

• Stop the docker container

make docker-stop

• Remove the docker container

make docker-remove