README.rst

   1 ..
   2  Copyright 2018 Whitestack, LLC
   3  *************************************************************
   4
   5  This file is part of OSM Monitoring module
   6  All Rights Reserved to Whitestack, LLC
   7
   8  Licensed under the Apache License, Version 2.0 (the "License"); you may
   9  not use this file except in compliance with the License. You may obtain
  10  a copy of the License at
  11
  12           http://www.apache.org/licenses/LICENSE-2.0
  13
  14  Unless required by applicable law or agreed to in writing, software
  15  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  16  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  17  License for the specific language governing permissions and limitations
  18  under the License.
  19  For those usages not covered by the Apache License, Version 2.0 please
  20  contact: bdiaz@whitestack.com or glavado@whitestack.com
  21
  22 OSM MON Module
  23 ****************
  24
  25 MON is a monitoring module for OSM.
  26 It collects metrics from VIMs and VNFs and exports them to a Prometheus TSDB.
  27 It manages and evaluates alarms based on those metrics.
  28
  29 Components
  30 **********
  31
  32 MON module has the following components:
  33
  34  - MON Central: Handles vim accounts registration and alarms CRUD operations, through messages in the Kafka bus.
  35  - MON Collector: Collects metrics from VIMs and VNFs and then exports them to a TSDB. It uses a plugin model both for collectors and for backends.
  36  - MON Evaluator: Evaluates alarms and sends notifications through the Kafka bus when they trigger.
  37
  38
  39 Supported Collector Plugins
  40 ***************************
  41
  42  - OpenStack: Requires Aodh and Gnocchi to be enabled.
  43  - VROPS: TBD
  44  - AWS: TBD
  45
  46 Developers
  47 **********
  48
  49   - Benjamín Díaz, Whitestack, Argentina
  50
  51 Maintainers
  52 ***********
  53
  54  - Gianpietro Lavado, Whitestack, Peru
  55
  56 Contributions
  57 *************
  58
  59 For information on how to contribute to OSM MON module, please get in touch with
  60 the developer or the maintainer.
  61
  62 Any new code must follow the development guidelines detailed in the Dev Guidelines
  63 in the OSM Wiki and pass all tests.
  64
  65 Dev Guidelines can be found at:
  66
  67     [https://osm.etsi.org/wikipub/index.php/Workflow_with_OSM_tools]