docs/releasenotes/release-notes.rst

   1 .. This document is protected/licensed under the following conditions
   2 .. (c) Jonas Bjurel (Ericsson AB)
   3 .. Licensed under a Creative Commons Attribution 4.0 International License.
   4 .. You should have received a copy of the license along with this work.
   5 .. If not, see <http://creativecommons.org/licenses/by/4.0/>.
   6
   7 ========
   8 Abstract
   9 ========
  10
  11 This document compiles the release notes for the Colorado 3.0 release of
  12 OPNFV when using Fuel as a deployment tool.
  13
  14 ===============
  15 Important notes
  16 ===============
  17
  18 These notes provides release information for the use of Fuel as deployment
  19 tool for the Colorado 3.0 release of OPNFV.
  20
  21 The goal of the Colorado release and this Fuel-based deployment process is
  22 to establish a lab ready platform accelerating further development
  23 of the OPNFV infrastructure.
  24
  25 Carefully follow the installation-instructions provided in *Reference 13*.
  26
  27 =======
  28 Summary
  29 =======
  30
  31 For Colorado, the typical use of Fuel as an OpenStack installer is
  32 supplemented with OPNFV unique components such as:
  33
  34 - `OpenDaylight <http://www.opendaylight.org/software>`_ version "Boron" [1]_ 'http://www.opendaylight.org/software'
  35
  36 - `ONOS <http://onosproject.org/>`_ version "Drake" 'http://onosproject.org/'
  37
  38 - `Service function chaining <https://wiki.opnfv.org/service_function_chaining>`_ 'https://wiki.opnfv.org/service_function_chaining'
  39
  40 - `SDN distributed routing and VPN <https://wiki.opnfv.org/sdnvpn>`_ 'https://wiki.opnfv.org/sdnvpn'
  41
  42 - `NFV Hypervisors-KVM <https://wiki.opnfv.org/nfv-kvm>`_ 'https://wiki.opnfv.org/nfv-kvm'
  43
  44 - `Open vSwitch for NFV <https://wiki.opnfv.org/ovsnfv>`_ 'https://wiki.opnfv.org/ovsnfv'
  45
  46 - `VSPERF <https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases>`_ 'https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases'
  47
  48 - `Promise <https://wiki.opnfv.org/display/promise>`_ 'https://wiki.opnfv.org/display/promise'
  49
  50 - `Parser <https://wiki.opnfv.org/display/parser>`_ 'https://wiki.opnfv.org/display/parser'
  51
  52 - `Doctor <https://wiki.opnfv.org/display/doctor>`_ 'https://wiki.opnfv.org/display/doctor'
  53
  54 As well as OPNFV-unique configurations of the Hardware- and Software stack.
  55
  56 This Colorado artifact provides Fuel as the deployment stage tool in the
  57 OPNFV CI pipeline including:
  58
  59 - Documentation built by Jenkins
  60
  61   - overall OPNFV documentation
  62
  63   - this document (release notes)
  64
  65   - installation instructions
  66
  67   - build-instructions
  68
  69 - The Colorado Fuel installer image (.iso) built by Jenkins
  70
  71 - Automated deployment of Colorado with running on bare metal or a nested hypervisor environment (KVM)
  72
  73 - Automated validation of the Colorado deployment
  74
  75 ============
  76 Release Data
  77 ============
  78
  79 +--------------------------------------+--------------------------------------+
  80 | **Project**                          | fuel                                 |
  81 |                                      |                                      |
  82 +--------------------------------------+--------------------------------------+
  83 | **Repo/tag**                         | colorado.3.0                         |
  84 |                                      |                                      |
  85 +--------------------------------------+--------------------------------------+
  86 | **Release designation**              | Colorado 3.0 follow-up release       |
  87 |                                      |                                      |
  88 +--------------------------------------+--------------------------------------+
  89 | **Release date**                     | December 05 2016                     |
  90 |                                      |                                      |
  91 +--------------------------------------+--------------------------------------+
  92 | **Purpose of the delivery**          | Colorado alignment to Released       |
  93 |                                      | Fuel 9.0 baseline + features and     |
  94 |                                      | bug-fixes for the following          |
  95 |                                      | feaures:                             |
  96 |                                      | - NFV Hypervisors-KVM                |
  97 |                                      | - Open vSwitch for NFV               |
  98 |                                      | - OpenDaylight                       |
  99 |                                      | - ONOS                               |
 100 |                                      | - SDN distributed routing and VPN    |
 101 |                                      | - Service function chaining          |
 102 |                                      | - Promise                            |
 103 |                                      | - Parser                             |
 104 |                                      | - Doctor                             |
 105 |                                      | - Tacker                             |
 106 +--------------------------------------+--------------------------------------+
 107
 108 Version change
 109 ==============
 110
 111 Module version changes
 112 ----------------------
 113 This is the Colorado 3.0 follow-up release.
 114 It is based on following upstream versions:
 115
 116 - Fuel 9.0 Base release
 117
 118 - OpenStack Mitaka release
 119
 120 - OpenDaylight Boron release [1]_
 121
 122 - ONOS Drake release
 123
 124 Document changes
 125 ----------------
 126 This is the Colorado 3.0 follow-up release.
 127 It comes with the following documentation:
 128
 129 - Installation instructions - *Reference 13* - **Changed**
 130
 131 - Build instructions - *Reference 14* - **Changed**
 132
 133 - Release notes - *Reference 15* - **Changed** (This document)
 134
 135 Reason for version
 136 ==================
 137
 138 Feature additions
 139 -----------------
 140
 141 **JIRA TICKETS:**
 142
 143
 144 Bug corrections
 145 ---------------
 146
 147 **JIRA TICKETS:**
 148
 149 `Colorado 3.0 bug fixes  <https://jira.opnfv.org/issues/?filter=11406>`_ 'https://jira.opnfv.org/issues/?filter=11406'
 150
 151 (Also See respective Integrated feature project's bug tracking)
 152
 153 Deliverables
 154 ============
 155
 156 Software deliverables
 157 ---------------------
 158
 159 Fuel-based installer iso file found in *Reference 2*
 160
 161 Documentation deliverables
 162 --------------------------
 163
 164 - Installation instructions - *Reference 13*
 165
 166 - Build instructions - *Reference 14*
 167
 168 - Release notes - *Reference 15* (This document)
 169
 170 =========================================
 171 Known Limitations, Issues and Workarounds
 172 =========================================
 173
 174 System Limitations
 175 ==================
 176
 177 - **Max number of blades:** 1 Fuel master, 3 Controllers, 20 Compute blades
 178
 179 - **Min number of blades:** 1 Fuel master, 1 Controller, 1 Compute blade
 180
 181 - **Storage:** Ceph is the only supported storage configuration
 182
 183 - **Max number of networks:** 65k
 184
 185
 186 Known issues
 187 ============
 188
 189 **JIRA TICKETS:**
 190
 191 `Known issues <https://jira.opnfv.org/issues/?filter=11407>`_ 'https://jira.opnfv.org/issues/?filter=11407'
 192
 193 (Also See respective Integrated feature project's bug tracking)
 194
 195 Workarounds
 196 ===========
 197
 198 **JIRA TICKETS:**
 199
 200 `Workarounds <https://jira.opnfv.org/issues/?filter=11408>`_ 'https://jira.opnfv.org/issues/?filter=11408'
 201
 202 (Also See respective Integrated feature project's bug tracking)
 203
 204 ============
 205 Test results
 206 ============
 207 The Colorado 3.0 release with the Fuel deployment tool has undergone QA test
 208 runs, see separate test results.
 209
 210 ==========
 211 References
 212 ==========
 213 For more information on the OPNFV Colorado 3.0 release, please see:
 214
 215 OPNFV
 216 =====
 217
 218 1) `OPNFV Home Page <http://www.opnfv.org>`_ 'http://www.opnfv.org'
 219
 220 2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_ 'https://www.opnfv.org/software/download'
 221
 222 OpenStack
 223 =========
 224
 225 3) `OpenStack Mitaka Release artifacts <http://www.openstack.org/software/mitaka>`_ 'http://www.openstack.org/software/mitaka'
 226
 227 4) `OpenStack documentation <http://docs.openstack.org>`_ 'http://docs.openstack.org'
 228
 229 OpenDaylight
 230 ============
 231
 232 5) `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_ 'http://www.opendaylight.org/software/downloads'
 233
 234 Fuel
 235 ====
 236
 237 6) `The Fuel OpenStack project <https://wiki.openstack.org/wiki/Fuel>`_: https://wiki.openstack.org/wiki/Fuel
 238
 239 7) `Fuel documentation overview <http://docs.openstack.org/developer/fuel-docs>`_: http://docs.openstack.org/developer/fuel-docs
 240
 241 8) `Fuel Installation Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide.html>`_: http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide.html
 242
 243 9) `Fuel User Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide.html>`_: http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide.html
 244
 245 10) `Fuel Developer Guide <http://docs.openstack.org/developer/fuel-docs/devdocs/develop.html>`_: http://docs.openstack.org/developer/fuel-docs/devdocs/develop.html
 246
 247 11) `Fuel Plugin Developers Guide <http://docs.openstack.org/developer/fuel-docs/plugindocs/fuel-plugin-sdk-guide.html>`_: http://docs.openstack.org/developer/fuel-docs/plugindocs/fuel-plugin-sdk-guide.html
 248
 249 12) `Fuel OpenStack Hardware Compatibility List <https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list>`_: https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list
 250
 251 Fuel in OPNFV
 252 =============
 253
 254 13) `OPNFV Installation instruction for the Colorado 3.0 release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/3.0/docs/installationprocedure/index.html>`_ 'http://artifacts.opnfv.org/fuel/colorado/3.0/docs/installationprocedure/index.html'
 255
 256 14) `OPNFV Build instruction for the Colorado 3.0 release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/3.0/docs/buildprocedure/index.html>`_ 'http://artifacts.opnfv.org/fuel/colorado/3.0/docs/buildprocedure/index.html'
 257
 258 15) `OPNFV Release Note for the Colorado 3.0 release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/3.0/docs/releasenotes/index.html>`_ 'http://artifacts.opnfv.org/fuel/colorado/3.0/docs/releasenotes/index.html'
 259
 260 .. [1] OpenDaylight Beryllium SR3 is used when BGP VPN is enabled in Fuel plugin.