From a0e2c1d0cbba861aac0b44bd61beb41ddca70630 Mon Sep 17 00:00:00 2001 From: Sofia Wallin Date: Wed, 31 Aug 2016 16:58:13 +0200 Subject: Updated docs structure according to directives Created a sub directory /installationprocedure and added a template for installation and configuration /feature.configuration.rst together with an index.rst Added a /feature.userguide.rst and index.rst under /userguide. Adjusted the releasenotes, renamed the index.rst to releasenotes.rst and added a separate index.rst. Change-Id: I95583558bee739ea1a62e3a4692e872b8025b1b8 Signed-off-by: Sofia Wallin (cherry picked from commit d0bc418d7e4de5e1c2e4143570fa06fc60e1ac85) --- .../feature.configuration.rst | 31 ++++ docs/installationprocedure/index.rst | 13 ++ docs/release-notes/index.rst | 183 --------------------- docs/releasenotes/index.rst | 13 ++ docs/releasenotes/releasenotes.rst | 176 ++++++++++++++++++++ docs/userguide/feature.userguide.rst | 19 +++ docs/userguide/index.rst | 13 ++ 7 files changed, 265 insertions(+), 183 deletions(-) create mode 100644 docs/installationprocedure/feature.configuration.rst create mode 100644 docs/installationprocedure/index.rst delete mode 100644 docs/release-notes/index.rst create mode 100644 docs/releasenotes/index.rst create mode 100644 docs/releasenotes/releasenotes.rst create mode 100644 docs/userguide/feature.userguide.rst create mode 100644 docs/userguide/index.rst diff --git a/docs/installationprocedure/feature.configuration.rst b/docs/installationprocedure/feature.configuration.rst new file mode 100644 index 00000000..a5ee416e --- /dev/null +++ b/docs/installationprocedure/feature.configuration.rst @@ -0,0 +1,31 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) + +<<<<<<< HEAD +========================== +Configuration of +========================== +======= +===================================================== + installation and configuration instruction +===================================================== +>>>>>>> 78eabe91bc321a8668281f61d6b7930664e5bd8a + +Abstract +======== +This document provides information on how to configure required +components during the installation of the platform. + +Pre-configuration activites +=========================== +List the information and activities needed as pre configuration. + +Feature configuration +===================== +<<<<<<< HEAD +List the steps needed for the configuration of . +======= +List the steps needed for the configuration of and of the scenario. + +>>>>>>> 78eabe91bc321a8668281f61d6b7930664e5bd8a diff --git a/docs/installationprocedure/index.rst b/docs/installationprocedure/index.rst new file mode 100644 index 00000000..53279035 --- /dev/null +++ b/docs/installationprocedure/index.rst @@ -0,0 +1,13 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + .. (c) + +********************************************** +SFC installation and configuration instruction +********************************************** + +.. toctree:: + :numbered: + :maxdepth: 2 + + feature.configuration.rst diff --git a/docs/release-notes/index.rst b/docs/release-notes/index.rst deleted file mode 100644 index 492db684..00000000 --- a/docs/release-notes/index.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/releasenotes/index.rst b/docs/releasenotes/index.rst new file mode 100644 index 00000000..e5e1dc60 --- /dev/null +++ b/docs/releasenotes/index.rst @@ -0,0 +1,13 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + .. (c) + +***************** +SFC Release Notes +***************** + +.. toctree:: + :numbered: + :maxdepth: 2 + + releasenotes.rst diff --git a/docs/releasenotes/releasenotes.rst b/docs/releasenotes/releasenotes.rst new file mode 100644 index 00000000..f239579f --- /dev/null +++ b/docs/releasenotes/releasenotes.rst @@ -0,0 +1,176 @@ +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/userguide/feature.userguide.rst b/docs/userguide/feature.userguide.rst new file mode 100644 index 00000000..b8adfa59 --- /dev/null +++ b/docs/userguide/feature.userguide.rst @@ -0,0 +1,19 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) + + description +===================== +.. Describe the specific features and how it is realised in the scenario in a brief manner +.. to ensure the user understand the context for the user guide instructions to follow. + + capabilities and usage +================================ +.. Describe the specific capabilities and usage for feature. +.. Provide enough information that a user will be able to operate the feature on a deployed scenario. + + +----------------------------------------------- +.. Describe with examples how to use specific features, provide API examples and details required to +.. operate the feature on the platform. + diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst new file mode 100644 index 00000000..9bfd2433 --- /dev/null +++ b/docs/userguide/index.rst @@ -0,0 +1,13 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + .. (c) + +************** +SFC User Guide +************** + +.. toctree:: + :numbered: + :maxdepth: 2 + + feature.userguide.rst -- cgit 1.2.3-korg