From 32da78e83a28ec0e614f5f57a50047517ad92b6c Mon Sep 17 00:00:00 2001 From: hailiu Date: Wed, 21 Sep 2016 11:55:06 +0800 Subject: Modify the doc file name JIRA: PREDICTION-68 Change-Id: I1306f5406d846e9de7138f49c75285ad7e0d7287 Signed-off-by: hailiu (cherry picked from commit fe63fc64c7a2b418875eafc271ed47c3155f2f3d) --- docs/design/Section_1_Use_cases_and_scenarios.rst | 23 +++++ ...Section_2_Gap_analysis_in_upstream_projects.rst | 105 +++++++++++++++++++++ docs/design/index.rst | 12 +++ .../Section_1_Use_cases_and_scenarios.rst | 23 ----- ...Section_2_Gap_analysis_in_upstream_projects.rst | 105 --------------------- docs/prediction_docs/index.rst | 12 --- 6 files changed, 140 insertions(+), 140 deletions(-) create mode 100644 docs/design/Section_1_Use_cases_and_scenarios.rst create mode 100644 docs/design/Section_2_Gap_analysis_in_upstream_projects.rst create mode 100644 docs/design/index.rst delete mode 100644 docs/prediction_docs/Section_1_Use_cases_and_scenarios.rst delete mode 100644 docs/prediction_docs/Section_2_Gap_analysis_in_upstream_projects.rst delete mode 100644 docs/prediction_docs/index.rst (limited to 'docs') diff --git a/docs/design/Section_1_Use_cases_and_scenarios.rst b/docs/design/Section_1_Use_cases_and_scenarios.rst new file mode 100644 index 0000000..86ca3c4 --- /dev/null +++ b/docs/design/Section_1_Use_cases_and_scenarios.rst @@ -0,0 +1,23 @@ +========================= +1 Use cases and scenarios +========================= + +Telecom services often have high available requirements. Failure prediction is one of the importance features +for high available requirements. Operator can handle faults in advance based on failure prediction. +This project focuses on data collection of failure prediction. + +The data collector consists of Ceilometer and Monasca which can be extended to plugin some other open source data collectors, +e.g. Zabbix, Nagios, Cacti. Based on real-time analytics techniques and machine learning techniques, +the failure predictor analyses the data gathered by the data collector to automatically determine whether a failure will happen. +If a failure is judged, then the failure predictor sends failure notifications to the failure +management module (e.g. the Doctor module), which could handle these notifications. + +Use case 1 +========== + +Based on infrastructure metrics, it is possible to predict failure of infrastructure, e.g. Nova, Neutron, MQ. + +Use case 2 +========== + +Based on metrics of infrastructure and VM inside, it is possible to predict failure of VNF. diff --git a/docs/design/Section_2_Gap_analysis_in_upstream_projects.rst b/docs/design/Section_2_Gap_analysis_in_upstream_projects.rst new file mode 100644 index 0000000..e871e32 --- /dev/null +++ b/docs/design/Section_2_Gap_analysis_in_upstream_projects.rst @@ -0,0 +1,105 @@ +=================================== +2 Gap analysis in upstream projects +=================================== + +This section presents the findings of gaps on existing VIM platforms. +The focus was to identify gaps based on the features and requirements specified in Section 3.3. +The analysis work performed resulted in the identification of gaps of which are herein presented. + +2.1 Monasca +=========== + +Monasca is an open-source monitoring-as-a-service (MONaaS) solution that integrates with OpenStack. +Even though it is still in its early days, it is the interest of the community that the platform be multi-tenant, +highly scalable, performant and fault-tolerant. Companion with a streaming alarm engine and a notification engine, +is a northbound REST API users can use to interact with Monasca. Hundreds of thousands of metrics per second can be processed [8]. + +2.1.1 Memory usage in HyperV +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +* Type: 'missing' +* Description: + + + To-be + + - Monasca should collect memory usage in HyperV. + + + As-is: + + - Monasca does not support querying memory usage of HyperV. + + + Gap + + - Monasca does not support querying memory usage of HyperV. + +2.1.2 Memory usage in Libvirt +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +* Type: 'missing' +* Description: + + + To-be + + - Monasca should collect memory usage in Libvirt. + + + As-is: + + - Monasca does not support querying memory usage of Libvirt. + + + Gap + + - Monasca does not support querying memory usage of Libvirt. + +2.2 Heat +========== + +Heat is an orchestration project of openstack. It can be used for deploy application. +Its cfn-hup tool can monitor metadata in VM and notify to heat. But this function is poor now, +we can extend cfn-hup to collect more information inside VM and make failure prediction. + +2.2.1 Cfn-hup +^^^^^^^^^^^^^ + +* Type: 'monitoring issue' +* Description: + + + To-be + + - Cfn-hup is able to collect more metrics than metadata inside VM. These metrics can be used for failure prediction. + + + As-is: + + - Cfn-hup just can monitor metadata inside VM. + + + Gap + + - Cfn-hup should monitor more information inside VM. + +2.3 VM Introspection +===================== + +Virtual machine introspection (VMI) is a mechanism that allows indirect inspection and manipulation of the state of virtual machines. +It resulted in a variety of VMI-based applications dealing with security, performance, and debugging in virtual machine environments. +Of course, it can be used to collect detail metrics in VM and used for failure prediction. + +LibVMI is an open source implementation of VMI supporting commodity hypervisors such as Xen and KVM. +LibVMI provides the functionality of mapping raw memory pages of VMs inside the privileged VM and relies on +monitoring software to interpret the contents of these mapped pages. For more information, please visit website: http://libvmi.com/ + +2.3.1 VM Introspection +^^^^^^^^^^^^^^^^^^^^^^ + +* Type: 'monitoring issue' +* Description: + + + To-be + + - VMI can be used to collect detail information inside VM for failure prediction. + + + As-is: + + - VMI can collect some information for security analysis. + + + Gap + + - Openstack is lack of a module used to collect detail information of VM based on VMI technology. diff --git a/docs/design/index.rst b/docs/design/index.rst new file mode 100644 index 0000000..ff96822 --- /dev/null +++ b/docs/design/index.rst @@ -0,0 +1,12 @@ +********************** +Prediction Project +********************** + +Contents: + +.. toctree:: + :numbered: + :maxdepth: 4 + + Section_1_Use_cases_and_scenarios.rst + Section_2_Gap_analysis_in_upstream_projects.rst diff --git a/docs/prediction_docs/Section_1_Use_cases_and_scenarios.rst b/docs/prediction_docs/Section_1_Use_cases_and_scenarios.rst deleted file mode 100644 index 86ca3c4..0000000 --- a/docs/prediction_docs/Section_1_Use_cases_and_scenarios.rst +++ /dev/null @@ -1,23 +0,0 @@ -========================= -1 Use cases and scenarios -========================= - -Telecom services often have high available requirements. Failure prediction is one of the importance features -for high available requirements. Operator can handle faults in advance based on failure prediction. -This project focuses on data collection of failure prediction. - -The data collector consists of Ceilometer and Monasca which can be extended to plugin some other open source data collectors, -e.g. Zabbix, Nagios, Cacti. Based on real-time analytics techniques and machine learning techniques, -the failure predictor analyses the data gathered by the data collector to automatically determine whether a failure will happen. -If a failure is judged, then the failure predictor sends failure notifications to the failure -management module (e.g. the Doctor module), which could handle these notifications. - -Use case 1 -========== - -Based on infrastructure metrics, it is possible to predict failure of infrastructure, e.g. Nova, Neutron, MQ. - -Use case 2 -========== - -Based on metrics of infrastructure and VM inside, it is possible to predict failure of VNF. diff --git a/docs/prediction_docs/Section_2_Gap_analysis_in_upstream_projects.rst b/docs/prediction_docs/Section_2_Gap_analysis_in_upstream_projects.rst deleted file mode 100644 index e871e32..0000000 --- a/docs/prediction_docs/Section_2_Gap_analysis_in_upstream_projects.rst +++ /dev/null @@ -1,105 +0,0 @@ -=================================== -2 Gap analysis in upstream projects -=================================== - -This section presents the findings of gaps on existing VIM platforms. -The focus was to identify gaps based on the features and requirements specified in Section 3.3. -The analysis work performed resulted in the identification of gaps of which are herein presented. - -2.1 Monasca -=========== - -Monasca is an open-source monitoring-as-a-service (MONaaS) solution that integrates with OpenStack. -Even though it is still in its early days, it is the interest of the community that the platform be multi-tenant, -highly scalable, performant and fault-tolerant. Companion with a streaming alarm engine and a notification engine, -is a northbound REST API users can use to interact with Monasca. Hundreds of thousands of metrics per second can be processed [8]. - -2.1.1 Memory usage in HyperV -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -* Type: 'missing' -* Description: - - + To-be - - - Monasca should collect memory usage in HyperV. - - + As-is: - - - Monasca does not support querying memory usage of HyperV. - - + Gap - - - Monasca does not support querying memory usage of HyperV. - -2.1.2 Memory usage in Libvirt -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -* Type: 'missing' -* Description: - - + To-be - - - Monasca should collect memory usage in Libvirt. - - + As-is: - - - Monasca does not support querying memory usage of Libvirt. - - + Gap - - - Monasca does not support querying memory usage of Libvirt. - -2.2 Heat -========== - -Heat is an orchestration project of openstack. It can be used for deploy application. -Its cfn-hup tool can monitor metadata in VM and notify to heat. But this function is poor now, -we can extend cfn-hup to collect more information inside VM and make failure prediction. - -2.2.1 Cfn-hup -^^^^^^^^^^^^^ - -* Type: 'monitoring issue' -* Description: - - + To-be - - - Cfn-hup is able to collect more metrics than metadata inside VM. These metrics can be used for failure prediction. - - + As-is: - - - Cfn-hup just can monitor metadata inside VM. - - + Gap - - - Cfn-hup should monitor more information inside VM. - -2.3 VM Introspection -===================== - -Virtual machine introspection (VMI) is a mechanism that allows indirect inspection and manipulation of the state of virtual machines. -It resulted in a variety of VMI-based applications dealing with security, performance, and debugging in virtual machine environments. -Of course, it can be used to collect detail metrics in VM and used for failure prediction. - -LibVMI is an open source implementation of VMI supporting commodity hypervisors such as Xen and KVM. -LibVMI provides the functionality of mapping raw memory pages of VMs inside the privileged VM and relies on -monitoring software to interpret the contents of these mapped pages. For more information, please visit website: http://libvmi.com/ - -2.3.1 VM Introspection -^^^^^^^^^^^^^^^^^^^^^^ - -* Type: 'monitoring issue' -* Description: - - + To-be - - - VMI can be used to collect detail information inside VM for failure prediction. - - + As-is: - - - VMI can collect some information for security analysis. - - + Gap - - - Openstack is lack of a module used to collect detail information of VM based on VMI technology. diff --git a/docs/prediction_docs/index.rst b/docs/prediction_docs/index.rst deleted file mode 100644 index ff96822..0000000 --- a/docs/prediction_docs/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -********************** -Prediction Project -********************** - -Contents: - -.. toctree:: - :numbered: - :maxdepth: 4 - - Section_1_Use_cases_and_scenarios.rst - Section_2_Gap_analysis_in_upstream_projects.rst -- cgit 1.2.3-korg