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 1.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 1.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 "Beryllium SR3" [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.1.0                         |
  89 |                                      |                                      |
  90 +--------------------------------------+--------------------------------------+
  91 | **Release designation**              | Colorado 1.0 main release            |
  92 |                                      |                                      |
  93 +--------------------------------------+--------------------------------------+
  94 | **Release date**                     | September 22 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 |                                      |                                      |
 103 +--------------------------------------+--------------------------------------+
 104
 105 Version change
 106 ==============
 107
 108 Module version changes
 109 ----------------------
 110 This is a main release. It is based on
 111 following upstream versions:
 112
 113 - Fuel 9.0 Base release
 114
 115 - OpenStack Mitaka release
 116
 117 - OpenDaylight Beryllium SR3 release [1]_
 118
 119
 120 Document changes
 121 ----------------
 122 This is a main release.
 123 It comes with the following documentation:
 124
 125 - Installation instructions - *Reference 13* - **Changed**
 126
 127 - Build instructions - *Reference 14* - **Changed**
 128
 129 - Release notes - *Reference 15* - **Changed** (This document)
 130
 131 Reason for version
 132 ==================
 133
 134 Feature additions
 135 -----------------
 136
 137 **JIRA TICKETS:**
 138
 139 -
 140
 141 Bug corrections
 142 ---------------
 143
 144 **JIRA TICKETS:**
 145
 146 `Workarounds <https://jira.opnfv.org/issues/?filter=11175>`_ 'https://jira.opnfv.org/issues/?filter=11175'
 147
 148 (Also See respective Integrated feature project's bug tracking)
 149
 150 Deliverables
 151 ============
 152
 153 Software deliverables
 154 ---------------------
 155
 156 AArch64 Fuel-based installer iso file found in *Reference 2*
 157
 158 Documentation deliverables
 159 --------------------------
 160
 161 - Installation instructions - *Reference 13*
 162
 163 - Build instructions - *Reference 14*
 164
 165 - Release notes - *Reference 15* (This document)
 166
 167 =========================================
 168 Known Limitations, Issues and Workarounds
 169 =========================================
 170
 171 System Limitations
 172 ==================
 173
 174 - **Max number of blades:** 1 Fuel master, 3 Controllers, 20 Compute blades
 175
 176 - **Min number of blades:** 1 Fuel master, 1 Controller, 1 Compute blade
 177
 178 - **Storage:** Ceph is the only supported storage configuration
 179
 180 - **Max number of networks:** 65k
 181
 182 - **Fuel master arch:** x86_64
 183
 184 - **Target node arch:** aarch64
 185
 186 Known issues
 187 ============
 188
 189 **JIRA TICKETS:**
 190
 191 `Known issues <https://jira.opnfv.org/issues/?filter=11176>`_ 'https://jira.opnfv.org/issues/?filter=11176'
 192
 193 (Also See respective Integrated feature project's bug tracking)
 194
 195 Workarounds
 196 ===========
 197
 198 **JIRA TICKETS:**
 199
 200 -
 201
 202 (Also See respective Integrated feature project's bug tracking)
 203
 204 ============
 205 Test results
 206 ============
 207 The Colorado 1.0 release with the Fuel deployment tool has undergone QA test
 208 runs, see separate test results.
 209
 210 ==========
 211 References
 212 ==========
 213 For more information on the OPNFV Colorado release, please see:
 214
 215 OPNFV
 216 =====
 217
 218 1) `OPNFV Home Page <http://www.opnfv.org>`_ 'http://www.opnfv.org'
 219
 220 2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_ 'https://www.opnfv.org/software/download'
 221
 222 OpenStack
 223 =========
 224
 225 3) `OpenStack Mitaka Release artifacts <http://www.openstack.org/software/mitaka>`_ 'http://www.openstack.org/software/mitaka'
 226
 227 4) `OpenStack documentation <http://docs.openstack.org>`_ 'http://docs.openstack.org'
 228
 229 OpenDaylight
 230 ============
 231
 232 5) `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_ 'http://www.opendaylight.org/software/downloads'
 233
 234 Fuel
 235 ====
 236
 237 6) `The Fuel OpenStack project <https://wiki.openstack.org/wiki/Fuel>`_ 'https://wiki.openstack.org/wiki/Fuel'
 238
 239 7) `Fuel documentation overview <https://docs.fuel-infra.org/openstack/fuel/fuel-9.0/>`_ 'https://docs.fuel-infra.org/openstack/fuel/fuel-9.0/'
 240
 241 8) `Fuel planning guide <https://docs.fuel-infra.org/openstack/fuel/fuel-9.0/mos-planning-guide.html>`_ 'https://docs.fuel-infra.org/openstack/fuel/fuel-9.0/mos-planning-guide.html'
 242
 243 9) `Fuel quick start guide <https://docs.mirantis.com/openstack/fuel/fuel-9.0/quickstart-guide.html>`_ 'https://docs.mirantis.com/openstack/fuel/fuel-9.0/quickstart-guide.html'
 244
 245 10) `Fuel reference architecture <https://docs.mirantis.com/openstack/fuel/fuel-9.0/reference-architecture.html>`_ 'https://docs.mirantis.com/openstack/fuel/fuel-9.0/reference-architecture.html'
 246
 247 11) `Fuel Plugin Developers Guide <https://wiki.openstack.org/wiki/Fuel/Plugins>`_ 'https://wiki.openstack.org/wiki/Fuel/Plugins'
 248
 249 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'
 250
 251 Fuel in OPNFV
 252 =============
 253
 254 13) `OPNFV Installation instruction for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/colorado/docs/installationprocedure/index.html>`_ 'http://artifacts.opnfv.org/armband/colorado/docs/installationprocedure/index.html'
 255
 256 14) `OPNFV Build instruction for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/colorado/docs/buildprocedure/index.html>`_ 'http://artifacts.opnfv.org/armband/colorado/docs/buildprocedure/index.html'
 257
 258 15) `OPNFV Release Note for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/colorado/docs/releasenotes/index.html>`_ 'http://artifacts.opnfv.org/armband/colorado/docs/releasenotes/index.html'
 259
 260 .. [1] OpenDaylight Boron RC2 is used when Service Function Chaining is enabled in Fuel plugin.