From 0eccc38cee2881d311381d81635dd00fb3870117 Mon Sep 17 00:00:00 2001 From: timirnich Date: Thu, 25 Feb 2016 02:08:07 -0800 Subject: Changing filenames to match convention and update index.rst. Some additional content for feature config guide. Fixing a typo in userguide. Change-Id: I1f3056535052e74ec893b9f3264a154a145c2350 --- docs/configguide/featureconfig.rst | 11 ++++++++--- docs/index.rst | 4 ++-- docs/userguide/featureusage.rst | 23 +++++++++++++++++++++++ docs/userguide/userguide.rst | 23 ----------------------- 4 files changed, 33 insertions(+), 28 deletions(-) create mode 100644 docs/userguide/featureusage.rst delete mode 100644 docs/userguide/userguide.rst (limited to 'docs') diff --git a/docs/configguide/featureconfig.rst b/docs/configguide/featureconfig.rst index ad41c22..b5c5f7b 100644 --- a/docs/configguide/featureconfig.rst +++ b/docs/configguide/featureconfig.rst @@ -6,10 +6,15 @@ Configuring SDNVPN features --------------------------- Fuel installer configuration - -Feature configuration +In order to install the BGPVPN feature, the corresponding checkbox in Fuel has to be +selected. This will trigger installation of the OpenStack BGPVPN API extension for +Neutron (set up for using the ODL driver). + +In addition, ODL has to be installed, see the corresponding section on how to +install ODL. If the BGPVPN feature is installed, ODL will automatically be installed +with VPN Service karaf feature activated. + 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 diff --git a/docs/index.rst b/docs/index.rst index afd4625..63817ce 100755 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,8 +10,8 @@ SDNVPN Brahmaputra documentation :maxdepth: 2 ./platformoverview/platformoverview.rst - ./configguide/configguide.rst - ./userguide/userguide.rst + ./configguide/featureconfig.rst + ./userguide/featureusage.rst Indices ======= diff --git a/docs/userguide/featureusage.rst b/docs/userguide/featureusage.rst new file mode 100644 index 0000000..672a009 --- /dev/null +++ b/docs/userguide/featureusage.rst @@ -0,0 +1,23 @@ +.. 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 +================================ +The BGPVPN feature enables creation of BGP VPNs according to the OpenStack +BGPVPN blueprint at https://blueprints.launchpad.net/neutron/+spec/neutron-bgp-vpn. +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. + +Currently, in OPNFV only ODL is supported as a backend for BGPVPN. API calls are +mapped onto the ODL VPN Service REST API through the BGPVPN ODL driver and the +ODL Neutron Northbound module. + +Feature and API usage guidelines and example +----------------------------------------------- + +For the details of using OpenStack BGPVPN API, please refer to the documentation +at http://docs.openstack.org/developer/networking-bgpvpn/. diff --git a/docs/userguide/userguide.rst b/docs/userguide/userguide.rst deleted file mode 100644 index 8d09397..0000000 --- a/docs/userguide/userguide.rst +++ /dev/null @@ -1,23 +0,0 @@ -.. 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 -================================ -The BGPVPN feature enables creation of BGP VPNs according to the OpenStack -BGPVPN blueprint at https://blueprints.launchpad.net/neutron/+spec/neutron-bgp-vpn. -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. - -Currently, in OPNFV only ODL is supported as a backend for BGPVPN. API calls are -mapped onto the ODL VPN Service REST API through the BGPVPN ODL driver and the -ODL Neutron Northbound module. - - ------------------------------------------------ - -For the details of using OpenStack BGPVPN API, please refer to the documentation -at http://docs.openstack.org/developer/networking-bgpvpn/. -- cgit 1.2.3-korg