Changing to new docs structure

Change-Id: I4c15e1635981b2b5fe5473be89b5abab78bfabd5
Signed-off-by: Nikolas Hermanns <nikolas.hermanns@ericsson.com>

2 files changed, 176 insertions, 0 deletions

diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst
new file mode 100644
index 0000000..4f7261d
--- /dev/null
+++ b/docs/release/release-notes/index.rst
@@ -0,0 +1,14 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Nikolas Hermanns, (nikolas.hermanns@ericsson.com) and others
+
+==================
+SDN VPN release notes
+==================
+
+.. toctree::
+   :maxdepth: 3
+
+   ./release-notes.rst
+
+
diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst
new file mode 100644
index 0000000..fe0fbbe
--- /dev/null
+++ b/docs/release/release-notes/release-notes.rst
@@ -0,0 +1,162 @@
+==========================================================================
+OPNFV Release Note for the Danube.1.0 release of OPNFV for SDN VPN feature
+==========================================================================
+
+License
+=======
+
+This work is licensed under a Creative Commons Attribution 4.0 International
+License. .. http://creativecommons.org/licenses/by/4.0 ..
+(c) Tim Irnich (Ericsson) and others
+
+Abstract
+========
+
+This document comprises the release notes for the SDN VPN feature contained in the Danube
+release of OPNFV.
+
+Important notes
+===============
+
+In the Danube release, SDN VPN only supports ODL as a backend. Make sure to always deploy
+SDN VPN and ODL together. Make use of deployment scenarios including the SDNVPN feature.
+
+Summary
+=======
+
+SDN VPN adds the possibility to create and associate BGP/MPLS based Virtual Private Networks (VPNs)
+through the OpenStack Neutron BGPVPN API extension.
+
+Release Data
+============
+
++--------------------------------------+-------------------------------------------+
+| **Project**                          | sdnvpn                                    |
+|                                      |                                           |
++--------------------------------------+-------------------------------------------+
+| **Repo/tag**                         | Danube.1.0                                |
+|                                      |                                           |
++--------------------------------------+-------------------------------------------+
+| **Release designation**              | Danube 1.0 follow-up release              |
+|                                      |                                           |
++--------------------------------------+-------------------------------------------+
+| **Release date**                     | March 23 2016                             |
+|                                      |                                           |
++--------------------------------------+-------------------------------------------+
+| **Purpose of the delivery**          | Including BGP stack - 6WIND Zrpcd/Quagga  |
+|                                      | Fuel 10.0 baseline + bug fixes            |
+|                                      | Deployment with Apex                      |
+|                                      | Integration with Boron SR2.0 and bugfixes |
+|                                      | 4 new e2e testcases for Functest          |
+|                                      | Horizon integration for networking-bgpvpn |
+|                                      |                                           |
++--------------------------------------+-------------------------------------------+
+
+Version change
+--------------
+
+Compared to the Colorado release, a new version of ODL including
+several critical bugfixes is deployed. Together with the new BGP
+stack, integration with Apex, the Horizon dashboards and bugfixes the
+user has even more features available. New testcases were added to
+functest to guarantee functionality.
+
+Module version changes
+~~~~~~~~~~~~~~~~~~~~~~
+ODL has been upgraded to Boron SR2.
+
+Document changes
+~~~~~~~~~~~~~~~~
+
+Reason for version
+------------------
+
+Feature additions
+~~~~~~~~~~~~~~~~~
+
+SDN VPN adds the possibility to create and associate BGP/MPLS based
+Virtual Private Networks (VPNs) through the OpenStack Neutron BGPVPN
+API extension.
+
+A new installer based on Apex is provided.
+
+The Horizon dashboard for the OpenStack Neutron BGPVPN API extensions
+is available.
+
+Bug corrections
+~~~~~~~~~~~~~~~
+
+- Several bugs in ODL VPN Service have been fixed in this release.
+
+- Floating IP is now working and tested in functest, relevant Tempest
+  tests have been enabled.
+
+- Performance issues have been rectified and the relevant tests have
+  been enabled again.
+
+- Yardstick testcases have been enabled again.
+
+Deliverables
+------------
+
+Software deliverables
+~~~~~~~~~~~~~~~~~~~~~
+
+- Fuel plugin for OpenStack BGPVPN
+- Changes to ODL Fuel plugin to activate the NetVirt Karaf features
+  and to apply the appropriate configuration. Also changes to
+  implement integration with 6Wind Zrpcd and Quagga.
+- Changes to Apex to enable a BGPVPN deployment.
+- Integration of VPN Service functional tests and BGPVPN API tests into Functest framework.
+- Enabling performance tests in Yardstick.
+- Changes to 6Wind Zrpcd to enable integration with Apex.
+
+Documentation deliverables
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- Paragraph on SDN VPN feature for platform overview
+
+- Configuration guide
+
+- User guide
+
+- Release notes (this document)
+
+Known Limitations, Issues and Workarounds
+=========================================
+
+System Limitations
+------------------
+
+Known issues
+------------
+
+Moving to the new NetVirt has caused a regression in which a subnet
+cannot be both attached to a Router and Network associated to a VPN.
+This has been worked around in the tests and the upstream bug is being
+tracked [0].
+
+OpenStack NAT does not work. Instances created in subnets that are connected to
+the public network via a gateway should have external connectivity. This does
+not work and can be worked around by assigning a Floating IP to the instance [1].
+
+Workarounds
+-----------
+
+The router/network association mutual exclusivity is worked around
+by not network associating subnets attached to routers.
+
+The NAT issues are worked around by assigning floating IPs to VMs that require
+external connectivity.
+
+Test results
+============
+
+The deployment scenarios have successfully deployed in OPNFV CI many
+times and all Functest tests (general and feature specific) are
+passing.
+
+References
+==========
+[0] https://jira.opnfv.org/projects/SDNVPN/issues/SDNVPN-94
+[1] https://jira.opnfv.org/projects/SDNVPN/issues/SDNVPN-99