README.rst

   1 OSM MON Module
   2 ****************
   3
   4 MON is a monitoring module for OSM. This module leverages the monitoring
   5 tool of the supported VIMs through MON's native plugin to send and receive
   6 metrics and alarms for a VNF.
   7
   8 Components
   9 **********
  10
  11 MON module has the following components:
  12
  13  - MON Core, which includes Message Bus and Models
  14  - Plugin drivers for various VIMs
  15
  16 The MON module communication is classified as
  17
  18  - External to MON(requests to MON from SO)
  19  - Internal to MON(responses to MON from plugins)
  20
  21 Supported Plugins
  22 ******************
  23
  24 Supported VIMs are OpenStack, VMWare, AWS for now.MON can send/receive metrics
  25 and alarms from the following plugins in this release.
  26
  27  - Gnocchi, Aodh (OpenStack)
  28  - vrOps (VMWare)
  29  - CloudWatch (AWS)
  30
  31 Developers
  32 **********
  33
  34   - Prithiv Mohan, Intel Research and Development Ltd, Ireland
  35   - Helena McGough, Intel Research and Development Ltd, Ireland
  36   - Sachin Bhangare, VMWare, India
  37   - Wajeeha Hamid, XFlow Research, Pakistan
  38
  39 Maintainers
  40 ***********
  41
  42  - Adrian Hoban, Intel Research and Development Ltd, Ireland
  43
  44 Contributions
  45 *************
  46
  47 For information on how to contribute to OSM MON module, please get in touch with
  48 the developer or the maintainer.
  49
  50 Any new code must follow the development guidelines detailed in the Dev Guidelines
  51 in the OSM Wiki and pass all tests.
  52
  53 Dev Guidelines can be found at:
  54
  55     [https://osm.etsi.org/wikipub/index.php/Workflow_with_OSM_tools]