From e185a63ff1781afcf819967c53438907ebb0528f Mon Sep 17 00:00:00 2001 From: Cristina Pauna Date: Mon, 20 Mar 2017 16:49:11 +0200 Subject: docs: Copy OPNFV docs dir as documentation base Copy the files from fuel as base documentation. A subsequent commit will adapt it with aarch64 specifics. JIRA: ARMBAND-243 Change-Id: I085d3cfab3a65d8ab7954dcdc876f2b922889ee2 Signed-off-by: Cristina Pauna (cherry picked from commit 6a216628f75cb40fa3acffaa4faf280f09679f5b) --- docs/release/release-notes/release-notes.rst | 186 +++++++++++---------------- 1 file changed, 73 insertions(+), 113 deletions(-) (limited to 'docs/release/release-notes/release-notes.rst') diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst index b4e8bc81..465d0881 100644 --- a/docs/release/release-notes/release-notes.rst +++ b/docs/release/release-notes/release-notes.rst @@ -1,33 +1,24 @@ -.. This document is protected/licensed under the following conditions -.. (c) Jonas Bjurel (Ericsson AB) -.. Licensed under a Creative Commons Attribution 4.0 International License. -.. You should have received a copy of the license along with this work. -.. If not, see . +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Open Platform for NFV Project, Inc. and its contributors ======== Abstract ======== -This document compiles the release notes for the Colorado 3.0 release of -OPNFV when using Fuel as a deployment tool, with an AArch64 (only) target -node pool. +This document compiles the release notes for the Danube release of +OPNFV when using Fuel as a deployment tool. =============== -Important notes +Important Notes =============== These notes provides release information for the use of Fuel as deployment -tool for the AArch64 Colorado 3.0 release of OPNFV. +tool for the Danube release of OPNFV. -The goal of the AArch64 Colorado release and this Fuel-based deployment process -is to establish a lab ready platform accelerating further development -of the OPNFV on AArch64 infrastructure. - -Due to early docker and nodejs support on AArch64, we will still use an -x86_64 Fuel Master to build and deploy an AArch64 target pool. - -Although not currently supported, mixing x86_64 and AArch64 architectures -inside the target pool will be possible later. +The goal of the Danube 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*. @@ -35,32 +26,22 @@ Carefully follow the installation-instructions provided in *Reference 13*. Summary ======= -For AArch64 Colorado, the typical use of Fuel as an OpenStack installer is +For Danube, the typical use of Fuel as an OpenStack installer is supplemented with OPNFV unique components such as: -- `OpenDaylight `_ version "Boron" [1]_ - 'http://www.opendaylight.org/software' - -- `Open vSwitch for NFV `_ 'https://wiki.opnfv.org/ovsnfv' - -- `BGPVPN `_ 'http://docs.openstack.org/developer/networking-bgpvpn/' - -- Tacker `_ 'https://wiki.openstack.org/wiki/Tacker' - -The following OPNFV plugins are not yet ported for AArch64: - -- `ONOS `_ version "Drake" - 'http://onosproject.org/' +- `OpenDaylight `_ +- `Service Function Chaining `_ +- `SDN distributed routing and VPN `_ +- `NFV Hypervisors-KVM `_ +- `Open vSwitch for NFV `_ +- `VSPERF `_ +- `Promise `_ +- `Parser `_ +- `Doctor `_ -- `Service function chaining `_ 'https://wiki.opnfv.org/service_function_chaining' +As well as OPNFV-unique configurations of the Hardware and Software stack. -- `SDN distributed routing and VPN `_ 'https://wiki.opnfv.org/sdnvpn' - -- `NFV Hypervisors-KVM `_ 'https://wiki.opnfv.org/nfv-kvm' - -- `VSPERF `_ 'https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases' - -As well as OPNFV-unique configurations of the Hardware- and Software stack. - -This Colorado artifact provides Fuel as the deployment stage tool in the +This Danube artifact provides Fuel as the deployment stage tool in the OPNFV CI pipeline including: - Documentation built by Jenkins @@ -73,99 +54,103 @@ OPNFV CI pipeline including: - build-instructions -- The Colorado Fuel installer image AArch64 (.iso) built by Jenkins +- The Danube Fuel installer image (.iso) built by Jenkins -- Automated deployment of Colorado with running on bare metal or a nested hypervisor environment (KVM) +- Automated deployment of Danube with running on bare metal or a nested hypervisor environment (KVM) -- Automated validation of the Colorado deployment +- Automated validation of the Danube deployment ============ Release Data ============ +--------------------------------------+--------------------------------------+ -| **Project** | armband | +| **Project** | fuel | | | | +--------------------------------------+--------------------------------------+ -| **Repo/tag** | colorado.3.0 | +| **Repo/tag** | danube.1.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release designation** | Colorado 3.0 follow-up release | +| **Release designation** | Danube 1.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | December 05 2016 | +| **Release date** | March 27 2017 | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | Colorado alignment to Released | -| | Fuel 9.0 baseline + Bug-fixes for | -| | the following feaures/scenarios: | +| **Purpose of the delivery** | Danube alignment to Released | +| | Fuel 10.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 +Version Change ============== -Module version changes +Module Version Changes ---------------------- -This is the Colorado 3.0 follow-up release. +This is the Danube 1.0 release. It is based on following upstream versions: -- Fuel 9.0 Base release - -- OpenStack Mitaka release +- Fuel 10.0 Base Release -- OpenDaylight Boron release [1]_ +- OpenStack Newton Release +- OpenDaylight -Document changes +Document Changes ---------------- -This is the Colorado 3.0 follow-up release. +This is the Danube 1.0 release. It comes with the following documentation: -- Installation instructions - *Reference 13* - **Changed** +- Installation instructions -- Build instructions - *Reference 14* - **Changed** +- Build instructions -- Release notes - *Reference 15* - **Changed** (This document) +- Release notes (This document) -Reason for version +Reason for Version ================== -Feature additions +Feature Additions ----------------- **JIRA TICKETS:** -- -Bug corrections +Bug Corrections --------------- **JIRA TICKETS:** -`Workarounds `_ 'https://jira.opnfv.org/issues/?filter=11404' +`Danube 1.0 bug fixes `_ (Also See respective Integrated feature project's bug tracking) Deliverables ============ -Software deliverables +Software Deliverables --------------------- -AArch64 Fuel-based installer iso file found in *Reference 2* +Fuel-based installer iso file found in `OPNFV Downloads `. -Documentation deliverables +Documentation Deliverables -------------------------- -- Installation instructions - *Reference 13* +- Installation instructions -- Build instructions - *Reference 14* +- Build instructions -- Release notes - *Reference 15* (This document) +- Release notes(This document) ========================================= Known Limitations, Issues and Workarounds @@ -182,16 +167,13 @@ System Limitations - **Max number of networks:** 65k -- **Fuel master arch:** x86_64 -- **Target node arch:** aarch64 - -Known issues +Known Issues ============ **JIRA TICKETS:** -`Known issues `_ 'https://jira.opnfv.org/issues/?filter=11405' +`Known issues `_ (Also See respective Integrated feature project's bug tracking) @@ -200,64 +182,42 @@ Workarounds **JIRA TICKETS:** -- +`Workarounds `_ (Also See respective Integrated feature project's bug tracking) ============ -Test results +Test Results ============ -The Colorado 3.0 release with the Fuel deployment tool has undergone QA test +The Danube 1.0 release with the Fuel deployment tool has undergone QA test runs, see separate test results. ========== References ========== -For more information on the OPNFV Colorado 3.0 release, please see: +For more information on the OPNFV Danube 1.0 release, please see: OPNFV ===== -1) `OPNFV Home Page `_ 'http://www.opnfv.org' - -2) `OPNFV documentation- and software downloads `_ 'https://www.opnfv.org/software/download' +1) `OPNFV Home Page `_ +2) `OPNFV Documentation - and Software Downloads `_ OpenStack ========= -3) `OpenStack Mitaka Release artifacts `_ 'http://www.openstack.org/software/mitaka' +3) `OpenStack Newton Release Artifacts `_ -4) `OpenStack documentation `_ 'http://docs.openstack.org' +4) `OpenStack Documentation `_ OpenDaylight ============ -5) `OpenDaylight artifacts `_ 'http://www.opendaylight.org/software/downloads' +5) `OpenDaylight Artifacts `_ Fuel ==== -6) `The Fuel OpenStack project `_: https://wiki.openstack.org/wiki/Fuel - -7) `Fuel documentation overview `_: http://docs.openstack.org/developer/fuel-docs - -8) `Fuel Installation Guide `_: http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide.html - -9) `Fuel User Guide `_: http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide.html - -10) `Fuel Developer Guide `_: http://docs.openstack.org/developer/fuel-docs/devdocs/develop.html - -11) `Fuel Plugin Developers Guide `_: http://docs.openstack.org/developer/fuel-docs/plugindocs/fuel-plugin-sdk-guide.html - -12) `Fuel OpenStack Hardware Compatibility List `_: https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list - -Fuel in OPNFV -============= - -13) `OPNFV Installation instruction for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool `_ 'http://artifacts.opnfv.org/armband/colorado/3.0/docs/installationprocedure/index.html' - -14) `OPNFV Build instruction for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool `_ 'http://artifacts.opnfv.org/armband/colorado/3.0/docs/buildprocedure/index.html' - -15) `OPNFV Release Note for the AArch64 Colorado release of OPNFV when using Fuel as a deployment tool `_ 'http://artifacts.opnfv.org/armband/colorado/3.0/docs/releasenotes/index.html' +6) `The Fuel OpenStack Project `_ +7) `Fuel Documentation `_ -.. [1] OpenDaylight Boron RC2 is used when Service Function Chaining is enabled in Fuel plugin. -- cgit 1.2.3-korg