docs/release-notes.rst

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