docs/release-notes/release-notes.rst

   1 ===============================================================================
   2 OPNFV Release Note for the Colorado.1.0 release of OPNFV for SDN VPN feature
   3 ===============================================================================
   4
   5 License
   6 =======
   7
   8 This work is licensed under a Creative Commons Attribution 4.0 International
   9 License. .. http://creativecommons.org/licenses/by/4.0 ..
  10 (c) Tim Irnich (Ericsson) and others
  11
  12 Abstract
  13 ========
  14
  15 This document comprises the release notes for the SDN VPN feature contained in the Colorado
  16 release of OPNFV.
  17
  18 Important notes
  19 ===============
  20
  21 In the Colorado release, SDN VPN only supports ODL as a backend. Make sure to always deploy
  22 SDN VPN and ODL together. Make use of deployment scenarios including the SDNVPN feature.
  23
  24 Summary
  25 =======
  26
  27 SDN VPN adds the possibility to create and associate BGP/MPLS based Virtual Private Networks (VPNs)
  28 through the OpenStack Neutron BGPVPN API extension.
  29
  30 Release Data
  31 ============
  32
  33 +--------------------------------------+--------------------------------------+
  34 | **Project**                          | sdnvpn                               |
  35 |                                      |                                      |
  36 +--------------------------------------+--------------------------------------+
  37 | **Repo/tag**                         | Colorado.1.0                         |
  38 |                                      |                                      |
  39 +--------------------------------------+--------------------------------------+
  40 | **Release designation**              | Colorado 1.0 follow-up release       |
  41 |                                      |                                      |
  42 +--------------------------------------+--------------------------------------+
  43 | **Release date**                     | September 22 2016                    |
  44 |                                      |                                      |
  45 +--------------------------------------+--------------------------------------+
  46 | **Purpose of the delivery**          | Including BGP stack - Quagga         |
  47 |                                      | Fuel 9.0 baseline + Bug-fixes        |
  48 |                                      | HEAT integration                     |
  49 |                                      | 2 new e2e testcases for Functest     |
  50 |                                      | Documentation                        |
  51 |                                      |                                      |
  52 +--------------------------------------+--------------------------------------+
  53
  54 Version change
  55 --------------
  56
  57 Compared to the Brahmaputra release, a new version of ODL including several critical
  58 bugfixes is deployed. Together with the new BGP stack and HEAT integration the user
  59 can use now full stack bgp. New testcases to functest were added to guarantee
  60 functionality.
  61
  62 Module version changes
  63 ~~~~~~~~~~~~~~~~~~~~~~
  64 ODL has been upgraded to Beryllium SR3.
  65
  66 Document changes
  67 ~~~~~~~~~~~~~~~~
  68 The amount documentation is increased substantially. E2E deployment docu and examples to use bgpvpn
  69 is added.
  70
  71 Reason for version
  72 ------------------
  73
  74 Feature additions
  75 ~~~~~~~~~~~~~~~~~
  76
  77 SDN VPN adds the possibility to create and associate BGP/MPLS based Virtual Private Networks (VPNs)
  78 through the OpenStack Neutron BGPVPN API extension.
  79
  80
  81 Bug corrections
  82 ~~~~~~~~~~~~~~~
  83
  84 Several bugs in ODL VPN Service have been fixed in this release.
  85
  86 Deliverables
  87 ------------
  88
  89 Software deliverables
  90 ~~~~~~~~~~~~~~~~~~~~~
  91
  92 - Fuel plugin for OpenStack BGPVPN
  93 - Changes to ODL Fuel plugin to activate VPN Service Karaf feature
  94 - Integration of VPN Service functional tests and BGPVPN API tests into Functest framework
  95
  96 Documentation deliverables
  97 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  98
  99 - Paragraph on SDN VPN feature for platform overview
 100
 101 - Configuration guide
 102
 103 - User guide
 104
 105 - Release noes (this document)
 106
 107 Known Limitations, Issues and Workarounds
 108 =========================================
 109
 110 System Limitations
 111 ------------------
 112
 113 Floating ip will come with the Boron release so yardstick testcases cannot be run
 114 and the user is only able to access the node through tenat network. Boron is targeted
 115 for Colorado 2.0.
 116 Due to lacking support for floating IPs in ODL VPNService (which replaces Netvirt as
 117 Neutron backend in the SDN VPN scenarios), the following test suites have some restrictions
 118 and are not executed:
 119 - Tempest:
 120  tempest.api.compute.servers.test_create_server.ServersTestJSON
 121  tempest.api.compute.servers.test_create_server.ServersTestManualDisk
 122  tempest.api.compute.servers.test_server_actions.ServerActionsTestJSON
 123  tempest.scenario.test_network_basic_ops.TestNetworkBasicOps.test_network_basic_ops
 124  tempest.scenario.test_server_basic_ops.TestServerBasicOps.test_server_basic_ops
 125  tempest.scenario.test_volume_boot_pattern.TestVolumeBootPattern.test_volume_boot_pattern
 126  tempest.scenario.test_volume_boot_pattern.TestVolumeBootPatternV2.test_volume_boot_pattern
 127
 128 Yardstick uses the floating ip mechanism to connect to the instances using SSH.
 129 Therefore, the default test cases have been replaced by the ones running tests on the
 130 bare-metal servers. Feature specific Yardstick test cases have not been implemented,
 131 we plan to add these in Colorado 2.0.
 132
 133 It is known that the performance of management operations is quite low. To work around
 134 the overall timeout of functest, the performance tool Rally was excluded from the
 135 test list. For Colorado 2.0 a much higher performance is expected and Rally it is
 136 expected to be included again.
 137
 138 A timeout in promise occurs. This timeout was set from 5 to 10 seconds for all scenarios
 139 a jira ticket was written to change it back
 140 in Colorado 2.0: https://jira.opnfv.org/browse/PROMISE-79.
 141
 142 Parser testcase was removed from functest due to low performance. In Colorado 2.0
 143 a big performance improvement is forseen and Parser will then be added again.
 144
 145 Known issues
 146 ------------
 147
 148 Workarounds
 149 -----------
 150
 151 Test results
 152 ============
 153
 154 The deployment scenarios have successfully deployed in OPNFV CI many times and all Functest tests
 155 (general and feature specific) are passing.
 156
 157 References
 158 ==========