docs/release/release-notes/release-notes.rst

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