From 7c98e7f3cf4d09a51c8989360f0b029fd2164c5a Mon Sep 17 00:00:00 2001 From: Jessica Wagantall Date: Wed, 31 Jan 2018 01:41:01 +0000 Subject: Missing heartbeat microservice Issue-ID: DCAEGEN2-275 Change-Id: I2a2def9aef7664b58c6c3b74318343699fbf6c22 Signed-Off-by: Gokul Singaraju --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..702ebc7 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# Missing Heartbeat service + +# Interface Diagram +This repo is the thing in red: + +![Alt text](doc/cbs_diagram.png?raw=true) + +# Overview + +Missing Heartbeat service tracks Heartbeat messages from VNF VMs and generates Missing Heartbeat signal for certain number of failed heartbeats. The service tracks heartbeat Messages from DMaaP message routes and generates Missing Heartbeat signal. The IP:Port of DMaaP Message router for Input messages and Output messages needs to be configured. The input and output messages are in JSON format. +The VNF VMs input topic , output topic, periodicity and number of Heartbests can be configuredin cofig YAML file. + The format of output messages is still being worked out. +# Assumptions +1. Input and Output messages are in JSON format +2. The periodicity of Heartbeat messages is more than 15sec + + +# Testing +You need tox: +``` +pip install tox +``` +Then from the root dir, *not in a virtual env*, just run: +``` +tox +``` +You may have to alter the tox.ini for the python envs you wish to test with. + -- cgit 1.2.3-korg