From: Helena McGough Date: Fri, 13 Oct 2017 15:14:16 +0000 (+0100) Subject: Include documentation and updates for MON manual installation. X-Git-Tag: v4.0.0~60 X-Git-Url: https://osm.etsi.org/gitweb/?a=commitdiff_plain;h=refs%2Fchanges%2F78%2F5578%2F1;p=osm%2FMON.git Include documentation and updates for MON manual installation. - Provided documentation that can be included in the wiki - Include installation for manual MON installation Signed-off-by: Helena McGough --- diff --git a/README.rst b/README.rst index 99a910a..9093b6d 100644 --- a/README.rst +++ b/README.rst @@ -42,11 +42,11 @@ The MON module communication is classified as Supported Plugins ****************** -Supported VIMs are OpenStack, VMWare, AWS for now.MON can send/receive metrics +Supported VIMs are OpenStack, VMWare, AWS for now. MON can send/receive metrics and alarms from the following plugins in this release. - Gnocchi, Aodh (OpenStack) - - vrOps (VMWare) + - vROps (VMWare) - CloudWatch (AWS) Developers diff --git a/doc/MON_install_guide.rst b/doc/MON_install_guide.rst new file mode 100644 index 0000000..586fe2a --- /dev/null +++ b/doc/MON_install_guide.rst @@ -0,0 +1,117 @@ +.. + # Copyright 2017 Intel Research and Development Ireland Limited + # ************************************************************* + # This file is part of OSM Monitoring module + # All Rights Reserved to Intel Corporation + # + # 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: helena.mcgough@intel.com or adrian.hoban@intel.com + +OSM MON module +************** +This is a guide for using the OSM MON module source code to create a container +for monitoring. It will allow the use of the three plugins available to the +module; CloudWatch, OpenStack and vROPs. + + +At the moment this process requires a number of steps, but in the future the +process will become automated as it will become part of the osm installation +script which is contained within the devops repo. +: `` + + +For information on how to use this module refer to this usage guide: +: `` + + +You can find the source code for MON by following the link below: +https://osm.etsi.org/gitweb/?p=osm/MON.git;a=tree + + +Requirements +------------ +* lxc setup +* OSM deployment + + +Creating a MON Container +------------------------ +To create a MON container and utilize the supported functionality, clone the +MON repo and then run the provided script for container creation and +installation: + + :: + + git clone https://osm.etsi.org/gerrit/osm/MON.git + cd MON/scripts + . install_mon.sh + +This script will create a MON container, install all of the required packages, +as well as initializing the Apache Kafka and the vROPs web service. + + +Plugin Utilization +------------------ +There are three plugins supported by this monitoring module; CloudWatch, +OpenStack and vROPs. + +vROPs plugin +~~~~~~~~~~~~ +The vROPs plugin will automatically be installed after you have run the above +installation script. + +OpenStack Plugin +~~~~~~~~~~~~~~~~ +There are two OpenStack services supported within this module monitoring and +alarming, which are supported by the Gnocchi and Aodh plugins respectively. + +For more information on what metrics and alarms that these plugins support +please refer to the following documentation: +: ``. + +These documents will also describe what alarming and monitoring functionality +the plugins support. + +* To run the Gnocchi plugin run the following command: + + :: + + lxc exec MON - python /root/MON/plugins/OpenStack/Gnocchi/plugin_instance.py + +* To run the Aodh plugin run the following command: + + :: + + lxc exec MON - python /root/MON/plugins/OpenStack/Aodh/plugin_instance.py + +CloudWatch +~~~~~~~~~~ +The MON container supports a CloudWatch plugin as well. + + +Verification +------------ +* To confirm that you have created your MON container, run the following command + and confirm that your container is in a RUNNING state: + + :: + + lxc list | grep MON + +* Confirm that the kafka service is installed and running within the container: + + :: + + lxc exec MON -- service kafka status diff --git a/doc/MON_usage_guide.rst b/doc/MON_usage_guide.rst new file mode 100644 index 0000000..0a28318 --- /dev/null +++ b/doc/MON_usage_guide.rst @@ -0,0 +1,95 @@ +.. + # Copyright 2017 Intel Research and Development Ireland Limited + # ************************************************************* + # This file is part of OSM Monitoring module + # All Rights Reserved to Intel Corporation + # + # 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: helena.mcgough@intel.com or adrian.hoban@intel.com + +MON Usage Guide +*************** +This is a guide on how to use the MON module and its three plugins. + +The MON module sends requests to an from the SO via an Apache Kafka message +bus. Currently each message is sent on the message bus in json format, along +with a unique request key and its topic. + +The topics that the plugins will consume messages based on are: + +* alarm_request +* metric_request + +In return the plugins will send messages back to the SO with the following +topics: + +* alarm_response +* metric_response + +Each type of request has it's own unique key: +* create_alarm_request +* create_metric_request +* list_alarm_request +* list_metric_request +* delete_alarm_request +* delete_metric_request +* update_alarm_request +* update_metric_request +* acknowledge_alarm_request +* read_metric_data_request + +Sending Messages +---------------- +For each of the request message that can be sent there is a json schema defined +in the models directory of the MON repo: +: `` + +To send a valid message to the MON module for use by one of the plugins, your +message must match the json schema for that request type. + +Once you have created a valid json object with your message you can send it on +the message bus with the required topic and key. + +To ensure that the correct plugin uses your message you must also specify the +vim_type correctly: + + +----------------------+----------------------+ + | Plugin | vim_type | + +----------------------+----------------------+ + | CloudWatch | cloudwatch | + | | | + | OpenStack | openstack | + | | | + | vROPs | vrops | + +----------------------+----------------------+ + + +* Example + A create alarm request for the vROPs plugin would be sent with the following + information: + + - topic: alarm_request + - create_alarm_request + - message: a valid message that matches the json schema, with the vim_type + specified as vrops + +A KafkaProducer is used to send the message and it will be consumed by a +KafkaConsumer which is running for each plugin + + + .. note:: + + The SO support for sending and receiving messages is currently not + supported. Support will be added in a later release. diff --git a/doc/OpenStack/aodh_plugin_guide.rst b/doc/OpenStack/aodh_plugin_guide.rst new file mode 100644 index 0000000..544a8e8 --- /dev/null +++ b/doc/OpenStack/aodh_plugin_guide.rst @@ -0,0 +1,132 @@ +.. + # Copyright 2017 Intel Research and Development Ireland Limited + # ************************************************************* + # This file is part of OSM Monitoring module + # All Rights Reserved to Intel Corporation + # + # 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: helena.mcgough@intel.com or adrian.hoban@intel.com + +Aodh Plugin Guide for OSM MON +***************************** +The Aodh plugin for the MON module allows an OSM user to utilise the OpenStack +alarming functionality. + +This plugin allows you to create, list, delete and update alarms. These alarms +are based on metrics generated by the OpenStack Gnocchi plugin. + +Supported Alarms +---------------- +Currently the plugin only supports the following alarms for their corresponding +metrics: + + +-----------------------------+---------------------------------+ + | Gnocchi Metric | Aodh Alarm | + +-----------------------------+---------------------------------+ + | AVERAGE_MEMORY_UTILIZATION | AVERAGE_MEMORY_UTILIZATION | + | | | + | DISK_READ_OPS | DISK_READ_OPS | + | | | + | DISK_WRITE_OPS | DISK_WRITE_OPS | + | | | + | DISK_READ_BYTES | DISK_READ_BYTES | + | | | + | DISK_WRITE_BYTES | DISK_WRITE_BYTES | + | | | + | PACKETS_DROPPED | NET_PACKETS_DROPPED | + | | | + | PACKETS_RECEIVED | PACKETS_IN_ABOVE_THRESHOLD | + | | | + | PACKETS_SENT | PACKETS_OUT_ABOVE_THRESHOLD | + | | | + | CPU_UTILIZATION | CPU_UTILIZATION_ABOVE_THRESHOLD | + +-----------------------------+---------------------------------+ + +Creating an Alarm +----------------- +To create an alarm for one of the supported metrics a no. of configuration +parameters must be set: + +* alarm_name: Defines the name of the alarm and must correspond to the desired + metric. +* metric_name: Defines the name of the metric for which the alarm is to be + created. +* resource_uuid: Defines the resource that the chosen metric will monitor. +* severity: defines the significance of the alarm if it is triggered. Options + for this parameter include: + + - WARNING + - MINOR + - MAJOR + - CRITICAL + - INDETERMINATE + +* operation: Defines how the metric data is to be evaluated when determining if + the alarm has been triggered. Valid inputs for this parameter include: + + - GE (greater than or equal to) + - LE (less that or equal to) + - GT (greater than) + - LT (less than) + - EQ (equal to) + +* threshold_value: Defines a threshold that the metric values will be compared + against to determine if the alarm should be triggered. +* statistic: Defines the way in which the metric data should be evaluated. + Valid options for this parameter include: + + - AVERAGE + - MINIMUM + - MAXIMUM + - COUNT + - SUM + + .. note:: + + - To create a valid alarm the metric that you request must exist as a + Gnocchi metric and it must exist for the resource requested. + - Multiple alarms can be created for the same metric as you can define + different thresholds, operations, etc. for each alarm. + +Deleting an Alarm +----------------- +To delete an alarm just before a delete request with the alarm_id of the alarm +you wish to delete. + +Listing Alarms +-------------- +A full list of alarms will be generated if a list request is performed and no +configuration parameters are set. + +To generate a more specified list you can define one or both of the following +configuration parameters: + +* alarm_name +* severity + + .. note:: + + For now resource_uuid must be defined when generating a list of alarms. + This will be removed in a future release. + +Updating an alarm +----------------- +Certain parameters of an alarm can be updated after the alarm has been created. +These include: + +* threshold_value +* operation +* statistic +* severity diff --git a/doc/OpenStack/gnocchi_plugin_guide.rst b/doc/OpenStack/gnocchi_plugin_guide.rst new file mode 100644 index 0000000..e6831cf --- /dev/null +++ b/doc/OpenStack/gnocchi_plugin_guide.rst @@ -0,0 +1,100 @@ +.. + # Copyright 2017 Intel Research and Development Ireland Limited + # ************************************************************* + # This file is part of OSM Monitoring module + # All Rights Reserved to Intel Corporation + # + # 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: helena.mcgough@intel.com or adrian.hoban@intel.com + +Gnocchi Plugin Guide for OSM MON +******************************** +The Gnocchi plugin for the MON module allows an OSM user to utilise metric and +resource functionality from their OpenStack deployment. + +This plugin allows you to create, list, delete and read metric data. + + .. note:: + + + An update metric request can also be performed but Gnocchi does not + support this functionality, your request will just be logged. + +Supported Metrics +----------------- +Currently this plugin only supports the following metrics: + +* AVERAGE_MEMORY_UTILIZATION +* DISK_READ_OPS +* DISK_WRITE_OPS +* DISK_READ_BYTES +* DISK_WRITE_BYTES +* PACKETS_DROPPED +* PACKETS_RECEIVED +* PACKETS_SENT +* CPU_UTILIZATION + +Configuring a Metric +-------------------- +Any of the above OpenStack metrics can be configured based on the following +configuration options: + +* Resource_uuid: Specifies the resource that your metric will be configured for. +* Metric_name: Specify one of the above metrics for your desired resource. +* Metric_unit: the unit that you wish your metric to be monitored in. + + .. note:: + + + Your metric can only be specified once for a particular resource. + +Deleting a Metric +----------------- +To delete a metric all that is required is to specify the metric_uuid of the +metric you wish to delete. + +Listing Metrics +--------------- +A full list of OSM generated metrics can be created by perform a list request +without defining any list parameters. + +Specific lists can also be created based on two different input parameters: + +* Metric_name +* Resource_uuid + +These parameters will generate a list of metrics that have the metric_name +and/or the resource_uuid defined. These parameters can be defined seperately or +in combination. + +Reading Metric Data +------------------- +To define what metric data you want to read from the Gnocchi database a no. of +parameters have to be defined: + +* Metric_uuid: To define which metric's data you would like to read. +* Collection_unit: Defines the unit of time that you want to read the metric + data over. + + .. note:: + + + The units that you can define include: HR, DAY, WEEK, MONTH, YEAR. + +* Collection_period: defines the integer value of the collection period. + E.g. 1 DAY. + +This type of request results in a list of data values and a corresponding list +of timestamps. diff --git a/doc/OpenStack/openstack_plugins.rst b/doc/OpenStack/openstack_plugins.rst new file mode 100644 index 0000000..f67fd17 --- /dev/null +++ b/doc/OpenStack/openstack_plugins.rst @@ -0,0 +1,57 @@ +.. + # Copyright 2017 Intel Research and Development Ireland Limited + # ************************************************************* + # This file is part of OSM Monitoring module + # All Rights Reserved to Intel Corporation + # + # 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: helena.mcgough@intel.com or adrian.hoban@intel.com + +OpenStack Plugin Guide +********************** +The OSM MON module provides support for two different OpenStack plugins that +provide monitoring functionality. The Gnocchi plugin implements metric +functionality, whilst the Aodh plugin supports alarming functionality. + +Gnocchi +------- +Gnocchi is a timeseries, metrics and resources database, which allows you to +store and access the information and history of resources and their metrics. + +For more information on Gnocchi please refer to the source code/documentation: + + :: + + https://github.com/gnocchixyz/gnocchi + +For plugin specific instructions and configuration options please refer to the +following guide: +: `` + +Aodh +---- +Aodh is OpenStack's alarming project, it enables alarms to be created based on +Gnocchi metrics. Rules can be defined for these metrics to create these alarms. + +For more information on this project please refer to the source +code/documentation: + + :: + + https://github.com/openstack/aodh + +For plugin specific instructions and configuration options please refer to the +following guide: +: `` diff --git a/doc/plugins/OpenStack/aodh_plugin_guide.rst b/doc/plugins/OpenStack/aodh_plugin_guide.rst deleted file mode 100644 index b19eca3..0000000 --- a/doc/plugins/OpenStack/aodh_plugin_guide.rst +++ /dev/null @@ -1,124 +0,0 @@ -.. - # Copyright 2017 Intel Research and Development Ireland Limited - # ************************************************************* - # This file is part of OSM Monitoring module - # All Rights Reserved to Intel Corporation - # - # 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: helena.mcgough@intel.com or adrian.hoban@intel.com - -Aodh Plugin Guide for OSM MON -***************************** -The Aodh plugin for the MON module allows an OSM user to utilise the OpenStack -alarming functionality. - -This plugin allows you to create, list, delete and update alarms. These alarms -are based on metrics generated by the OpenStack Gnocchi plugin. - -Supported Alarms ----------------- -Currently the plugin only supports the following alarms for their corresponding -metrics: - - +-----------------------------+---------------------------------+ - | Gnocchi Metric | Aodh Alarm | - +-----------------------------+---------------------------------+ - | AVERAGE_MEMORY_UTILIZATION | AVERAGE_MEMORY_UTILIZATION | - | DISK_READ_OPS | DISK_READ_OPS | - | DISK_WRITE_OPS | DISK_WRITE_OPS | - | DISK_READ_BYTES | DISK_READ_BYTES | - | DISK_WRITE_BYTES | DISK_WRITE_BYTES | - | PACKETS_DROPPED | NET_PACKETS_DROPPED | - | PACKETS_RECEIVED | PACKETS_IN_ABOVE_THRESHOLD | - | PACKETS_SENT | PACKETS_OUT_ABOVE_THRESHOLD | - | CPU_UTILIZATION | CPU_UTILIZATION_ABOVE_THRESHOLD | - +-----------------------------+---------------------------------+ - -Creating an Alarm ------------------ -To create an alarm for one of the supported metrics a no. of configuration -parameters must be set: - -* alarm_name: Defines the name of the alarm and must correspond to the desired - metric. -* metric_name: Defines the name of the metric for which the alarm is to be - created. -* resource_uuid: Defines the resource that the chosen metric will monitor. -* severity: defines the significance of the alarm if it is triggered. Options - for this parameter include: - - - WARNING - - MINOR - - MAJOR - - CRITICAL - - INDETERMINATE - -* operation: Defines how the metric data is to be evaluated when determining if - the alarm has been triggered. Valid inputs for this parameter include: - - - GE (greater than or equal to) - - LE (less that or equal to) - - GT (greater than) - - LT (less than) - - EQ (equal to) - -* threshold_value: Defines a threshold that the metric values will be compared - against to determine if the alarm should be triggered. -* statistic: Defines the way in which the metric data should be evaluated. - Valid options for this parameter include: - - - AVERAGE - - MINIMUM - - MAXIMUM - - COUNT - - SUM - - .. note:: - - - To create a valid alarm the metric that you request must exist as a - Gnocchi metric and it must exist for the resource requested. - - Multiple alarms can be created for the same metric as you can define - different thresholds, operations, etc. for each alarm. - -Deleting an Alarm ------------------ -To delete an alarm just before a delete request with the alarm_id of the alarm -you wish to delete. - -Listing Alarms --------------- -A full list of alarms will be generated if a list request is performed and no -configuration parameters are set. - -To generate a more specified list you can define one or both of the following -configuration parameters: - -* alarm_name -* severity - - .. note:: - - For now resource_uuid must be defined when generating a list of alarms. - This will be removed in a future release. - -Updating an alarm ------------------ -Certain parameters of an alarm can be updated after the alarm has been created. -These include: - -* threshold_value -* operation -* statistic -* severity diff --git a/doc/plugins/OpenStack/gnocchi_plugin_guide.rst b/doc/plugins/OpenStack/gnocchi_plugin_guide.rst deleted file mode 100644 index e6831cf..0000000 --- a/doc/plugins/OpenStack/gnocchi_plugin_guide.rst +++ /dev/null @@ -1,100 +0,0 @@ -.. - # Copyright 2017 Intel Research and Development Ireland Limited - # ************************************************************* - # This file is part of OSM Monitoring module - # All Rights Reserved to Intel Corporation - # - # 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: helena.mcgough@intel.com or adrian.hoban@intel.com - -Gnocchi Plugin Guide for OSM MON -******************************** -The Gnocchi plugin for the MON module allows an OSM user to utilise metric and -resource functionality from their OpenStack deployment. - -This plugin allows you to create, list, delete and read metric data. - - .. note:: - - - An update metric request can also be performed but Gnocchi does not - support this functionality, your request will just be logged. - -Supported Metrics ------------------ -Currently this plugin only supports the following metrics: - -* AVERAGE_MEMORY_UTILIZATION -* DISK_READ_OPS -* DISK_WRITE_OPS -* DISK_READ_BYTES -* DISK_WRITE_BYTES -* PACKETS_DROPPED -* PACKETS_RECEIVED -* PACKETS_SENT -* CPU_UTILIZATION - -Configuring a Metric --------------------- -Any of the above OpenStack metrics can be configured based on the following -configuration options: - -* Resource_uuid: Specifies the resource that your metric will be configured for. -* Metric_name: Specify one of the above metrics for your desired resource. -* Metric_unit: the unit that you wish your metric to be monitored in. - - .. note:: - - - Your metric can only be specified once for a particular resource. - -Deleting a Metric ------------------ -To delete a metric all that is required is to specify the metric_uuid of the -metric you wish to delete. - -Listing Metrics ---------------- -A full list of OSM generated metrics can be created by perform a list request -without defining any list parameters. - -Specific lists can also be created based on two different input parameters: - -* Metric_name -* Resource_uuid - -These parameters will generate a list of metrics that have the metric_name -and/or the resource_uuid defined. These parameters can be defined seperately or -in combination. - -Reading Metric Data -------------------- -To define what metric data you want to read from the Gnocchi database a no. of -parameters have to be defined: - -* Metric_uuid: To define which metric's data you would like to read. -* Collection_unit: Defines the unit of time that you want to read the metric - data over. - - .. note:: - - - The units that you can define include: HR, DAY, WEEK, MONTH, YEAR. - -* Collection_period: defines the integer value of the collection period. - E.g. 1 DAY. - -This type of request results in a list of data values and a corresponding list -of timestamps. diff --git a/doc/plugins/OpenStack/openstack_plugins.rst b/doc/plugins/OpenStack/openstack_plugins.rst deleted file mode 100644 index f67fd17..0000000 --- a/doc/plugins/OpenStack/openstack_plugins.rst +++ /dev/null @@ -1,57 +0,0 @@ -.. - # Copyright 2017 Intel Research and Development Ireland Limited - # ************************************************************* - # This file is part of OSM Monitoring module - # All Rights Reserved to Intel Corporation - # - # 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: helena.mcgough@intel.com or adrian.hoban@intel.com - -OpenStack Plugin Guide -********************** -The OSM MON module provides support for two different OpenStack plugins that -provide monitoring functionality. The Gnocchi plugin implements metric -functionality, whilst the Aodh plugin supports alarming functionality. - -Gnocchi -------- -Gnocchi is a timeseries, metrics and resources database, which allows you to -store and access the information and history of resources and their metrics. - -For more information on Gnocchi please refer to the source code/documentation: - - :: - - https://github.com/gnocchixyz/gnocchi - -For plugin specific instructions and configuration options please refer to the -following guide: -: `` - -Aodh ----- -Aodh is OpenStack's alarming project, it enables alarms to be created based on -Gnocchi metrics. Rules can be defined for these metrics to create these alarms. - -For more information on this project please refer to the source -code/documentation: - - :: - - https://github.com/openstack/aodh - -For plugin specific instructions and configuration options please refer to the -following guide: -: `` diff --git a/plugins/OpenStack/Aodh/plugin_instance.py b/plugins/OpenStack/Aodh/plugin_instance.py index aaba1e4..b3a02ac 100644 --- a/plugins/OpenStack/Aodh/plugin_instance.py +++ b/plugins/OpenStack/Aodh/plugin_instance.py @@ -22,6 +22,9 @@ """Aodh plugin for the OSM monitoring module.""" import logging +import sys + +sys.path.append("MON/") logging.basicConfig(filename='aodh_MON.log', format='%(asctime)s %(message)s', datefmt='%m/%d/%Y %I:%M:%S %p', filemode='a', diff --git a/plugins/OpenStack/Gnocchi/plugin_instance.py b/plugins/OpenStack/Gnocchi/plugin_instance.py index 983af3d..eb8b0e3 100644 --- a/plugins/OpenStack/Gnocchi/plugin_instance.py +++ b/plugins/OpenStack/Gnocchi/plugin_instance.py @@ -22,6 +22,9 @@ """Gnocchi plugin for the OSM monitoring module.""" import logging +import sys + +sys.path.append("MON/") logging.basicConfig(filename='gnocchi_MON.log', datefmt='%m/%d/%Y %I:%M:%S %p', format='%(asctime)s %(message)s', filemode='a', diff --git a/scripts/install_mon.sh b/scripts/install_mon.sh new file mode 100644 index 0000000..2a99b8a --- /dev/null +++ b/scripts/install_mon.sh @@ -0,0 +1,40 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- + +# Copyright 2017 Intel Research and Development Ireland Limited +# ************************************************************* + +# This file is part of OSM Monitoring module +# All Rights Reserved to Intel Corporation + +# 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 limitation + +# under the License. + +# For those usages not covered by the Apache License, Version 2.0 please +# contact: prithiv.mohan@intel.com or adrian.hoban@intel.com + +#__author__ = "Prithiv Mohan" +#__date__ = "13/Oct/2017" + +#This is a temporary installation script for the MON Module. From the next +#point release, MON will be a part of the OSM Module and can be installed +#through the install_osm.sh script, just like any other modules. + +lxc launch ubuntu:16.04 MON +lxc exec MON -- apt-get --yes update +lxc exec MON -- apt-get --yes install git python python-pip libmysqlclient-dev +lxc exec MON -- git clone https://osm.etsi.org/gerrit/osm/MON.git +lxc exec MON -- pip install -r /root/MON/requirements.txt +lxc exec MON -- python /root/MON/kafkad +lxc exec MON -- . /root/MON/scripts/kafka.sh +lxc exec MON -- . /root/MON/plugins/vRealiseOps/vROPs_Webservice/install.sh