From c918a20d5758bd7a50d4273c8c6c715fefc48fb1 Mon Sep 17 00:00:00 2001 From: Ethan Lynn Date: Mon, 5 Nov 2018 14:41:16 +0800 Subject: [PATCH] Organize VIO plugin documents This patch adds user guide for MultiCloud VIO plugin and re-organize current VIO documents. Change-Id: Idbe4357b760fbdbc734df19511771d7487d199d9 Issue-ID: MULTICLOUD-395 Signed-off-by: Ethan Lynn --- docs/index.rst | 2 +- .../Multicloud-Fake_Cloud-Guide.rst | 17 ++--- .../UserGuide-MultiCloud-VMware-OpenStack.rst | 89 ++++++++++++++++++++++ 3 files changed, 96 insertions(+), 12 deletions(-) rename docs/{ => multicloud-plugin-vio}/Multicloud-Fake_Cloud-Guide.rst (96%) create mode 100644 docs/multicloud-plugin-vio/UserGuide-MultiCloud-VMware-OpenStack.rst diff --git a/docs/index.rst b/docs/index.rst index 8e2196f..59aa8fb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -37,7 +37,7 @@ MultiCloud Plugins User Guides :maxdepth: 2 multicloud-plugin-windriver/UserGuide-MultiCloud-WindRiver-TitaniumCloud - Multicloud-Fake_Cloud-Guide + multicloud-plugin-vio/UserGuide-MultiCloud-VMware-OpenStack MultiCloud-Test-Guide MultiCloud Specifications diff --git a/docs/Multicloud-Fake_Cloud-Guide.rst b/docs/multicloud-plugin-vio/Multicloud-Fake_Cloud-Guide.rst similarity index 96% rename from docs/Multicloud-Fake_Cloud-Guide.rst rename to docs/multicloud-plugin-vio/Multicloud-Fake_Cloud-Guide.rst index 52011a5..c0e2f03 100644 --- a/docs/Multicloud-Fake_Cloud-Guide.rst +++ b/docs/multicloud-plugin-vio/Multicloud-Fake_Cloud-Guide.rst @@ -2,18 +2,13 @@ This work is licensed under a Creative Commons Attribution 4.0 International License. -================================ -MultiCloud Fake_Cloud User Case -================================ - - - -multilcoud-vmware server not only provide vio plugin to access real openstack -platform,but -also provide fake_cloud plugin which simulate thereal VIO function.The fake -cloud is suitable for testing openstack function if there is not real VIO -platform. +=================================================== +MultiCloud VMware OpenStack Simulated API User Case +=================================================== +When there's no real VIO environment at hands, we could still use fake_cloud APIs +in VIO plugin to test ONAP functions. These set of APIs simulate the real VIO functions +to interact with ONAP components. Make sure you environment have msb,aai service and multicloud-vmware config file has the right msb_ip and diff --git a/docs/multicloud-plugin-vio/UserGuide-MultiCloud-VMware-OpenStack.rst b/docs/multicloud-plugin-vio/UserGuide-MultiCloud-VMware-OpenStack.rst new file mode 100644 index 0000000..494482d --- /dev/null +++ b/docs/multicloud-plugin-vio/UserGuide-MultiCloud-VMware-OpenStack.rst @@ -0,0 +1,89 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 +.. International License. http://creativecommons.org/licenses/by/4.0 +.. Copyright (c) 2017-2018 VMware Inc. + +================================================= +MultiCloud Plugin for VMware Integrated OpenStack +================================================= + + +Supported features +~~~~~~~~~~~~~~~~~~ + +Northbound APIs for SO +---------------------- + +MultiCloud VIO Plugin supports OpenStack services proxy APIs since the beginning, and later +in Casablanca release, VIO plugin supports infra_workload API for SO. Use cases like vFW/vDNS +will leverage these APIs to instantiate VNFs. + +Northbound APIs for VF-C +------------------------ + +MultiCloud VIP Plugin supports VF-C by legacy Open-O APIs, and these APIs evolved according +to the requirements of VF-C and use cases. VoLTE use case leverage these APIs to instantiate +VNFs. + +Support Placement Policies for OOF +---------------------------------- + +Since Beijing release, to help OOF to make better placement decision, MultiCloud expose a capacity +check API. + +Support OpenStack Resources Discovery +------------------------------------- + +When onboarding new VMware OpenStack through ESR UI, VIO plugin could discover current OpenStack +Resources like flavors/images/networks/hypervisors, and update them in A&AI. + +Support HPA Discovery +--------------------- + +The HPA information will be automatically discovered and registered during VIM onboarding process. + +Support Cloud Agnostic Placement Policies +----------------------------------------- + +The cloud agnostic information like Guarantee/Burstable QoS will be automatically discovered and +registered during VIM onboarding process. + +Support Auto-Healing Close Loop +------------------------------- + +Leveraging VESAgent for meter collectrion and healthy report, VIO plugin supports +the auto-healing/auto-scaling scenarios in ONAP. + +Support Events Federation +------------------------- + +Federate the events of VIM layer with ONAP message bus, it provide direct help to HA fencing and improve the +efficiency of VM recover with performance verification. + + +Supported Use Cases +~~~~~~~~~~~~~~~~~~~ + +**vFW/vDNS** + + +**vCPE** + + +**VoLTE** + + + +Cloud Agnostic Placement Policy Enablement +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Currently two types of cloud agnostic intent policies are supported by VIO plugin, Guaranteed QoS and Burstable QoS. +VIO plugin will register them when VIM onboard and OOF could make better placement decision based on these policies. + +**Enable on it on flavors** + +Discovering these kind of features are through flavor's extra-specs, when you set `quota:cpu_reservation_percent=100` +and `quota:memory_reservation_percent=100` in flavor, it will be recognized as `Guaranteed QoS` supported platform. +When you choose other percentage for CPU and memory reservation, it will be recognized as `Burstable QoS` supported platform. +Related information will be registered to A&AI. + +.. include:: Multicloud-Fake_Cloud-Guide.rst -- 2.16.6