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