docs/release-notes.rst

   1 ============================================================================================
   2 OPNFV Release Note for the Brahmaputra release of OPNFV when using Fuel as a deployment tool
   3 ============================================================================================
   4
   5 .. contents:: Table of Contents
   6    :backlinks: none
   7
   8 Abstract
   9 ========
  10
  11 This document compiles the release notes for the Brahmaputra release of
  12 OPNFV when using Fuel as a deployment tool.
  13
  14 License
  15 =======
  16
  17 Brahmaputra release with the Fuel deployment tool Docs (c) by Jonas
  18 Bjurel (Ericsson AB)
  19
  20 This document is licensed under a Creative Commons Attribution 4.0
  21 International License.
  22
  23 You should have received a copy of the license along with this document.
  24 If not, see <http://creativecommons.org/licenses/by/4.0/>.
  25
  26 Important notes
  27 ===============
  28
  29 These notes provides release information for the use of Fuel as deployment
  30 tool for the Brahmaputra release of OPNFV.
  31
  32 The goal of the Brahmaputra release and this Fuel-based deployment process is
  33 to establish a lab ready platform accelerating further development
  34 of the OPNFV infrastructure.
  35
  36 Carefully follow the installation-instructions.
  37
  38 Summary
  39 =======
  40
  41 For Brahmaputra, the typical use of Fuel as an OpenStack installer is
  42 supplemented with OPNFV unique components such as:
  43
  44 - `OpenDaylight <http://www.opendaylight.org/software>`_ version "Berylium RC1 as"
  45
  46 - `ONOS <http://onosproject.org/>`_ version "Drake"
  47
  48 - `Service function chaining <https://wiki.opnfv.org/service_function_chaining>`_
  49
  50 - `SDN distributed routing and VPN <https://wiki.opnfv.org/sdnvpn>`_
  51
  52 - `NFV Hypervisors-KVM <https://wiki.opnfv.org/nfv-kvm>`_
  53
  54 - `Open vSwitch for NFV <https://wiki.opnfv.org/ovsnfv>`_
  55
  56 - `VSPERF <https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases>`_
  57
  58 As well as OPNFV-unique configurations of the Hardware- and Software stack.
  59
  60 This Brahmaputra artifact provides Fuel as the deployment stage tool in the
  61 OPNFV CI pipeline including:
  62
  63 - Documentation built by Jenkins
  64
  65   - overall OPNFV documentation
  66
  67   - this document (release notes)
  68
  69   - installation instructions
  70
  71   - build-instructions
  72
  73 - The Brahmaputra Fuel installer image (.iso) built by Jenkins
  74
  75 - Automated deployment of Brahmaputra with running on bare metal or a nested hypervisor environment (KVM)
  76
  77 - Automated validation of the Brahmaputra deployment
  78
  79
  80 Release Data
  81 ============
  82
  83 +--------------------------------------+--------------------------------------+
  84 | **Project**                          | fuel                                 |
  85 |                                      |                                      |
  86 +--------------------------------------+--------------------------------------+
  87 | **Repo/tag**                         | fuel/<TODO>                          |
  88 |                                      |                                      |
  89 +--------------------------------------+--------------------------------------+
  90 | **Release designation**              | Brahmaputra base release             |
  91 |                                      |                                      |
  92 +--------------------------------------+--------------------------------------+
  93 | **Release date**                     | <TODO>                               |
  94 |                                      |                                      |
  95 +--------------------------------------+--------------------------------------+
  96 | **Purpose of the delivery**          | Brahmaputra base release             |
  97 |                                      |                                      |
  98 +--------------------------------------+--------------------------------------+
  99
 100 Version change
 101 --------------
 102
 103 Module version changes
 104 ~~~~~~~~~~~~~~~~~~~~~~
 105 This is the second tracked release of genesis/fuel. It is based on
 106 following upstream versions:
 107
 108 - Fuel 8.0 pre-release
 109
 110 - OpenStack Liberty release
 111
 112 - OpenDaylight Beryllium pre-release
 113
 114 - ONOS Drake release
 115
 116 Document changes
 117 ~~~~~~~~~~~~~~~~
 118 This is the third tracked version of the fuel installer for OPNFV. It
 119 comes with the following documentation:
 120
 121 - OPNFV Installation instructions for Brahmaputra with Fuel as deployment tool - **Changed**
 122
 123 - OPNFV Release Notes for Brahmaputra use of Fuel as deployment tool - **Changed**
 124
 125 - OPNFV Build instructions for Brahmaputra with Fuel as deployment tool - **Changed**
 126
 127 Reason for version
 128 ------------------
 129 Feature additions
 130 ~~~~~~~~~~~~~~~~~
 131
 132 **JIRA TICKETS:**
 133
 134 `New features <https://jira.opnfv.org/browse/FUEL-81?jql=project%20%3D%20FUEL%20AND%20issuetype%20in%20%28Improvement%2C%20%22New%20Feature%22%2C%20Story%2C%20Sub-task%29%20AND%20status%20in%20%28Resolved%2C%20Closed%29%20AND%20resolution%20%3D%20Fixed%20AND%20labels%20in%20%28Fuel-B-WP1%2C%20R2%2C%20brahmaputra%29>`_
 135
 136 Bug corrections
 137 ~~~~~~~~~~~~~~~
 138
 139 **JIRA TICKETS:**
 140
 141 `Bug-fixes <https://jira.opnfv.org/browse/FUEL-96?jql=project%20%3D%20FUEL%20AND%20issuetype%20%3D%20Bug%20AND%20status%20in%20%28Resolved%2C%20Closed%29%20AND%20resolution%20%3D%20Fixed%20AND%20labels%20in%20%28Fuel-B-WP1%2C%20R2%2C%20brahmaputra%29>`_
 142
 143 Deliverables
 144 ------------
 145
 146 Software deliverables
 147 ~~~~~~~~~~~~~~~~~~~~~
 148
 149 Fuel-based installer iso file <TODO>
 150
 151 Documentation deliverables
 152 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 153
 154 - OPNFV Installation instructions for Brahmaputra release with the Fuel deployment tool
 155
 156 - OPNFV Build instructions for Brahmaputra release with the Fuel deployment
 157   tool
 158
 159 - OPNFV Release Note for Brahmaputra release with the Fuel deployment tool - (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/browse/FUEL-99?jql=project%20%3D%20FUEL%20AND%20issuetype%20%3D%20Bug%20AND%20status%20in%20%28Open%2C%20%22In%20Progress%22%2C%20Reopened%29>`_
 182
 183 Workarounds
 184 -----------
 185
 186 -
 187
 188 Test results
 189 ============
 190 The Brahmaputra release with the Fuel deployment tool has undergone QA test
 191 runs with the following results:
 192 <TODO>
 193
 194 References
 195 ==========
 196 For more information on the OPNFV Brahmaputra release, please see
 197 <TODO>