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.0.0                          |
  65 |                                      |                                      |
  66 +--------------------------------------+--------------------------------------+
  67 | **Release designation**              | Euphrates 5.0                        |
  68 |                                      |                                      |
  69 +--------------------------------------+--------------------------------------+
  70 | **Release date**                     | October 6 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.0 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.0 release.
  99 It comes with the following documentation:
 100
 101 - Installation instructions
 102
 103 - Release notes (This document)
 104
 105 Reason for Version
 106 ==================
 107
 108 Feature Additions
 109 -----------------
 110
 111 **JIRA TICKETS:**
 112 `Euphrates 5.0 new features  <https://jira.opnfv.org/issues/?filter=12029>`_
 113
 114 Bug Corrections
 115 ---------------
 116
 117 **JIRA TICKETS:**
 118
 119 `Euphrates 5.0 bug fixes  <https://jira.opnfv.org/issues/?filter=12027>`_
 120
 121 (Also See respective Integrated feature project's bug tracking)
 122
 123 Deliverables
 124 ============
 125
 126 Software Deliverables
 127 ---------------------
 128
 129 - `Fuel@x86_64 installer script files <https://git.opnfv.org/fuel>`_
 130
 131 - `Fuel@aarch64 installer script files <https://git.opnfv.org/armband>`_
 132
 133 Documentation Deliverables
 134 --------------------------
 135
 136 - Installation instructions
 137
 138 - Release notes (This document)
 139
 140 =========================================
 141 Known Limitations, Issues and Workarounds
 142 =========================================
 143
 144 System Limitations
 145 ==================
 146
 147 - **Max number of blades:** 1 Jumpserver, 3 Controllers, 20 Compute blades
 148
 149 - **Min number of blades:** 1 Jumpserver
 150
 151 - **Storage:** Cinder is the only supported storage configuration
 152
 153 - **Max number of networks:** 65k
 154
 155
 156 Known Issues
 157 ============
 158
 159 **JIRA TICKETS:**
 160
 161 `Known issues <https://jira.opnfv.org/issues/?filter=12028>`_
 162
 163 (Also See respective Integrated feature project's bug tracking)
 164
 165 Workarounds
 166 ===========
 167
 168 **JIRA TICKETS:**
 169
 170 -
 171
 172 (Also See respective Integrated feature project's bug tracking)
 173
 174 ============
 175 Test Results
 176 ============
 177 The Euphrates 5.0 release with the Fuel deployment tool has undergone QA test
 178 runs, see separate test results.
 179
 180 ==========
 181 References
 182 ==========
 183 For more information on the OPNFV Euphrates 5.0 release, please see:
 184
 185 OPNFV
 186 =====
 187
 188 1) `OPNFV Home Page <http://www.opnfv.org>`_
 189 2) `OPNFV Documentation <http://docs.opnfv.org>`_
 190 3) `OPNFV Software Downloads <https://www.opnfv.org/software/download>`_
 191
 192 OpenStack
 193 =========
 194
 195 4) `OpenStack Ocata Release Artifacts <http://www.openstack.org/software/ocata>`_
 196
 197 5) `OpenStack Documentation <http://docs.openstack.org>`_
 198
 199 OpenDaylight
 200 ============
 201
 202 6) `OpenDaylight Artifacts <http://www.opendaylight.org/software/downloads>`_
 203
 204 Fuel
 205 ====
 206
 207 7) `Mirantis Cloud Platform Documentation <https://docs.mirantis.com/mcp/latest>`_