docs/release-notes.rst

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