diff options
author | Jonas Bjurel <jonas.bjurel@ericsson.com> | 2016-08-17 13:11:15 +0200 |
---|---|---|
committer | Jonas Bjurel <jonas.bjurel@ericsson.com> | 2016-08-17 17:16:31 +0000 |
commit | 983a8377c55ad63133bf5be68a5b52928c592b11 (patch) | |
tree | a5e1d3a01fcfa0cc5358c0d0f428a6bbc719b821 /docs/release-notes.rst | |
parent | 83b2d2a076c0c75886dc819cee87230bd0ec98dc (diff) |
REVISED DOCUMENT STRUCTURE
Documentation structure changed according to docs team directions:
- Configuration guide removed (only aplicable for features/scenarios)
- Installation instructions moved to a separate directory
- Build instructions moved to a separate directory
- Release notes moved to a separate directory
NOTE: Content not updated to the Colorado baseline
Change-Id: I47f3bee0cf91bab6ed5c4a7f371b10347a917857
Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>
Diffstat (limited to 'docs/release-notes.rst')
-rw-r--r-- | docs/release-notes.rst | 246 |
1 files changed, 0 insertions, 246 deletions
diff --git a/docs/release-notes.rst b/docs/release-notes.rst deleted file mode 100644 index 7339b596b..000000000 --- a/docs/release-notes.rst +++ /dev/null @@ -1,246 +0,0 @@ -============================================================================================ -OPNFV Release Note for the Brahmaputra 3.0 release of OPNFV when using Fuel as a deployment tool -============================================================================================ - -License -======= - -This work is licensed under a Creative Commons Attribution 4.0 International -License. .. http://creativecommons.org/licenses/by/4.0 .. -(c) Jonas Bjurel (Ericsson AB) and others - -Abstract -======== - -This document compiles the release notes for the Brahmaputra 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 Brahmaputra 3.0 release of OPNFV. - -The goal of the Brahmaputra 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 Brahmaputra, the typical use of Fuel as an OpenStack installer is -supplemented with OPNFV unique components such as: - -- `OpenDaylight <http://www.opendaylight.org/software>`_ version "Berylium SR1" - -- `ONOS <http://onosproject.org/>`_ version "Drake" - -- `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>`_ - -As well as OPNFV-unique configurations of the Hardware- and Software stack. - -This Brahmaputra 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 Brahmaputra Fuel installer image (.iso) built by Jenkins - -- Automated deployment of Brahmaputra with running on bare metal or a nested hypervisor environment (KVM) - -- Automated validation of the Brahmaputra deployment - -Release Data -============ - -+--------------------------------------+--------------------------------------+ -| **Project** | fuel | -| | | -+--------------------------------------+--------------------------------------+ -| **Repo/tag** | brahmaputra.3.0 | -| | | -+--------------------------------------+--------------------------------------+ -| **Release designation** | Brahmaputra 3.0 follow-up release | -| | | -+--------------------------------------+--------------------------------------+ -| **Release date** | April 28 2016 | -| | | -+--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | Brahmaputra alignment to Released | -| | Fuel 8.0 baseline + Bug-fixes for | -| | the following feaures/scenarios: | -| | - NFV Hypervisors-KVM | -| | - Open vSwitch for NFV | -| | - OpenDaylight SR1 | -| | - SDN distributed routing and VPN | -| | - Service function chaining | -| | | -+--------------------------------------+--------------------------------------+ - -Version change --------------- - -Module version changes -~~~~~~~~~~~~~~~~~~~~~~ -This is a follow-up release to Brahmaputra 1.0. It is based on -following upstream versions: - -- Fuel 8.0 Base release - -- OpenStack Liberty release - -- OpenDaylight Beryllium SR1 release - -- ONOS Drake release - -Document changes -~~~~~~~~~~~~~~~~ -This is a follow-up release to Brahmaputra 1.0. 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:** - -`Workarounds <https://jira.opnfv.org/issues/?filter=11121>`_ 'https://jira.opnfv.org/issues/?filter=11121' - -(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=11119>`_ 'https://jira.opnfv.org/issues/?filter=11119' - -(Also See respective Integrated feature project's bug tracking) - -Workarounds ------------ - -**JIRA TICKETS:** - -`Workarounds <https://jira.opnfv.org/issues/?filter=11120>`_ 'https://jira.opnfv.org/issues/?filter=11120' - -(Also See respective Integrated feature project's bug tracking) - -Test results -============ -The Brahmaputra 3.0 release with the Fuel deployment tool has undergone QA test -runs, see separate test results. - -References -========== -For more information on the OPNFV Brahmaputra 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 Liberty Release artifacts <http://www.openstack.org/software/liberty>`_ - -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 <https://docs.fuel-infra.org/openstack/fuel/fuel-8.0/>`_ - -8) `Fuel planning guide <https://docs.fuel-infra.org/openstack/fuel/fuel-8.0/mos-planning-guide.html>`_ - -9) `Fuel quick start guide <https://docs.mirantis.com/openstack/fuel/fuel-8.0/quickstart-guide.html>`_ - -10) `Fuel operations guide <https://docs.mirantis.com/openstack/fuel/fuel-8.0/operations.html>`_ - -11) `Fuel Plugin Developers Guide <https://wiki.openstack.org/wiki/Fuel/Plugins>`_ - -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 Brahmaputra release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/brahmaputra/docs/installation-instruction.html>`_ - -14) `OPNFV Build instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/brahmaputra/docs/build-instruction.html>`_ - -15) `OPNFV Release Note for the Brahmaputra release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/brahmaputra/docs/release-notes.html>`_ |