README.rst

   1 ..
   2        # Copyright 2017 Intel Research and Development Ireland Limited
   3        # *************************************************************
   4        # This file is part of OSM Monitoring module
   5        # All Rights Reserved to Intel Corporation
   6        #
   7        # Licensed under the Apache License, Version 2.0 (the "License"); you may
   8        # not use this file except in compliance with the License. You may obtain
   9        # a copy of the License at
  10        #
  11        #         http://www.apache.org/licenses/LICENSE-2.0
  12        #
  13        # Unless required by applicable law or agreed to in writing, software
  14        # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  15        # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  16        # License for the specific language governing permissions and limitations
  17        # under the License.
  18        #
  19        # For those usages not covered by the Apache License, Version 2.0 please
  20        # contact: prithiv.mohan@intel.com or adrian.hoban@intel.com
  21
  22 OSM MON Module
  23 ****************
  24
  25 MON is a monitoring module for OSM. This module leverages the monitoring
  26 tool of the supported VIMs through MON's native plugin to send and receive
  27 metrics and alarms for a VNF.
  28
  29 Components
  30 **********
  31
  32 MON module has the following components:
  33
  34  - MON Core, which includes Message Bus and Models
  35  - Plugin drivers for various VIMs
  36
  37 The MON module communication is classified as
  38
  39  - External to MON(requests to MON from SO)
  40  - Internal to MON(responses to MON from plugins)
  41
  42 Supported Plugins
  43 ******************
  44
  45 Supported VIMs are OpenStack, VMWare, AWS for now. MON can send/receive metrics
  46 and alarms from the following plugins in this release.
  47
  48  - Gnocchi, Aodh (OpenStack)
  49  - vROps (VMWare)
  50  - CloudWatch (AWS)
  51
  52 Developers
  53 **********
  54
  55   - Prithiv Mohan, Intel Research and Development Ltd, Ireland
  56   - Helena McGough, Intel Research and Development Ltd, Ireland
  57   - Sachin Bhangare, VMWare, India
  58   - Wajeeha Hamid, XFlow Research, Pakistan
  59
  60 Maintainers
  61 ***********
  62
  63  - Adrian Hoban, Intel Research and Development Ltd, Ireland
  64
  65 Contributions
  66 *************
  67
  68 For information on how to contribute to OSM MON module, please get in touch with
  69 the developer or the maintainer.
  70
  71 Any new code must follow the development guidelines detailed in the Dev Guidelines
  72 in the OSM Wiki and pass all tests.
  73
  74 Dev Guidelines can be found at:
  75
  76     [https://osm.etsi.org/wikipub/index.php/Workflow_with_OSM_tools]