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 Euphrates release of
  10 OPNFV when using Fuel as a deployment tool. This is an unified documentation
  11 for both x86_64 and aarch64 architectures. All information is common for
  12 both architectures except when explicitly stated.
  13
  14
  15 ===============
  16 Important Notes
  17 ===============
  18
  19 These notes provides release information for the use of Fuel as deployment
  20 tool for the Euphrates release of OPNFV.
  21
  22 The goal of the Euphrates release and this Fuel-based deployment process is
  23 to establish a lab ready platform accelerating further development
  24 of the OPNFV infrastructure.
  25
  26 Carefully follow the installation-instructions.
  27
  28 =======
  29 Summary
  30 =======
  31
  32 For Euphrates, the typical use of Fuel as an OpenStack installer is
  33 supplemented with OPNFV unique components such as:
  34
  35 - `OpenDaylight <http://www.opendaylight.org/software>`_
  36 - `Open vSwitch for NFV <https://wiki.opnfv.org/ovsnfv>`_
  37
  38 As well as OPNFV-unique configurations of the Hardware and Software stack.
  39
  40 This Euphrates artifact provides Fuel as the deployment stage tool in the
  41 OPNFV CI pipeline including:
  42
  43 - Documentation built by Jenkins
  44
  45   - overall OPNFV documentation
  46
  47   - this document (release notes)
  48
  49   - installation instructions
  50
  51 - Automated deployment of Euphrates with running on bare metal or a nested
  52   hypervisor environment (KVM)
  53
  54 - Automated validation of the Euphrates deployment
  55
  56 ============
  57 Release Data
  58 ============
  59
  60 +--------------------------------------+--------------------------------------+
  61 | **Project**                          | fuel/armband                         |
  62 |                                      |                                      |
  63 +--------------------------------------+--------------------------------------+
  64 | **Repo/tag**                         | opnfv-5.1.0                          |
  65 |                                      |                                      |
  66 +--------------------------------------+--------------------------------------+
  67 | **Release designation**              | Euphrates 5.1                        |
  68 |                                      |                                      |
  69 +--------------------------------------+--------------------------------------+
  70 | **Release date**                     | December 15 2017                     |
  71 |                                      |                                      |
  72 +--------------------------------------+--------------------------------------+
  73 | **Purpose of the delivery**          | Euphrates alignment to Released      |
  74 |                                      | MCP 1.0 baseline + features and      |
  75 |                                      | bug-fixes for the following          |
  76 |                                      | feaures:                             |
  77 |                                      |                                      |
  78 |                                      | - Open vSwitch for NFV               |
  79 |                                      | - OpenDaylight                       |
  80 +--------------------------------------+--------------------------------------+
  81
  82 Version Change
  83 ==============
  84
  85 Module Version Changes
  86 ----------------------
  87 This is the Euphrates 5.1 release.
  88 It is based on following upstream versions:
  89
  90 - MCP 1.0 Base Release
  91
  92 - OpenStack Ocata Release
  93
  94 - OpenDaylight
  95
  96 Document Changes
  97 ----------------
  98 This is the Euphrates 5.1 release.
  99 It comes with the following documentation:
 100
 101 - `Installation instructions <http://docs.opnfv.org/en/stable-euphrates/submodules/armband/docs/release/installation/installation.instruction.html>`_
 102
 103 - Release notes (This document)
 104
 105 - `User guide <http://docs.opnfv.org/en/stable-euphrates/submodules/fuel/docs/release/userguide/userguide.html>`_
 106
 107 Reason for Version
 108 ==================
 109
 110 Feature Additions
 111 -----------------
 112
 113 **JIRA TICKETS:**
 114 `Euphrates 5.1 new features  <https://jira.opnfv.org/issues/?filter=12114>`_
 115
 116 Bug Corrections
 117 ---------------
 118
 119 **JIRA TICKETS:**
 120
 121 `Euphrates 5.1 bug fixes  <https://jira.opnfv.org/issues/?filter=12115>`_
 122
 123 (Also See respective Integrated feature project's bug tracking)
 124
 125 Deliverables
 126 ============
 127
 128 Software Deliverables
 129 ---------------------
 130
 131 - `Fuel@x86_64 installer script files <https://git.opnfv.org/fuel>`_
 132
 133 - `Fuel@aarch64 installer script files <https://git.opnfv.org/armband>`_
 134
 135 Documentation Deliverables
 136 --------------------------
 137
 138 - `Installation instructions <http://docs.opnfv.org/en/stable-euphrates/submodules/armband/docs/release/installation/installation.instruction.html>`_
 139
 140 - Release notes (This document)
 141
 142 - `User guide <http://docs.opnfv.org/en/stable-euphrates/submodules/fuel/docs/release/userguide/userguide.html>`_
 143
 144
 145 =========================================
 146 Known Limitations, Issues and Workarounds
 147 =========================================
 148
 149 System Limitations
 150 ==================
 151
 152 - **Max number of blades:** 1 Jumpserver, 3 Controllers, 20 Compute blades
 153
 154 - **Min number of blades:** 1 Jumpserver
 155
 156 - **Storage:** Cinder is the only supported storage configuration
 157
 158 - **Max number of networks:** 65k
 159
 160
 161 Known Issues
 162 ============
 163
 164 **JIRA TICKETS:**
 165
 166 `Known issues <https://jira.opnfv.org/issues/?filter=12116>`_
 167
 168 (Also See respective Integrated feature project's bug tracking)
 169
 170 Workarounds
 171 ===========
 172
 173 **JIRA TICKETS:**
 174
 175 -
 176
 177 (Also See respective Integrated feature project's bug tracking)
 178
 179 ============
 180 Test Results
 181 ============
 182 The Euphrates 5.1 release with the Fuel deployment tool has undergone QA test
 183 runs, see separate test results.
 184
 185 ==========
 186 References
 187 ==========
 188 For more information on the OPNFV Euphrates 5.1 release, please see:
 189
 190 OPNFV
 191 =====
 192
 193 1) `OPNFV Home Page <http://www.opnfv.org>`_
 194 2) `OPNFV Documentation <http://docs.opnfv.org>`_
 195 3) `OPNFV Software Downloads <https://www.opnfv.org/software/download>`_
 196
 197 OpenStack
 198 =========
 199
 200 4) `OpenStack Ocata Release Artifacts <http://www.openstack.org/software/ocata>`_
 201
 202 5) `OpenStack Documentation <http://docs.openstack.org>`_
 203
 204 OpenDaylight
 205 ============
 206
 207 6) `OpenDaylight Artifacts <http://www.opendaylight.org/software/downloads>`_
 208
 209 Fuel
 210 ====
 211
 212 7) `Mirantis Cloud Platform Documentation <https://docs.mirantis.com/mcp/latest>`_