From d1e5c1d5aca380dcd628a904604d4bee40b605d0 Mon Sep 17 00:00:00 2001 From: ChristopherPrice Date: Wed, 24 Feb 2016 12:43:52 +0100 Subject: Adding SDNVPN release documentation. Change-Id: Iff53422b5e609a21e7165946d776e66fdfdbe431 Signed-off-by: ChristopherPrice --- docs/configguide/featureconfig.rst | 19 ++++++++++++++++--- docs/index.rst | 18 ++++++++++++++++++ docs/platformoverview/platformoverview.rst | 12 ++++++++++-- docs/userguide/userguide.rst | 22 +++++++++++++++++----- 4 files changed, 61 insertions(+), 10 deletions(-) create mode 100755 docs/index.rst (limited to 'docs') diff --git a/docs/configguide/featureconfig.rst b/docs/configguide/featureconfig.rst index 98620db..ad41c22 100644 --- a/docs/configguide/featureconfig.rst +++ b/docs/configguide/featureconfig.rst @@ -1,6 +1,19 @@ -SDNVPN Configuration -==================== +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Tim Irnich (tim.irnich@ericsson.com) -Stuff about configuring SDNVPN features... +Configuring SDNVPN features +--------------------------- +Fuel installer configuration + + +Feature configuration +No post-deploy configuration is necessary. The Fuel BGPVPN plugin and the ODL +plugin should set up the cluster in a way that it is ready for BGPVPNs being +created. This includes the set-up of internal VxLAN transport tunnels between +compute nodes. + +No post-configuration activities are required. diff --git a/docs/index.rst b/docs/index.rst new file mode 100755 index 0000000..afd4625 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,18 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2016 OPNFV. + +================================ +SDNVPN Brahmaputra documentation +================================ + +.. toctree:: + :maxdepth: 2 + + ./platformoverview/platformoverview.rst + ./configguide/configguide.rst + ./userguide/userguide.rst + +Indices +======= +* :ref:`search` diff --git a/docs/platformoverview/platformoverview.rst b/docs/platformoverview/platformoverview.rst index 346673e..9a7068f 100644 --- a/docs/platformoverview/platformoverview.rst +++ b/docs/platformoverview/platformoverview.rst @@ -1,5 +1,13 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Tim Irnich (tim.irnich@ericsson.com) + SDNVPN platform components and features --------------------------------------- -Stuff about SDNVPN project platfrom components... - +The SDN VPN feature enhances OPNFV's baseline OpenStack deployment with the +possibility to configure BGP based VPNs according to the OpenStack Neutron +Stadium project BGPVPN. The BGPVPN project consists of an API specification, +framework implementation and a number of backend drivers (Bagpipe, OpenContrail, +Nuage and OpenDaylight currently). In OPNFV Brahmaputra only the ODL backend +is supported. diff --git a/docs/userguide/userguide.rst b/docs/userguide/userguide.rst index 7f3e4f9..f59fca3 100644 --- a/docs/userguide/userguide.rst +++ b/docs/userguide/userguide.rst @@ -1,7 +1,19 @@ - capabilities and usage +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Tim Irnich, (tim.irnich@ericsson.com) + +SDN VPN capabilities and usage ================================ -Describe the specific capabilities and usage for feature. - ------------------------------------------------ -Describe with examples how to use specfic features. +The BGPVPN feature enables creation of BGP VPNs according to the OpenStack +BGPVPN blueprint . In a nutshell, the blueprint defines a BGPVPN object +and a number of ways how to associate it with the existing Neutron object model, +including a unique definition of the related semantics. The BGPVPN framework +supports a backend driver model with currently available drivers for Bagpipe, +OpenContrail, Nuage and OpenDaylight. For the details of using the OpenStack +BGP VPN API, please refer to the documentation at . + +Currently, in OPNFV only ODL is supported as a backend for BGPVPN. The BGPVPN +API calls are mapped onto the ODL VPN Service REST API through the BGPVPN ODL +driver and the ODL Neutron Northbound module. + -- cgit 1.2.3-korg