X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=README.rst;h=d0e4b2040cee113c2df0c362d524cdc5d88979b9;hb=refs%2Fheads%2Ffeature7106;hp=9c4381bd69fe411a3965602429f48e22ee8cb683;hpb=b7e9ec0fe0dd55677c3a61e3221b6f9af1b303d2;p=osm%2FMON.git

diff --git a/README.rst b/README.rst
index 9c4381b..d0e4b20 100644
--- a/README.rst
+++ b/README.rst
@@ -1,45 +1,111 @@
+..
+ Copyright 2018 Whitestack, LLC
+ *************************************************************
+
+ This file is part of OSM Monitoring module
+ All Rights Reserved to Whitestack, LLC
+
+ Licensed under the Apache License, Version 2.0 (the "License"); you may
+ not use this file except in compliance with the License. You may obtain
+ a copy of the License at
+
+          http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ License for the specific language governing permissions and limitations
+ under the License.
+ For those usages not covered by the Apache License, Version 2.0 please
+ contact: bdiaz@whitestack.com or glavado@whitestack.com
+
 OSM MON Module
 ****************
 
-MON is a monitoring module for OSM. This module leverages the monitoring
-tool of the supported VIMs through MON's native plugin to send and receive
-metrics and alarms for a VNF.
+MON is a monitoring module for OSM.
+It collects metrics from VIMs and VNFs and exports them to a Prometheus TSDB.
+It manages and evaluates alarms based on those metrics.
 
 Components
 **********
 
 MON module has the following components:
 
- - MON Core, which includes Message Bus and Models
- - Plugin drivers for various VIMs
+* MON Central: Handles vim accounts registration and alarms CRUD operations, through messages in the Kafka bus.
+* 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.
+* MON Evaluator: Evaluates alarms and sends notifications through the Kafka bus when they trigger.
+
+
+Supported Collector Plugins
+***************************
+
+* OpenStack: Support for Gnocchi and legacy Ceilometer telemetry stacks.
+* VROPS: Support for VIO and VCD.
+* AWS: TBD
+
+Configuration
+*************
+
+Configuration is handled by the file [mon.yaml] (osm_mon/core/mon.yaml). You can pass a personalized configuration file
+through the `--config-file` flag.
 
-The MON module communication is classified as
+Example:
+
+    osm-mon-server --config-file your-config.yaml
+
+Configuration variables can also be overridden through environment variables by following the convention:
+OSMMON_<SECTION>_<VARIABLE>=<VALUE>
+
+Example:
+
+    OSMMON_GLOBAL_LOGLEVEL=DEBUG
+
+OSM NFVI Metrics
+****************
+
+The supported OSM NFVI metrics are the following:
+
+* average_memory_utilization
+* disk_read_ops
+* disk_write_ops
+* disk_read_bytes
+* disk_write_bytes
+* packets_in_dropped
+* packets_out_dropped
+* packets_received
+* packets_sent
+* cpu_utilization
+
+Development
+***********
 
- - External to MON(requests to MON from SO)
- - Internal to MON(responses to MON from plugins)
+The following is a reference for making changes to the code and testing them in a running OSM deployment.
 
-Supported Plugins
-******************
+::
 
-Supported VIMs are OpenStack, VMWare, AWS for now.MON can send/receive metrics
-and alarms from the following plugins in this release.
+    git clone https://osm.etsi.org/gerrit/osm/MON.git
+    cd MON
+    # Make your changes here
+    # Build the image
+    docker build -t opensourcemano/mon:develop -f docker/Dockerfile .
+    # Deploy that image in a running OSM deployment
+    docker service update --force --image opensourcemano/mon:develop osm_mon
+    # Change a specific env variable
+    docker service update --force --env-add VARIABLE_NAME=new_value osm_mon
+    # View logs
+    docker logs $(docker ps -qf name=osm_mon.1)
 
- - Gnocchi, Aodh (OpenStack)
- - vrOps (VMWare)
- - CloudWatch (AWS)
 
 Developers
 **********
 
-  - Prithiv Mohan, Intel Research and Development Ltd, Ireland
-  - Helena McGough, Intel Research and Development Ltd, Ireland
-  - Sachin Bhangare, VMWare, India
-  - Wajeeha Hamid, XFlow Research, Pakistan
+* Benjamín Díaz <bdiaz@whitestack.com>, Whitestack, Argentina
+* Prakash Kasar <pkasar@vmware.com>, VMWare
 
 Maintainers
 ***********
 
- - Adrian Hoban, Intel Research and Development Ltd, Ireland
+* Benjamín Díaz, Whitestack, Argentina
 
 Contributions
 *************