From 8a69a2d0f2c20bbfc7b975674d9207041ed23ebf Mon Sep 17 00:00:00 2001 From: ChristopherPrice Date: Thu, 25 Feb 2016 13:21:41 +0100 Subject: Checking to see if the build works with the correct structure. Change-Id: Iaf0aa189ba33a63f7fa89c48fce3ac34dcec5aec Signed-off-by: ChristopherPrice (cherry picked from commit 1ac0bc3e63c6d0ecff751843893fbb475b8e6c07) --- docs/release-notes.rst | 183 ------------------------------------------- docs/release-notes/index.rst | 183 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 183 insertions(+), 183 deletions(-) delete mode 100644 docs/release-notes.rst create mode 100644 docs/release-notes/index.rst diff --git a/docs/release-notes.rst b/docs/release-notes.rst deleted file mode 100644 index 492db684..00000000 --- a/docs/release-notes.rst +++ /dev/null @@ -1,183 +0,0 @@ -=========================================================== -OPNFV Release Note for the Brahmaputra release of OPNFV SFC -=========================================================== - -License -======= - -This work is licensed under a Creative Commons Attribution 4.0 International -License. .. http://creativecommons.org/licenses/by/4.0 .. -(c) Brady Johnson (Ericsson Inc.) and others - -Abstract -======== - -This document compiles the release notes for the Brahmaputra release of -OPNFV SFC. - -Important notes -=============== - -These notes provide release information for the use of SFC with the Fuel -and Apex installer tools for the Brahmaputra release of OPNFV. - -Summary -======= - -The goal of the SFC Brahmaputra release is to integrate the OpenDaylight -SFC project into an OPNFV environment, with either the Fuel or Apex -installer. In subsequent releases, other OPNFV installers will be -considered. - -More information about OpenDaylight and SFC can be found here. - -- `OpenDaylight `_ version "Berylium" - -- `Service function chaining `_ - - -- Documentation built by Jenkins - - - overall OPNFV documentation - - - Design document - - - this document (release notes) - - -Release Data -============ - -+--------------------------------------+--------------------------------------+ -| **Project** | sfc | -| | | -+--------------------------------------+--------------------------------------+ -| **Repo/tag** | brahmaputra.1.0 | -| | | -+--------------------------------------+--------------------------------------+ -| **Release designation** | Brahmaputra base release | -| | | -+--------------------------------------+--------------------------------------+ -| **Release date** | February 25 2016 | -| | | -+--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | Brahmaputra base release | -| | | -+--------------------------------------+--------------------------------------+ - -Version change --------------- - -Module version changes -~~~~~~~~~~~~~~~~~~~~~~ -This is the first tracked release of OPNFV sfc. It is based on -following upstream versions: - -- OpenStack Liberty release - -- OpenDaylight Beryllium release - -- Open vSwitch - -Document changes -~~~~~~~~~~~~~~~~ -This is the first tracked version of OPNFV SFC. It comes with -the following documentation: - -- Design document - -- Release notes (This document) - -Reason for version ------------------- - -Feature additions -~~~~~~~~~~~~~~~~~ - -**JIRA TICKETS:** - -`New features `_ 'https://jira.opnfv.org/issues/?filter=11002' - -Bug corrections -~~~~~~~~~~~~~~~ - -**JIRA TICKETS:** - -`Bug-fixes `_ 'https://jira.opnfv.org/browse/FUEL-99?filter=11001' - -Deliverables ------------- - -Software deliverables -~~~~~~~~~~~~~~~~~~~~~ - -No specific deliverables are created, as SFC is included with Apex and Fuel. - -Documentation deliverables -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -- Design document - -- Release notes (This document) - -Known Limitations, Issues and Workarounds -========================================= - -OpenDaylight SFC relies on a version of Open vSwitch (OVS) with -Network Service Headers (NSH). A version of OVS with NSH currently -exists, but it is in a private branch. Extensive upstream work has -been done to merge the NSH patches into mainstream OVS, but the work -is still not complete. More information about this can be found in -the OPNFV SFC design document. - -System Limitations ------------------- - -No limitations beyond those in Fuel and Apex have been identified. - -Known issues ------------- - -**JIRA TICKETS:** - -`Known issues `_ 'https://jira.opnfv.org/browse/SFC-27' - -Workarounds ------------ - - - -Test results -============ -The Brahmaputra release of SFC has only undergone QA test runs with -the Fuel installer and basic Yardstick tests, nothing SFC specific. - -References -========== -For more information on the OPNFV Brahmaputra release, please see: - -OPNFV ------ - -1) `OPNFV Home Page `_ - -2) `OPNFV documentation- and software downloads `_ - -3) `OPNFV Brahmaputra release `_ - -OpenStack ---------- - -4) `OpenStack Liberty Release artifacts `_ - -5) `OpenStack documentation `_ - -OpenDaylight ------------- - -6) `OpenDaylight artifacts `_ - - -:Authors: Brady Johnson (brady.allen.johnson@ericsson.com) -:Version: 1.0.0 - diff --git a/docs/release-notes/index.rst b/docs/release-notes/index.rst new file mode 100644 index 00000000..492db684 --- /dev/null +++ b/docs/release-notes/index.rst @@ -0,0 +1,183 @@ +=========================================================== +OPNFV Release Note for the Brahmaputra release of OPNFV SFC +=========================================================== + +License +======= + +This work is licensed under a Creative Commons Attribution 4.0 International +License. .. http://creativecommons.org/licenses/by/4.0 .. +(c) Brady Johnson (Ericsson Inc.) and others + +Abstract +======== + +This document compiles the release notes for the Brahmaputra release of +OPNFV SFC. + +Important notes +=============== + +These notes provide release information for the use of SFC with the Fuel +and Apex installer tools for the Brahmaputra release of OPNFV. + +Summary +======= + +The goal of the SFC Brahmaputra release is to integrate the OpenDaylight +SFC project into an OPNFV environment, with either the Fuel or Apex +installer. In subsequent releases, other OPNFV installers will be +considered. + +More information about OpenDaylight and SFC can be found here. + +- `OpenDaylight `_ version "Berylium" + +- `Service function chaining `_ + + +- Documentation built by Jenkins + + - overall OPNFV documentation + + - Design document + + - this document (release notes) + + +Release Data +============ + ++--------------------------------------+--------------------------------------+ +| **Project** | sfc | +| | | ++--------------------------------------+--------------------------------------+ +| **Repo/tag** | brahmaputra.1.0 | +| | | ++--------------------------------------+--------------------------------------+ +| **Release designation** | Brahmaputra base release | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | February 25 2016 | +| | | ++--------------------------------------+--------------------------------------+ +| **Purpose of the delivery** | Brahmaputra base release | +| | | ++--------------------------------------+--------------------------------------+ + +Version change +-------------- + +Module version changes +~~~~~~~~~~~~~~~~~~~~~~ +This is the first tracked release of OPNFV sfc. It is based on +following upstream versions: + +- OpenStack Liberty release + +- OpenDaylight Beryllium release + +- Open vSwitch + +Document changes +~~~~~~~~~~~~~~~~ +This is the first tracked version of OPNFV SFC. It comes with +the following documentation: + +- Design document + +- Release notes (This document) + +Reason for version +------------------ + +Feature additions +~~~~~~~~~~~~~~~~~ + +**JIRA TICKETS:** + +`New features `_ 'https://jira.opnfv.org/issues/?filter=11002' + +Bug corrections +~~~~~~~~~~~~~~~ + +**JIRA TICKETS:** + +`Bug-fixes `_ 'https://jira.opnfv.org/browse/FUEL-99?filter=11001' + +Deliverables +------------ + +Software deliverables +~~~~~~~~~~~~~~~~~~~~~ + +No specific deliverables are created, as SFC is included with Apex and Fuel. + +Documentation deliverables +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Design document + +- Release notes (This document) + +Known Limitations, Issues and Workarounds +========================================= + +OpenDaylight SFC relies on a version of Open vSwitch (OVS) with +Network Service Headers (NSH). A version of OVS with NSH currently +exists, but it is in a private branch. Extensive upstream work has +been done to merge the NSH patches into mainstream OVS, but the work +is still not complete. More information about this can be found in +the OPNFV SFC design document. + +System Limitations +------------------ + +No limitations beyond those in Fuel and Apex have been identified. + +Known issues +------------ + +**JIRA TICKETS:** + +`Known issues `_ 'https://jira.opnfv.org/browse/SFC-27' + +Workarounds +----------- + + + +Test results +============ +The Brahmaputra release of SFC has only undergone QA test runs with +the Fuel installer and basic Yardstick tests, nothing SFC specific. + +References +========== +For more information on the OPNFV Brahmaputra release, please see: + +OPNFV +----- + +1) `OPNFV Home Page `_ + +2) `OPNFV documentation- and software downloads `_ + +3) `OPNFV Brahmaputra release `_ + +OpenStack +--------- + +4) `OpenStack Liberty Release artifacts `_ + +5) `OpenStack documentation `_ + +OpenDaylight +------------ + +6) `OpenDaylight artifacts `_ + + +:Authors: Brady Johnson (brady.allen.johnson@ericsson.com) +:Version: 1.0.0 + -- cgit 1.2.3-korg