diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/scenarios/os-odl_l2-bgpvpn/index.rst | 16 | ||||
| -rw-r--r-- | docs/scenarios/os-odl_l2-bgpvpn/scenario.description.rst | 69 | ||||
| -rw-r--r-- | docs/userguide/feature.userguide.rst | 42 | ||||
| -rw-r--r-- | docs/userguide/index.rst | 23 |
4 files changed, 150 insertions, 0 deletions
diff --git a/docs/scenarios/os-odl_l2-bgpvpn/index.rst b/docs/scenarios/os-odl_l2-bgpvpn/index.rst new file mode 100644 index 0000000..a2e5076 --- /dev/null +++ b/docs/scenarios/os-odl_l2-bgpvpn/index.rst @@ -0,0 +1,16 @@ +.. 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> and others + +========================================= +os-odl_l2-bgpvpn overview and description +========================================= +.. This document will be used to provide a description of the scenario for an end user. +.. You should explain the purpose of the scenario, the types of capabilities provided and +.. the unique components that make up the scenario including how they are used. + +.. toctree:: + :maxdepth: 3 + + ./scenario.description.rst + diff --git a/docs/scenarios/os-odl_l2-bgpvpn/scenario.description.rst b/docs/scenarios/os-odl_l2-bgpvpn/scenario.description.rst new file mode 100644 index 0000000..b7ef93a --- /dev/null +++ b/docs/scenarios/os-odl_l2-bgpvpn/scenario.description.rst @@ -0,0 +1,69 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) <optionally add copywriters name> + +Introduction +============ +.. In this section explain the purpose of the scenario and the types of capabilities provided + +Many telecom network functions are relying on layer-3 infrastructure services, within a VNF +between components, or towards existing external networks. In many cases, these external +networks are implemented in MPLS/BGP technology in existing service provider wide-area-networks (WAN). + +This proven technology provides a good mechanism for inter-operation of a NFV Infrastructure (NFVI) +and wide-area networks (WAN) and is the main feature set provided by the BGP VPN project. + +This document provides an outline of the os-odl_l2-bgpvpn scenarios of OPNFV including +guidelines and references to required installation, software and hardware configuration documents. + + <To be completed, this outlines the basic content and flow> + Description of bgpvpn scenarios + Description of the internal transport tunnel mesh + Install Neutron BGPVPN additions (networking-bgpvpn) + Neutron odl additions (networking-odl) + install and configure Quagga (incl. config on ODL side) + configure OVS to connect to ODL and set up the right bridges (network architecture) + set up iptables to allow connections between OVS and ODL + set up HA proxy so that ODL can be reached + +Scenario components and composition +=================================== +.. In this section describe the unique components that make up the scenario, +.. what each component provides and why it has been included in order +.. to communicate to the user the capabilities available in this scenario. + + <Where applicable and without copying the installation procedure in the install guides> + Describe Neutron BGPVPN additions (networking-bgpvpn) + Neutron odl additions (networking-odl) + Usage and the role of Quagga (incl. config on ODL side) + OVS and ODL specifics around setting up the right bridges (network architecture) + "" iptables to allow connections between OVS and ODL + "" HA proxy so that ODL can be reached + +Scenario usage overview +======================= +.. Provide a brief overview on how to use the scenario and the features available to the +.. user. This should be an "introduction" to the userguide document, and explicitly link to it, +.. where the specifics of the features are covered including examples and API's + + When would I use this scenario, what value does it provide? Refer to the userguide for details + of configuration etc... + +Limitations, Issues and Workarounds +=================================== +.. Explain scenario limitations here, this should be at a design level rather than discussing +.. faults or bugs. If the system design only provide some expected functionality then provide +.. some insight at this point. + +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. + +Are there places these basic procedures will not work. Do we have constraints on the use of +Quagga that may change in the future? + +References +========== + +For more information on the OPNFV Colorado release, please visit +http://www.opnfv.org/colorado diff --git a/docs/userguide/feature.userguide.rst b/docs/userguide/feature.userguide.rst new file mode 100644 index 0000000..a531fe2 --- /dev/null +++ b/docs/userguide/feature.userguide.rst @@ -0,0 +1,42 @@ +.. 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) and others + +Introduction +============ +.. Describe the specific features and how it is realised in the scenario in a brief manner +.. to ensure the user understand the context for the user guide instructions to follow. + +This document will provide an overview of how to work with the SDN VPN features in +OPNFV. For a description of the scenarios and their provided capabilities refer to +the scenario description document: +http://artifacts.opnfv.org/colorado/sdnpvn/scenarios/os-odl_l2-bgpvpn/index.html + +SDN VPN feature description +=========================== +.. Describe the specific usage for <XYZ> feature. +.. Provide enough information that a user will be able to operate the feature on a deployed scenario. + +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. + +Feature and API usage guidelines and example +============================================ +.. Describe with examples how to use specific features, provide API examples and details required to +.. operate the feature on the platform. + +For the details of using OpenStack BGPVPN API, please refer to the documentation +at http://docs.openstack.org/developer/networking-bgpvpn/. + +Can we give a basic example here? Pointing someone off to a generic document in reference to +this specific compilation of components feels a little like only half the job. :) + +Troubleshooting +=============== + +What? I thought this would work! diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst new file mode 100644 index 0000000..0eab38c --- /dev/null +++ b/docs/userguide/index.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) and others + +================== +SDN VPN user guide +================== + +.. The feature user guide should provide an OPNFV user with enough information to +.. use the features provided by the feature project in the supported scenarios. +.. This guide should walk a user through the usage of the features once a scenario +.. has been deployed and is active according to the installation guide provided +.. by the installer project. + +.. toctree:: + :maxdepth: 3 + + ./feature.userguide.rst + +.. The feature.userguide.rst file should contain the text for this document +.. additional documents can be added to this directory and added in the right order +.. to this file as a list below. + |