From 01ff8987aa2b1439a02712f4bb501c704287309e Mon Sep 17 00:00:00 2001 From: Harry Huang Date: Thu, 30 Mar 2017 22:57:04 +0800 Subject: Add scenario description in docs Change-Id: Ifc78defa03099c284995108f9d00315bbff2495a Signed-off-by: Harry Huang --- docs/development/design/index.rst | 6 +- docs/development/overview/index.rst | 6 +- docs/release/configguide/index.rst | 6 +- docs/release/scenarios/index.rst | 14 +++++ .../scenarios/os-nosdn-openo-ha.description.rst | 66 ++++++++++++++++++++++ 5 files changed, 89 insertions(+), 9 deletions(-) create mode 100644 docs/release/scenarios/index.rst create mode 100644 docs/release/scenarios/os-nosdn-openo-ha.description.rst diff --git a/docs/development/design/index.rst b/docs/development/design/index.rst index b5278fe..16a3238 100644 --- a/docs/development/design/index.rst +++ b/docs/development/design/index.rst @@ -1,9 +1,9 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -************************************* -OPNFV Opera Installation Instructions -************************************* +****************** +OPNFV Opera Design +****************** .. toctree:: :numbered: diff --git a/docs/development/overview/index.rst b/docs/development/overview/index.rst index 2566863..b1eb4f6 100644 --- a/docs/development/overview/index.rst +++ b/docs/development/overview/index.rst @@ -1,9 +1,9 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -************************************* -OPNFV Opera Installation Instructions -************************************* +******************** +OPNFV Opera Overview +******************** .. toctree:: :numbered: diff --git a/docs/release/configguide/index.rst b/docs/release/configguide/index.rst index c97215b..3bfdb5b 100644 --- a/docs/release/configguide/index.rst +++ b/docs/release/configguide/index.rst @@ -1,9 +1,9 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -************************************* -OPNFV Opera Installation Instructions -************************************* +******************************* +OPNFV Opera Config Instructions +******************************* .. toctree:: :numbered: diff --git a/docs/release/scenarios/index.rst b/docs/release/scenarios/index.rst new file mode 100644 index 0000000..c791c14 --- /dev/null +++ b/docs/release/scenarios/index.rst @@ -0,0 +1,14 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +.. _opera-os-nosdn-openo-ha: + +****************************************** +os-nosdn-openo-ha Overview and Description +****************************************** + +.. toctree:: + :numbered: + :maxdepth: 4 + + os-nosdn-openo-ha.description.rst diff --git a/docs/release/scenarios/os-nosdn-openo-ha.description.rst b/docs/release/scenarios/os-nosdn-openo-ha.description.rst new file mode 100644 index 0000000..142b6cb --- /dev/null +++ b/docs/release/scenarios/os-nosdn-openo-ha.description.rst @@ -0,0 +1,66 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) by Yingjun Li (HUAWEI) and Harry Huang (HUAWEI) + +os-nosdn-openo-ha Description +=========================== + +Introduction +------------ + +Since OPNFV board expanded its scope to include NFV MANO last year, +several upstream open source projects have been created to develop +MANO solutions. Each solution has demonstrated its unique value in +specific area. Open-Orchestrator (OPEN-O) project is one of such +communities. Opera seeks to develop requirements for OPEN-O MANO +support in the OPNFV reference platform, with the plan to eventually +integrate OPEN-O in OPNFV as a non-exclusive upstream MANO. The +project will definitely benefit not only OPNFV and Open-O, but can +be referenced by other MANO integration as well. In particular, this +project is basically use case driven. Based on that, it will focus +on the requirement of interfaces/data models for integration among +various components and OPNFV platform. The requirement is designed +to support integration among Open-O as NFVO with Juju as VNFM and +OpenStack as VIM. + +Currently OPNFV has already included upstream OpenStack as VIM, and +Juju and Tacker have been being considered as gVNFM by different OPNFV +projects. OPEN-O as NFVO part of MANO will interact with OpenStack and +Juju. The key items required for the integration can be described as +follows. + +Scenario Components and Composition +----------------------------------- + +This Scenario will deploy Open-O on jump host as orchestrator and deploy +juju in an OpenStack VM as VNFM. All Open-O service can be access through +openo_ip specified in network config file. + +Scenario Usage Overview +----------------------- + +This scenario has an orchestrator field to specify which orchestrator to +be used. + +COMPASS installer configuration +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The os-nosdn-openo-ha scenario in Compass4NFV has an orchestrator field. +Set orchestrator type to Open-O to install Open-O after Compass4NFV finishs +NFVI deployment and Open-O version can also be assigned in key version. +With orchestrator setting to Open-O, Compass4NFV will git clone Opera +project to perform a combined deployment. Set key vnf to clearwater if you +want to launch clearwater after Open-O launched. + +os-nosdn-openo-ha scenario needs to be deployed along with Open-O included +network config file. Compass4NFV has network_openo.yml to config network for +Opera. + +The Open-O related info in both scenario and network config will be synchronized +into Opera after its repository being cloned. + +References +---------- + +For more information on the OPNFV Danube release, please visit +http://www.opnfv.org/danube -- cgit 1.2.3-korg