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

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. (c) Open Platform for NFV Project, Inc. and its contributors
   4
   5 ========
   6 Abstract
   7 ========
   8
   9 This document compiles the release notes for the Danube release of
  10 OPNFV when using Fuel as a deployment tool.
  11
  12 ===============
  13 Important Notes
  14 ===============
  15
  16 These notes provides release information for the use of Fuel as deployment
  17 tool for the Danube release of OPNFV.
  18
  19 The goal of the Danube release and this Fuel-based deployment process is
  20 to establish a lab ready platform accelerating further development
  21 of the OPNFV infrastructure.
  22
  23 Carefully follow the installation-instructions provided in *Reference 13*.
  24
  25 =======
  26 Summary
  27 =======
  28
  29 For Danube, the typical use of Fuel as an OpenStack installer is
  30 supplemented with OPNFV unique components such as:
  31
  32 - `OpenDaylight <http://www.opendaylight.org/software>`_
  33 - `Service Function Chaining <https://wiki.opnfv.org/service_function_chaining>`_
  34 - `SDN distributed routing and VPN <https://wiki.opnfv.org/sdnvpn>`_
  35 - `NFV Hypervisors-KVM <https://wiki.opnfv.org/nfv-kvm>`_
  36 - `Open vSwitch for NFV <https://wiki.opnfv.org/ovsnfv>`_
  37 - `VSPERF <https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases>`_
  38 - `Promise <https://wiki.opnfv.org/display/promise>`_
  39 - `Parser <https://wiki.opnfv.org/display/parser>`_
  40 - `Doctor <https://wiki.opnfv.org/display/doctor>`_
  41
  42 As well as OPNFV-unique configurations of the Hardware and Software stack.
  43
  44 This Danube artifact provides Fuel as the deployment stage tool in the
  45 OPNFV CI pipeline including:
  46
  47 - Documentation built by Jenkins
  48
  49   - overall OPNFV documentation
  50
  51   - this document (release notes)
  52
  53   - installation instructions
  54
  55   - build-instructions
  56
  57 - The Danube Fuel installer image (.iso) built by Jenkins
  58
  59 - Automated deployment of Danube with running on bare metal or a nested hypervisor environment (KVM)
  60
  61 - Automated validation of the Danube deployment
  62
  63 ============
  64 Release Data
  65 ============
  66
  67 +--------------------------------------+--------------------------------------+
  68 | **Project**                          | fuel                                 |
  69 |                                      |                                      |
  70 +--------------------------------------+--------------------------------------+
  71 | **Repo/tag**                         | danube.1.0                           |
  72 |                                      |                                      |
  73 +--------------------------------------+--------------------------------------+
  74 | **Release designation**              | Danube 1.0                           |
  75 |                                      |                                      |
  76 +--------------------------------------+--------------------------------------+
  77 | **Release date**                     | March 27 2017                        |
  78 |                                      |                                      |
  79 +--------------------------------------+--------------------------------------+
  80 | **Purpose of the delivery**          | Danube alignment to Released         |
  81 |                                      | Fuel 10.0 baseline + features and    |
  82 |                                      | bug-fixes for the following          |
  83 |                                      | feaures:                             |
  84 |                                      | - NFV Hypervisors-KVM                |
  85 |                                      | - Open vSwitch for NFV               |
  86 |                                      | - OpenDaylight                       |
  87 |                                      | - SDN distributed routing and VPN    |
  88 |                                      | - Service function chaining          |
  89 |                                      | - Promise                            |
  90 |                                      | - Parser                             |
  91 |                                      | - Doctor                             |
  92 |                                      | - Tacker                             |
  93 +--------------------------------------+--------------------------------------+
  94
  95 Version Change
  96 ==============
  97
  98 Module Version Changes
  99 ----------------------
 100 This is the Danube 1.0 release.
 101 It is based on following upstream versions:
 102
 103 - Fuel 10.0 Base Release
 104
 105 - OpenStack Newton Release
 106
 107 - OpenDaylight
 108
 109 Document Changes
 110 ----------------
 111 This is the Danube 1.0 release.
 112 It comes with the following documentation:
 113
 114 - Installation instructions
 115
 116 - Build instructions
 117
 118 - Release notes (This document)
 119
 120 Reason for Version
 121 ==================
 122
 123 Feature Additions
 124 -----------------
 125
 126 **JIRA TICKETS:**
 127
 128
 129 Bug Corrections
 130 ---------------
 131
 132 **JIRA TICKETS:**
 133
 134 `Danube 1.0 bug fixes  <https://jira.opnfv.org/issues/?filter=11406>`_
 135
 136 (Also See respective Integrated feature project's bug tracking)
 137
 138 Deliverables
 139 ============
 140
 141 Software Deliverables
 142 ---------------------
 143
 144 Fuel-based installer iso file found in `OPNFV Downloads <https://www.opnfv.org/software/download>`.
 145
 146 Documentation Deliverables
 147 --------------------------
 148
 149 - Installation instructions
 150
 151 - Build instructions
 152
 153 - Release notes(This document)
 154
 155 =========================================
 156 Known Limitations, Issues and Workarounds
 157 =========================================
 158
 159 System Limitations
 160 ==================
 161
 162 - **Max number of blades:** 1 Fuel master, 3 Controllers, 20 Compute blades
 163
 164 - **Min number of blades:** 1 Fuel master, 1 Controller, 1 Compute blade
 165
 166 - **Storage:** Ceph is the only supported storage configuration
 167
 168 - **Max number of networks:** 65k
 169
 170
 171 Known Issues
 172 ============
 173
 174 **JIRA TICKETS:**
 175
 176 `Known issues <https://jira.opnfv.org/issues/?filter=11407>`_
 177
 178 (Also See respective Integrated feature project's bug tracking)
 179
 180 Workarounds
 181 ===========
 182
 183 **JIRA TICKETS:**
 184
 185 `Workarounds <https://jira.opnfv.org/issues/?filter=11408>`_
 186
 187 (Also See respective Integrated feature project's bug tracking)
 188
 189 ============
 190 Test Results
 191 ============
 192 The Danube 1.0 release with the Fuel deployment tool has undergone QA test
 193 runs, see separate test results.
 194
 195 ==========
 196 References
 197 ==========
 198 For more information on the OPNFV Danube 1.0 release, please see:
 199
 200 OPNFV
 201 =====
 202
 203 1) `OPNFV Home Page <http://www.opnfv.org>`_
 204 2) `OPNFV Documentation - and Software Downloads <https://www.opnfv.org/software/download>`_
 205
 206 OpenStack
 207 =========
 208
 209 3) `OpenStack Newton Release Artifacts <http://www.openstack.org/software/newton>`_
 210
 211 4) `OpenStack Documentation <http://docs.openstack.org>`_
 212
 213 OpenDaylight
 214 ============
 215
 216 5) `OpenDaylight Artifacts <http://www.opendaylight.org/software/downloads>`_
 217
 218 Fuel
 219 ====
 220
 221 6) `The Fuel OpenStack Project <https://wiki.openstack.org/wiki/Fuel>`_
 222 7) `Fuel Documentation <http://docs.openstack.org/developer/fuel-docs>`_
 223