diff --git a/README.rst b/README.rst index 9ae1396d..87586d6b 100644 --- a/README.rst +++ b/README.rst @@ -21,12 +21,23 @@ carrier provided WANs using these standard protocols. An additional purpose of this project is to enable the use of these technologies within the Neutron networking environment. -A vendor-neutral API and data model are provided such that multiple backends -may be "plugged in" while offering the same tenant facing API. A reference -implementation based on an Open Source BGP implementation is also provided. +A vendor-neutral API and data model are provided such that multiple SDN +controllers may be used as backends, while offering the same tenant facing API. +A reference implementation working along with Neutron reference drivers is +also provided. * Free software: Apache license * Source: https://git.openstack.org/cgit/openstack/networking-bgpvpn * Bugs: https://bugs.launchpad.net/bgpvpn * Doc: https://docs.openstack.org/networking-bgpvpn/latest/ +=================== +Introduction videos +=================== + +The following videos are filmed presentations of talks given during the +Barcelona OpenStack Summit (Oct' 2016). Although they do not cover the work +done since, they can be a good introduction to the project: + +* https://www.youtube.com/watch?v=kGW5R8mtmRg +* https://www.youtube.com/watch?v=LCDeR7MwTzE diff --git a/doc/source/index.rst b/doc/source/index.rst index 23b0bdbf..11ce900b 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -8,25 +8,17 @@ Neutron BGP VPN Interconnection Documentation ============================================= -Introduction -============ +.. include:: introduction.rst -BGP-based IP VPNs networks are widely used in the industry especially for -enterprises. This project aims at supporting inter-connection between L3VPNs -and Neutron resources, i.e. Networks, Routers and Ports. +Introduction videos +=================== -A typical use-case is the following: a tenant already having a BGP IP VPN -(a set of external sites) setup outside the datacenter, and they want to be able -to trigger the establishment of connectivity between VMs and these VPN sites. +The following videos are filmed presentations of talks given during the +Barcelona OpenStack Summit (Oct' 2016). Although they do not cover the work +done since, they can be a good introduction to the project: -Another similar need is when E-VPN is used to provide an Ethernet interconnect -between multiple sites. - -This service plugin exposes an API to interconnect OpenStack Neutron ports, -typically VMs, via the Networks and Routers they are connected to, with -an L3VPN network as defined by [RFC4364]_ (BGP/MPLS IP Virtual Private Networks). -The framework is generic to also support E-VPN [RFC7432]_, which inherits the -same protocol architecture as BGP/MPLS IP VPNs. +* https://www.youtube.com/watch?v=kGW5R8mtmRg +* https://www.youtube.com/watch?v=LCDeR7MwTzE Contents ======== diff --git a/doc/source/introduction.rst b/doc/source/introduction.rst new file mode 100644 index 00000000..2e18ec62 --- /dev/null +++ b/doc/source/introduction.rst @@ -0,0 +1,19 @@ +Introduction +============ + +BGP-based IP VPNs networks are widely used in the industry especially for +enterprises. This project aims at supporting inter-connection between L3VPNs +and Neutron resources, i.e. Networks, Routers and Ports. + +A typical use-case is the following: a tenant already having a BGP IP VPN +(a set of external sites) setup outside the datacenter, and they want to be able +to trigger the establishment of connectivity between VMs and these VPN sites. + +Another similar need is when E-VPN is used to provide an Ethernet interconnect +between multiple sites, and inherits the base protocol architecture from +BGP/MPLS IP VPNs. + +This service plugin exposes an API to interconnect OpenStack Neutron ports, +typically VMs, via the Networks and Routers they are connected to, with +a IP VPN as defined by [RFC4364]_ (BGP/MPLS IP Virtual Private Networks) or +with an E-VPN [RFC7432]_. diff --git a/doc/source/user/overview.rst b/doc/source/user/overview.rst index f817a28c..2db85f11 100644 --- a/doc/source/user/overview.rst +++ b/doc/source/user/overview.rst @@ -8,32 +8,14 @@ BGP VPN Interconnection Service Overview ========================================== -Introduction ------------- - -BGP-based IP VPNs networks are widely used in the industry especially for -enterprises. This project aims at supporting inter-connection between L3VPNs -and Neutron resources, i.e. Networks, Routers and Ports. - -A typical use-case is the following: a tenant already having a BGP IP VPN (a -set of external sites) setup outside the datacenter, and they want to be able -to trigger the establishment of connectivity between VMs and these VPN sites. - -Another similar need is when E-VPN is used to provide an Ethernet interconnect -between multiple sites. - -This service plugin exposes an API to interconnect OpenStack Neutron ports, -typically VMs, via the Networks and Routers they are connected to, with -an L3VPN network as defined by [RFC4364]_ (BGP/MPLS IP Virtual Private Networks). -The framework is generic to also support E-VPN [RFC7432]_, which inherits the -same protocol architecture as BGP/MPLS IP VPNs. +.. include:: ../introduction.rst Alternatives and related techniques ----------------------------------- Other techniques are available to build VPNs, but the goal of this proposal is to make it possible to create the interconnect we need when the technology -of BGP-based VPNs is already used outside an Openstack cloud. +of BGP-based VPNs is already used outside an OpenStack cloud. Reminder on BGP VPNs and Route Targets --------------------------------------