From 80b98269a19398e58d6bd84ab71f320928403b5a Mon Sep 17 00:00:00 2001 From: Cristina Pauna Date: Mon, 2 Oct 2017 17:17:45 +0300 Subject: [PATCH] docs: Update release documentation JIRA: FUEL-276 Change-Id: I09799b2dde3c992d229864757e655c108d33608a Signed-off-by: Cristina Pauna (cherry picked from commit 029462bc462b1dea05920464b8d0acc77f789eef) --- docs/release/release-notes/release-notes.rst | 102 +++++++++++---------------- 1 file changed, 43 insertions(+), 59 deletions(-) diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst index 41a22ec2c..fd264e75f 100644 --- a/docs/release/release-notes/release-notes.rst +++ b/docs/release/release-notes/release-notes.rst @@ -6,42 +6,38 @@ Abstract ======== -This document compiles the release notes for the Danube release of -OPNFV when using Fuel as a deployment tool. +This document compiles the release notes for the Euphrates release of +OPNFV when using Fuel as a deployment tool. This is an unified documentation +for both x86_64 and aarch64 architectures. All information is common for +both architectures except when explicitly stated. + =============== Important Notes =============== These notes provides release information for the use of Fuel as deployment -tool for the Danube release of OPNFV. +tool for the Euphrates release of OPNFV. -The goal of the Danube release and this Fuel-based deployment process is +The goal of the Euphrates release and this Fuel-based deployment process is to establish a lab ready platform accelerating further development of the OPNFV infrastructure. -Carefully follow the installation-instructions provided in *Reference 13*. +Carefully follow the installation-instructions. ======= Summary ======= -For Danube, the typical use of Fuel as an OpenStack installer is +For Euphrates, the typical use of Fuel as an OpenStack installer is supplemented with OPNFV unique components such as: - `OpenDaylight `_ -- `Service Function Chaining `_ -- `SDN distributed routing and VPN `_ -- `NFV Hypervisors-KVM `_ - `Open vSwitch for NFV `_ -- `VSPERF `_ -- `Promise `_ -- `Parser `_ -- `Doctor `_ As well as OPNFV-unique configurations of the Hardware and Software stack. -This Danube artifact provides Fuel as the deployment stage tool in the +This Euphrates artifact provides Fuel as the deployment stage tool in the OPNFV CI pipeline including: - Documentation built by Jenkins @@ -52,44 +48,35 @@ OPNFV CI pipeline including: - installation instructions - - build-instructions - -- The Danube Fuel installer image (.iso) built by Jenkins - -- Automated deployment of Danube with running on bare metal or a nested hypervisor environment (KVM) +- Automated deployment of Euphrates with running on bare metal or a nested + hypervisor environment (KVM) -- Automated validation of the Danube deployment +- Automated validation of the Euphrates deployment ============ Release Data ============ +--------------------------------------+--------------------------------------+ -| **Project** | fuel | +| **Project** | fuel/armband | | | | +--------------------------------------+--------------------------------------+ -| **Repo/tag** | danube.2.0 | +| **Repo/tag** | opnfv-5.0.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release designation** | Danube 2.0 | +| **Release designation** | Euphrates 5.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | March 27 2017 | +| **Release date** | October 6 2017 | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | Danube alignment to Released | -| | Fuel 10.0 baseline + features and | +| **Purpose of the delivery** | Euphrates alignment to Released | +| | MCP 1.0 baseline + features and | | | bug-fixes for the following | | | feaures: | -| | - NFV Hypervisors-KVM | +| | | | | - Open vSwitch for NFV | | | - OpenDaylight | -| | - SDN distributed routing and VPN | -| | - Service function chaining | -| | - Promise | -| | - Parser | -| | - Doctor | -| | - Tacker | +--------------------------------------+--------------------------------------+ Version Change @@ -97,24 +84,22 @@ Version Change Module Version Changes ---------------------- -This is the Danube 2.0 release. +This is the Euphrates 5.0 release. It is based on following upstream versions: -- Fuel 10.0 Base Release +- MCP 1.0 Base Release -- OpenStack Newton Release +- OpenStack Ocata Release - OpenDaylight Document Changes ---------------- -This is the Danube 2.0 release. +This is the Euphrates 5.0 release. It comes with the following documentation: - Installation instructions -- Build instructions - - Release notes (This document) Reason for Version @@ -124,14 +109,14 @@ Feature Additions ----------------- **JIRA TICKETS:** - +`Euphrates 5.0 new features `_ Bug Corrections --------------- **JIRA TICKETS:** -`Danube 2.0 bug fixes `_ +`Euphrates 5.0 bug fixes `_ (Also See respective Integrated feature project's bug tracking) @@ -141,16 +126,16 @@ Deliverables Software Deliverables --------------------- -Fuel-based installer iso file found in `OPNFV Downloads `. +- `Fuel@x86_64 installer script files `_ + +- `Fuel@aarch64 installer script files `_ Documentation Deliverables -------------------------- - Installation instructions -- Build instructions - -- Release notes(This document) +- Release notes (This document) ========================================= Known Limitations, Issues and Workarounds @@ -159,11 +144,11 @@ Known Limitations, Issues and Workarounds System Limitations ================== -- **Max number of blades:** 1 Fuel master, 3 Controllers, 20 Compute blades +- **Max number of blades:** 1 Jumpserver, 3 Controllers, 20 Compute blades -- **Min number of blades:** 1 Fuel master, 1 Controller, 1 Compute blade +- **Min number of blades:** 1 Jumpserver -- **Storage:** Ceph is the only supported storage configuration +- **Storage:** Cinder is the only supported storage configuration - **Max number of networks:** 65k @@ -173,7 +158,7 @@ Known Issues **JIRA TICKETS:** -`Known issues `_ +`Known issues `_ (Also See respective Integrated feature project's bug tracking) @@ -182,42 +167,41 @@ Workarounds **JIRA TICKETS:** -`Workarounds `_ +- (Also See respective Integrated feature project's bug tracking) ============ Test Results ============ -The Danube 2.0 release with the Fuel deployment tool has undergone QA test +The Euphrates 5.0 release with the Fuel deployment tool has undergone QA test runs, see separate test results. ========== References ========== -For more information on the OPNFV Danube 2.0 release, please see: +For more information on the OPNFV Euphrates 5.0 release, please see: OPNFV ===== 1) `OPNFV Home Page `_ -2) `OPNFV Documentation - and Software Downloads `_ +2) `OPNFV Documentation `_ +3) `OPNFV Software Downloads `_ OpenStack ========= -3) `OpenStack Newton Release Artifacts `_ +4) `OpenStack Ocata Release Artifacts `_ -4) `OpenStack Documentation `_ +5) `OpenStack Documentation `_ OpenDaylight ============ -5) `OpenDaylight Artifacts `_ +6) `OpenDaylight Artifacts `_ Fuel ==== -6) `The Fuel OpenStack Project `_ -7) `Fuel Documentation `_ - +7) `Mirantis Cloud Platform Documentation `_ -- 2.16.6