docs/releasenotes/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 The following OPNFV plugins are not yet ported for AArch64:
  48
  49 - `ONOS <http://onosproject.org/>`_ version "Drake" - 'http://onosproject.org/'
  50
  51 - `Service function chaining <https://wiki.opnfv.org/service_function_chaining>`_ 'https://wiki.opnfv.org/service_function_chaining'
  52
  53 - `SDN distributed routing and VPN <https://wiki.opnfv.org/sdnvpn>`_ 'https://wiki.opnfv.org/sdnvpn'
  54
  55 - `NFV Hypervisors-KVM <https://wiki.opnfv.org/nfv-kvm>`_ 'https://wiki.opnfv.org/nfv-kvm'
  56
  57 - `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'
  58
  59 As well as OPNFV-unique configurations of the Hardware- and Software stack.
  60
  61 This Colorado 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 Colorado Fuel installer image AArch64 (.iso) built by Jenkins
  75
  76 - Automated deployment of Colorado with running on bare metal or a nested hypervisor environment (KVM)
  77
  78 - Automated validation of the Colorado deployment
  79
  80 ============
  81 Release Data
  82 ============
  83
  84 +--------------------------------------+--------------------------------------+
  85 | **Project**                          | armband                              |
  86 |                                      |                                      |
  87 +--------------------------------------+--------------------------------------+
  88 | **Repo/tag**                         | colorado.3.0                         |
  89 |                                      |                                      |
  90 +--------------------------------------+--------------------------------------+
  91 | **Release designation**              | Colorado 3.0 follow-up release       |
  92 |                                      |                                      |
  93 +--------------------------------------+--------------------------------------+
  94 | **Release date**                     | December 05 2016                     |
  95 |                                      |                                      |
  96 +--------------------------------------+--------------------------------------+
  97 | **Purpose of the delivery**          | Colorado alignment to Released       |
  98 |                                      | Fuel 9.0 baseline + Bug-fixes for    |
  99 |                                      | the following feaures/scenarios:     |
 100 |                                      | - Open vSwitch for NFV               |
 101 |                                      | - OpenDaylight                       |
 102 |                                      | - Tacker                             |
 103 |                                      |                                      |
 104 +--------------------------------------+--------------------------------------+
 105
 106 Version change
 107 ==============
 108
 109 Module version changes
 110 ----------------------
 111 This is the Colorado 3.0 release.
 112 It is based on following upstream versions:
 113
 114 - Fuel 9.0 Base release
 115
 116 - OpenStack Mitaka release
 117
 118 - OpenDaylight Boron release [1]_
 119
 120
 121 Document changes
 122 ----------------
 123 This is the Colorado 3.0 follow-up release.
 124 It 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 -
 141
 142 Bug corrections
 143 ---------------
 144
 145 **JIRA TICKETS:**
 146
 147 `Workarounds <https://jira.opnfv.org/issues/?filter=11404>`_ 'https://jira.opnfv.org/issues/?filter=11404'
 148
 149 (Also See respective Integrated feature project's bug tracking)
 150
 151 Deliverables
 152 ============
 153
 154 Software deliverables
 155 ---------------------
 156
 157 AArch64 Fuel-based installer iso file found in *Reference 2*
 158
 159 Documentation deliverables
 160 --------------------------
 161
 162 - Installation instructions - *Reference 13*
 163
 164 - Build instructions - *Reference 14*
 165
 166 - Release notes - *Reference 15* (This document)
 167
 168 =========================================
 169 Known Limitations, Issues and Workarounds
 170 =========================================
 171
 172 System Limitations
 173 ==================
 174
 175 - **Max number of blades:** 1 Fuel master, 3 Controllers, 20 Compute blades
 176
 177 - **Min number of blades:** 1 Fuel master, 1 Controller, 1 Compute blade
 178
 179 - **Storage:** Ceph is the only supported storage configuration
 180
 181 - **Max number of networks:** 65k
 182
 183 - **Fuel master arch:** x86_64
 184
 185 - **Target node arch:** aarch64
 186
 187 Known issues
 188 ============
 189
 190 **JIRA TICKETS:**
 191
 192 `Known issues <https://jira.opnfv.org/issues/?filter=11405>`_ 'https://jira.opnfv.org/issues/?filter=11405'
 193
 194 (Also See respective Integrated feature project's bug tracking)
 195
 196 Workarounds
 197 ===========
 198
 199 **JIRA TICKETS:**
 200
 201 -
 202
 203 (Also See respective Integrated feature project's bug tracking)
 204
 205 ============
 206 Test results
 207 ============
 208 The Colorado 3.0 release with the Fuel deployment tool has undergone QA test
 209 runs, see separate test results.
 210
 211 ==========
 212 References
 213 ==========
 214 For more information on the OPNFV Colorado 3.0 release, please see:
 215
 216 OPNFV
 217 =====
 218
 219 1) `OPNFV Home Page <http://www.opnfv.org>`_ 'http://www.opnfv.org'
 220
 221 2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_ 'https://www.opnfv.org/software/download'
 222
 223 OpenStack
 224 =========
 225
 226 3) `OpenStack Mitaka Release artifacts <http://www.openstack.org/software/mitaka>`_ 'http://www.openstack.org/software/mitaka'
 227
 228 4) `OpenStack documentation <http://docs.openstack.org>`_ 'http://docs.openstack.org'
 229
 230 OpenDaylight
 231 ============
 232
 233 5) `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_ 'http://www.opendaylight.org/software/downloads'
 234
 235 Fuel
 236 ====
 237
 238 6) `The Fuel OpenStack project <https://wiki.openstack.org/wiki/Fuel>`_: https://wiki.openstack.org/wiki/Fuel
 239
 240 7) `Fuel documentation overview <http://docs.openstack.org/developer/fuel-docs>`_: http://docs.openstack.org/developer/fuel-docs
 241
 242 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
 243
 244 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
 245
 246 10) `Fuel Developer Guide <http://docs.openstack.org/developer/fuel-docs/devdocs/develop.html>`_: http://docs.openstack.org/developer/fuel-docs/devdocs/develop.html
 247
 248 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
 249
 250 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
 251
 252 Fuel in OPNFV
 253 =============
 254
 255 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'
 256
 257 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'
 258
 259 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'
 260
 261 .. [1] OpenDaylight Boron RC2 is used when Service Function Chaining is enabled in Fuel plugin.