Merge "doc update: better introduction, more links"

openstack/networking-bgpvpn

Code Issues Proposed changes

Browse Source

This commit is contained in:

Zuul

2018年03月15日 14:55:18 +00:00

committed by Gerrit Code Review

parent e9a0ea199b 6cef6ef8dc

commit 1cb7fd44ad

4 changed files with 43 additions and 39 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download Patch File Download Diff File Expand all files Collapse all files

17
README.rst

View File

@@ -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

24
doc/source/index.rst

View File

@@ -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

========

19
doc/source/introduction.rst Normal file

View File

@@ -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]_.

22
doc/source/user/overview.rst

View File

@@ -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

--------------------------------------