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 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 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 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 RC1 as"
  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
  72 Release Data
  73 ============
  74
  75 +--------------------------------------+--------------------------------------+
  76 | **Project**                          | fuel                                 |
  77 |                                      |                                      |
  78 +--------------------------------------+--------------------------------------+
  79 | **Repo/tag**                         | brahmaputra.1.0                      |
  80 |                                      |                                      |
  81 +--------------------------------------+--------------------------------------+
  82 | **Release designation**              | Brahmaputra base release             |
  83 |                                      |                                      |
  84 +--------------------------------------+--------------------------------------+
  85 | **Release date**                     | February 25 2016                     |
  86 |                                      |                                      |
  87 +--------------------------------------+--------------------------------------+
  88 | **Purpose of the delivery**          | Brahmaputra base release             |
  89 |                                      |                                      |
  90 +--------------------------------------+--------------------------------------+
  91
  92 Version change
  93 --------------
  94
  95 Module version changes
  96 ~~~~~~~~~~~~~~~~~~~~~~
  97 This is the second tracked release of genesis/fuel. It is based on
  98 following upstream versions:
  99
 100 - Fuel 8.0 pre-release
 101
 102 - OpenStack Liberty release
 103
 104 - OpenDaylight Beryllium pre-release <TODO>
 105
 106 - ONOS Drake release
 107
 108 Document changes
 109 ~~~~~~~~~~~~~~~~
 110 This is the third tracked version of the fuel installer for OPNFV. It
 111 comes with the following documentation:
 112
 113 - Installation instructions - *Reference 13* - **Changed**
 114
 115 - Build instructions - *Reference 14* - **Changed**
 116
 117 - Release notes - *Reference 15* - **Changed** (This document)
 118
 119 Reason for version
 120 ------------------
 121
 122 Feature additions
 123 ~~~~~~~~~~~~~~~~~
 124
 125 **JIRA TICKETS:**
 126
 127 `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>`_
 128
 129 Bug corrections
 130 ~~~~~~~~~~~~~~~
 131
 132 **JIRA TICKETS:**
 133
 134 `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>`_
 135
 136 Deliverables
 137 ------------
 138
 139 Software deliverables
 140 ~~~~~~~~~~~~~~~~~~~~~
 141
 142 Fuel-based installer iso file found in *Reference 2*
 143
 144 Documentation deliverables
 145 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 146
 147 - Installation instructions - *Reference 13*
 148
 149 - Build instructions - *Reference 14*
 150
 151 - Release notes - *Reference 15* (This document)
 152
 153 Known Limitations, Issues and Workarounds
 154 =========================================
 155
 156 System Limitations
 157 ------------------
 158
 159 - **Max number of blades:** 1 Fuel master, 3 Controllers, 20 Compute blades
 160
 161 - **Min number of blades:** 1 Fuel master, 1 Controller, 1 Compute blade
 162
 163 - **Storage:** Ceph is the only supported storage configuration.
 164
 165 - **Max number of networks:** 65k
 166
 167
 168 Known issues
 169 ------------
 170
 171 **JIRA TICKETS:**
 172
 173 `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>`_
 174
 175 Workarounds
 176 -----------
 177
 178 -
 179
 180 Test results
 181 ============
 182 The Brahmaputra release with the Fuel deployment tool has undergone QA test
 183 runs with the following results:
 184 <TODO>
 185
 186 References
 187 ==========
 188 For more information on the OPNFV Brahmaputra release, please see
 189
 190 OPNFV
 191 -----
 192
 193 1) `OPNFV Home Page <www.opnfv.org>`_
 194
 195 2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_
 196
 197 OpenStack
 198 ---------
 199
 200 3) `OpenStack Liberty Release artifacts <http://www.openstack.org/software/liberty>`_
 201
 202 4) `OpenStack documentation <http://docs.openstack.org>`_
 203
 204 OpenDaylight
 205 ------------
 206
 207 5) `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_
 208
 209 Fuel
 210 ----
 211
 212 6) `The Fuel OpenStack project <https://wiki.openstack.org/wiki/Fuel>`_
 213
 214 7) `Fuel documentation overview <https://docs.fuel-infra.org/openstack/fuel/fuel-7.0/#guides>`_
 215
 216 8) `Fuel planning guide <https://docs.mirantis.com/openstack/fuel/fuel-7.0/planning-guide.html>`_
 217
 218 9) `Fuel user guide <http://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html>`_
 219
 220 10) `Fuel operations guide <http://docs.mirantis.com/openstack/fuel/fuel-7.0/operations.html>`_
 221
 222 11) `Fuel Plugin Developers Guide <https://wiki.openstack.org/wiki/Fuel/Plugins>`_
 223
 224 12) `Fuel OpenStack Hardware Compatibility List <https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list>`_
 225
 226 Fuel in OPNFV
 227 -------------
 228
 229 13) OPNFV Installation instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool
 230
 231 14) OPNFV Build instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool
 232
 233 15) OPNFV Release Note for the Brahmaputra release of OPNFV when using Fuel as a deployment tool