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.
  13
  14 ===============
  15 Important notes
  16 ===============
  17
  18 These notes provides release information for the use of Fuel as deployment
  19 tool for the Colorado 1.0 release of OPNFV.
  20
  21 The goal of the Colorado release and this Fuel-based deployment process is
  22 to establish a lab ready platform accelerating further development
  23 of the OPNFV infrastructure.
  24
  25 Carefully follow the installation-instructions provided in *Reference 13*.
  26
  27 =======
  28 Summary
  29 =======
  30
  31 For Colorado, the typical use of Fuel as an OpenStack installer is
  32 supplemented with OPNFV unique components such as:
  33
  34 - `OpenDaylight <http://www.opendaylight.org/software>`_ version "Beryllium SR3" [1]_ - 'http://www.opendaylight.org/software'
  35
  36 - `ONOS <http://onosproject.org/>`_ version "Drake" - 'http://onosproject.org/'
  37
  38 - `Service function chaining <https://wiki.opnfv.org/service_function_chaining>`_ 'https://wiki.opnfv.org/service_function_chaining'
  39
  40 - `SDN distributed routing and VPN <https://wiki.opnfv.org/sdnvpn>`_ 'https://wiki.opnfv.org/sdnvpn'
  41
  42 - `NFV Hypervisors-KVM <https://wiki.opnfv.org/nfv-kvm>`_ 'https://wiki.opnfv.org/nfv-kvm'
  43
  44 - `Open vSwitch for NFV <https://wiki.opnfv.org/ovsnfv>`_ 'https://wiki.opnfv.org/ovsnfv'
  45
  46 - `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'
  47
  48 As well as OPNFV-unique configurations of the Hardware- and Software stack.
  49
  50 This Colorado artifact provides Fuel as the deployment stage tool in the
  51 OPNFV CI pipeline including:
  52
  53 - Documentation built by Jenkins
  54
  55   - overall OPNFV documentation
  56
  57   - this document (release notes)
  58
  59   - installation instructions
  60
  61   - build-instructions
  62
  63 - The Colorado Fuel installer image (.iso) built by Jenkins
  64
  65 - Automated deployment of Colorado with running on bare metal or a nested hypervisor environment (KVM)
  66
  67 - Automated validation of the Colorado deployment
  68
  69 ============
  70 Release Data
  71 ============
  72
  73 +--------------------------------------+--------------------------------------+
  74 | **Project**                          | fuel                                 |
  75 |                                      |                                      |
  76 +--------------------------------------+--------------------------------------+
  77 | **Repo/tag**                         | colorado.1.0                         |
  78 |                                      |                                      |
  79 +--------------------------------------+--------------------------------------+
  80 | **Release designation**              | Colorado 1.0 follow-up release       |
  81 |                                      |                                      |
  82 +--------------------------------------+--------------------------------------+
  83 | **Release date**                     | September 22 2016                    |
  84 |                                      |                                      |
  85 +--------------------------------------+--------------------------------------+
  86 | **Purpose of the delivery**          | Colorado alignment to Released       |
  87 |                                      | Fuel 9.0 baseline + Bug-fixes for    |
  88 |                                      | the following feaures/scenarios:     |
  89 |                                      | - NFV Hypervisors-KVM                |
  90 |                                      | - Open vSwitch for NFV               |
  91 |                                      | - OpenDaylight                       |
  92 |                                      | - SDN distributed routing and VPN    |
  93 |                                      | - Service function chaining          |
  94 |                                      |                                      |
  95 +--------------------------------------+--------------------------------------+
  96
  97 Version change
  98 ==============
  99
 100 Module version changes
 101 ----------------------
 102 This is a follow-up release to Colorado 1.0. It is based on
 103 following upstream versions:
 104
 105 - Fuel 9.0 Base release
 106
 107 - OpenStack Mitaka release
 108
 109 - OpenDaylight Beryllium SR3 release [1]_
 110
 111 - ONOS Drake release
 112
 113 Document changes
 114 ----------------
 115 This is a follow-up release to Colorado 1.0. It
 116 comes with the following documentation:
 117
 118 - Installation instructions - *Reference 13* - **Changed**
 119
 120 - Build instructions - *Reference 14* - **Changed**
 121
 122 - Release notes - *Reference 15* - **Changed** (This document)
 123
 124 Reason for version
 125 ==================
 126
 127 Feature additions
 128 -----------------
 129
 130 **JIRA TICKETS:**
 131
 132 -
 133
 134 Bug corrections
 135 ---------------
 136
 137 **JIRA TICKETS:**
 138
 139 `Workarounds <https://jira.opnfv.org/issues/?filter=11121>`_ 'https://jira.opnfv.org/issues/?filter=11121'
 140
 141 (Also See respective Integrated feature project's bug tracking)
 142
 143 Deliverables
 144 ============
 145
 146 Software deliverables
 147 ---------------------
 148
 149 Fuel-based installer iso file found in *Reference 2*
 150
 151 Documentation deliverables
 152 --------------------------
 153
 154 - Installation instructions - *Reference 13*
 155
 156 - Build instructions - *Reference 14*
 157
 158 - Release notes - *Reference 15* (This document)
 159
 160 =========================================
 161 Known Limitations, Issues and Workarounds
 162 =========================================
 163
 164 System Limitations
 165 ==================
 166
 167 - **Max number of blades:** 1 Fuel master, 3 Controllers, 20 Compute blades
 168
 169 - **Min number of blades:** 1 Fuel master, 1 Controller, 1 Compute blade
 170
 171 - **Storage:** Ceph is the only supported storage configuration
 172
 173 - **Max number of networks:** 65k
 174
 175
 176 Known issues
 177 ============
 178
 179 **JIRA TICKETS:**
 180
 181 `Known issues <https://jira.opnfv.org/issues/?filter=11119>`_ 'https://jira.opnfv.org/issues/?filter=11119'
 182
 183 (Also See respective Integrated feature project's bug tracking)
 184
 185 Workarounds
 186 ===========
 187
 188 **JIRA TICKETS:**
 189
 190 `Workarounds <https://jira.opnfv.org/issues/?filter=11120>`_ 'https://jira.opnfv.org/issues/?filter=11120'
 191
 192 (Also See respective Integrated feature project's bug tracking)
 193
 194 ============
 195 Test results
 196 ============
 197 The Colorado 1.0 release with the Fuel deployment tool has undergone QA test
 198 runs, see separate test results.
 199
 200 ==========
 201 References
 202 ==========
 203 For more information on the OPNFV Colorado release, please see:
 204
 205 OPNFV
 206 =====
 207
 208 1) `OPNFV Home Page <http://www.opnfv.org>`_ 'http://www.opnfv.org'
 209
 210 2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_ 'https://www.opnfv.org/software/download'
 211
 212 OpenStack
 213 =========
 214
 215 3) `OpenStack Mitaka Release artifacts <http://www.openstack.org/software/mitaka>`_ 'http://www.openstack.org/software/mitaka'
 216
 217 4) `OpenStack documentation <http://docs.openstack.org>`_ 'http://docs.openstack.org'
 218
 219 OpenDaylight
 220 ============
 221
 222 5) `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_ 'http://www.opendaylight.org/software/downloads'
 223
 224 Fuel
 225 ====
 226
 227 6) `The Fuel OpenStack project <https://wiki.openstack.org/wiki/Fuel>`_ 'https://wiki.openstack.org/wiki/Fuel'
 228
 229 7) `Fuel documentation overview <https://docs.fuel-infra.org/openstack/fuel/fuel-9.0/>`_ 'https://docs.fuel-infra.org/openstack/fuel/fuel-9.0/'
 230
 231 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'
 232
 233 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'
 234
 235 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'
 236
 237 11) `Fuel Plugin Developers Guide <https://wiki.openstack.org/wiki/Fuel/Plugins>`_ 'https://wiki.openstack.org/wiki/Fuel/Plugins'
 238
 239 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'
 240
 241 Fuel in OPNFV
 242 =============
 243
 244 13) `OPNFV Installation instruction for the Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/docs/installation-instruction.html>`_ 'http://artifacts.opnfv.org/fuel/colorado/docs/installation-instruction.html'
 245
 246 14) `OPNFV Build instruction for the Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/docs/build-instruction.html>`_ 'http://artifacts.opnfv.org/fuel/colorado/docs/build-instruction.html'
 247
 248 15) `OPNFV Release Note for the Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/docs/release-notes.html>`_ 'http://artifacts.opnfv.org/fuel/colorado/docs/release-notes.html'
 249
 250 .. [1] OpenDaylight Boron RC2 is used when Service Function Chaining is enabled in Fuel plugin.