From 5765c5a1b1459c815c2b871b00c36f8fcc75095d Mon Sep 17 00:00:00 2001 From: Serg Melikyan Date: Tue, 28 Feb 2017 17:01:03 -0800 Subject: Update documentation for Danube Change-Id: I535eb87bfa980cffc8e091b896b505884ed12d32 Signed-off-by: Serg Melikyan --- docs/releasenotes/index.rst | 16 --- docs/releasenotes/release-notes.rst | 260 ------------------------------------ 2 files changed, 276 deletions(-) delete mode 100644 docs/releasenotes/index.rst delete mode 100644 docs/releasenotes/release-notes.rst (limited to 'docs/releasenotes') diff --git a/docs/releasenotes/index.rst b/docs/releasenotes/index.rst deleted file mode 100644 index db97a7492..000000000 --- a/docs/releasenotes/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. 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 . - -***************************** -Release notes for Fuel\@OPNFV -***************************** - -.. toctree:: - :numbered: - :maxdepth: 2 - - release-notes.rst - diff --git a/docs/releasenotes/release-notes.rst b/docs/releasenotes/release-notes.rst deleted file mode 100644 index b7fcc3e2e..000000000 --- a/docs/releasenotes/release-notes.rst +++ /dev/null @@ -1,260 +0,0 @@ -.. 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 . - -======== -Abstract -======== - -This document compiles the release notes for the Colorado 3.0 release of -OPNFV when using Fuel as a deployment tool. - -=============== -Important notes -=============== - -These notes provides release information for the use of Fuel as deployment -tool for the Colorado 3.0 release of OPNFV. - -The goal of the Colorado 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*. - -======= -Summary -======= - -For Colorado, 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' - -- `ONOS `_ version "Drake" 'http://onosproject.org/' - -- `Service function chaining `_ 'https://wiki.opnfv.org/service_function_chaining' - -- `SDN distributed routing and VPN `_ 'https://wiki.opnfv.org/sdnvpn' - -- `NFV Hypervisors-KVM `_ 'https://wiki.opnfv.org/nfv-kvm' - -- `Open vSwitch for NFV `_ 'https://wiki.opnfv.org/ovsnfv' - -- `VSPERF `_ 'https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases' - -- `Promise `_ 'https://wiki.opnfv.org/display/promise' - -- `Parser `_ 'https://wiki.opnfv.org/display/parser' - -- `Doctor `_ 'https://wiki.opnfv.org/display/doctor' - -As well as OPNFV-unique configurations of the Hardware- and Software stack. - -This Colorado artifact provides Fuel as the deployment stage tool in the -OPNFV CI pipeline including: - -- Documentation built by Jenkins - - - overall OPNFV documentation - - - this document (release notes) - - - installation instructions - - - build-instructions - -- The Colorado Fuel installer image (.iso) built by Jenkins - -- Automated deployment of Colorado with running on bare metal or a nested hypervisor environment (KVM) - -- Automated validation of the Colorado deployment - -============ -Release Data -============ - -+--------------------------------------+--------------------------------------+ -| **Project** | fuel | -| | | -+--------------------------------------+--------------------------------------+ -| **Repo/tag** | colorado.3.0 | -| | | -+--------------------------------------+--------------------------------------+ -| **Release designation** | Colorado 3.0 follow-up release | -| | | -+--------------------------------------+--------------------------------------+ -| **Release date** | December 05 2016 | -| | | -+--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | Colorado alignment to Released | -| | Fuel 9.0 baseline + features and | -| | bug-fixes for the following | -| | feaures: | -| | - NFV Hypervisors-KVM | -| | - Open vSwitch for NFV | -| | - OpenDaylight | -| | - ONOS | -| | - SDN distributed routing and VPN | -| | - Service function chaining | -| | - Promise | -| | - Parser | -| | - Doctor | -| | - Tacker | -+--------------------------------------+--------------------------------------+ - -Version change -============== - -Module version changes ----------------------- -This is the Colorado 3.0 follow-up release. -It is based on following upstream versions: - -- Fuel 9.0 Base release - -- OpenStack Mitaka release - -- OpenDaylight Boron release [1]_ - -- ONOS Drake release - -Document changes ----------------- -This is the Colorado 3.0 follow-up release. -It comes with the following documentation: - -- Installation instructions - *Reference 13* - **Changed** - -- Build instructions - *Reference 14* - **Changed** - -- Release notes - *Reference 15* - **Changed** (This document) - -Reason for version -================== - -Feature additions ------------------ - -**JIRA TICKETS:** - - -Bug corrections ---------------- - -**JIRA TICKETS:** - -`Colorado 3.0 bug fixes `_ 'https://jira.opnfv.org/issues/?filter=11406' - -(Also See respective Integrated feature project's bug tracking) - -Deliverables -============ - -Software deliverables ---------------------- - -Fuel-based installer iso file found in *Reference 2* - -Documentation deliverables --------------------------- - -- Installation instructions - *Reference 13* - -- Build instructions - *Reference 14* - -- Release notes - *Reference 15* (This document) - -========================================= -Known Limitations, Issues and Workarounds -========================================= - -System Limitations -================== - -- **Max number of blades:** 1 Fuel master, 3 Controllers, 20 Compute blades - -- **Min number of blades:** 1 Fuel master, 1 Controller, 1 Compute blade - -- **Storage:** Ceph is the only supported storage configuration - -- **Max number of networks:** 65k - - -Known issues -============ - -**JIRA TICKETS:** - -`Known issues `_ 'https://jira.opnfv.org/issues/?filter=11407' - -(Also See respective Integrated feature project's bug tracking) - -Workarounds -=========== - -**JIRA TICKETS:** - -`Workarounds `_ 'https://jira.opnfv.org/issues/?filter=11408' - -(Also See respective Integrated feature project's bug tracking) - -============ -Test results -============ -The Colorado 3.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: - -OPNFV -===== - -1) `OPNFV Home Page `_ 'http://www.opnfv.org' - -2) `OPNFV documentation- and software downloads `_ 'https://www.opnfv.org/software/download' - -OpenStack -========= - -3) `OpenStack Mitaka Release artifacts `_ 'http://www.openstack.org/software/mitaka' - -4) `OpenStack documentation `_ 'http://docs.openstack.org' - -OpenDaylight -============ - -5) `OpenDaylight artifacts `_ 'http://www.opendaylight.org/software/downloads' - -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 Colorado 3.0 release of OPNFV when using Fuel as a deployment tool `_ 'http://artifacts.opnfv.org/fuel/colorado/3.0/docs/installationprocedure/index.html' - -14) `OPNFV Build instruction for the Colorado 3.0 release of OPNFV when using Fuel as a deployment tool `_ 'http://artifacts.opnfv.org/fuel/colorado/3.0/docs/buildprocedure/index.html' - -15) `OPNFV Release Note for the Colorado 3.0 release of OPNFV when using Fuel as a deployment tool `_ 'http://artifacts.opnfv.org/fuel/colorado/3.0/docs/releasenotes/index.html' - -.. [1] OpenDaylight Beryllium SR3 is used when BGP VPN is enabled in Fuel plugin. -- cgit 1.2.3-korg