From 7bde278edccd1008149a9204da133201fa6babbb Mon Sep 17 00:00:00 2001 From: ChristopherPrice Date: Fri, 1 Jul 2016 09:58:27 +0200 Subject: Establishing document structures for Colorado. Derived from converging patches 16165, 16047 & 15937 into one patch. Change-Id: I3c544ba2fa30856a50274bad9342a06eebc39d58 Signed-off-by: ChristopherPrice Co-Authored-By: Sofia Wallin --- build-composite.sh | 11 +- docs/configguide/abstract.rst | 18 --- docs/configguide/configoptions.rst | 27 ----- docs/configguide/feature-config.rst | 12 -- docs/configguide/featureconfig.rst | 28 ----- docs/configguide/index.rst | 17 --- docs/configguide/installer-config.rst | 21 ---- docs/configguide/installerconfig.rst | 26 ---- docs/configguide/pharos-config.rst | 5 - docs/configguide/post-install.rst | 59 --------- docs/configguide/postinstall-copper.rst | 4 - docs/configguide/postinstall-fuel.rst | 4 - docs/configguide/postinstall-functest.rst | 5 - docs/configguide/postinstall-ipv6.rst | 4 - docs/configguide/postinstall-joid.rst | 4 - docs/configguide/postinstall-vswitchperf.rst | 4 - docs/configguide/postinstall-yardstick.rst | 6 - docs/configguide/postinstall.rst | 30 ----- docs/configguide/projects-configguide.rst | 6 - docs/configurationguide/abstract.rst | 19 +++ .../configuration.options.render.rst | 27 +++++ .../feature.configuration.description.rst | 22 ++++ docs/configurationguide/index.rst | 16 +++ .../installation.procedure.render.rst | 20 ++++ docs/installationprocedure/abstract.rst | 0 docs/installationprocedure/index.rst | 15 +++ .../scenario.installation.instruction.rst | 26 ++++ .../scenario.release.notes.rst | 132 +++++++++++++++++++++ docs/release-notes/index.rst | 14 --- docs/release-notes/release-notes.rst | 132 --------------------- .../framework.installation.procedure.render.rst | 10 ++ docs/testframework/framework.userguide.render.rst | 10 ++ docs/testframework/index.rst | 16 +++ .../testframework/opnfv.testframework.overview.rst | 17 +++ docs/userguide/common.platform.render.rst | 26 ++++ docs/userguide/feature-usage.rst | 15 --- docs/userguide/feature.userguide.render.rst | 15 +++ docs/userguide/feature.userguide.template.rst | 12 ++ docs/userguide/featureusage.rst | 12 -- docs/userguide/general-system.rst | 26 ---- docs/userguide/test-usage.rst | 17 --- docs/userguide/testusage.rst | 12 -- 42 files changed, 389 insertions(+), 513 deletions(-) delete mode 100644 docs/configguide/abstract.rst delete mode 100644 docs/configguide/configoptions.rst delete mode 100644 docs/configguide/feature-config.rst delete mode 100644 docs/configguide/featureconfig.rst delete mode 100644 docs/configguide/index.rst delete mode 100644 docs/configguide/installer-config.rst delete mode 100644 docs/configguide/installerconfig.rst delete mode 100644 docs/configguide/pharos-config.rst delete mode 100644 docs/configguide/post-install.rst delete mode 100644 docs/configguide/postinstall-copper.rst delete mode 100644 docs/configguide/postinstall-fuel.rst delete mode 100644 docs/configguide/postinstall-functest.rst delete mode 100644 docs/configguide/postinstall-ipv6.rst delete mode 100644 docs/configguide/postinstall-joid.rst delete mode 100644 docs/configguide/postinstall-vswitchperf.rst delete mode 100644 docs/configguide/postinstall-yardstick.rst delete mode 100644 docs/configguide/postinstall.rst delete mode 100644 docs/configguide/projects-configguide.rst create mode 100644 docs/configurationguide/abstract.rst create mode 100644 docs/configurationguide/configuration.options.render.rst create mode 100644 docs/configurationguide/feature.configuration.description.rst create mode 100644 docs/configurationguide/index.rst create mode 100644 docs/configurationguide/installation.procedure.render.rst create mode 100644 docs/installationprocedure/abstract.rst create mode 100644 docs/installationprocedure/index.rst create mode 100644 docs/installationprocedure/scenario.installation.instruction.rst create mode 100644 docs/installationprocedure/scenario.release.notes.rst delete mode 100644 docs/release-notes/index.rst delete mode 100644 docs/release-notes/release-notes.rst create mode 100644 docs/testframework/framework.installation.procedure.render.rst create mode 100644 docs/testframework/framework.userguide.render.rst create mode 100644 docs/testframework/index.rst create mode 100644 docs/testframework/opnfv.testframework.overview.rst create mode 100644 docs/userguide/common.platform.render.rst delete mode 100644 docs/userguide/feature-usage.rst create mode 100644 docs/userguide/feature.userguide.render.rst create mode 100644 docs/userguide/feature.userguide.template.rst delete mode 100644 docs/userguide/featureusage.rst delete mode 100644 docs/userguide/general-system.rst delete mode 100644 docs/userguide/test-usage.rst delete mode 100644 docs/userguide/testusage.rst diff --git a/build-composite.sh b/build-composite.sh index f393b62fb..5a9d253b5 100755 --- a/build-composite.sh +++ b/build-composite.sh @@ -87,12 +87,13 @@ echo echo "Creating document links" echo targets=" -configguide/installer-config.rst -configguide/feature-config.rst -userguide/test-usage.rst -userguide/feature-usage.rst +configurationguide/configuration.options.render.rst +configurationguide/installation.procedure.render.rst +userguide/feature.userguide.render.rst +testframework/framework.installation.procedure.render.rst +testframework/framework.userguide.render.rst " -# configguide/post-install.rst +# configurationguide/post-install.rst for guide in $targets do mainfile="$WORKSPACE/docs/$guide" diff --git a/docs/configguide/abstract.rst b/docs/configguide/abstract.rst deleted file mode 100644 index 95f7628b0..000000000 --- a/docs/configguide/abstract.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Christopher Price (Ericsson AB) - -======== -Abstract -======== - -This document provides guidance and instructions for the configuration -of the Brahmaputra release of OPNFV. - -The release includes four installer tools leveraging different -technologies; Apex, Compass4nfv, Fuel and JOID, which deploy -components of the platform. - -This document provides a guide for the selection of tools and -components including guidelines for how to deploy and configure -the platform to an operational state. diff --git a/docs/configguide/configoptions.rst b/docs/configguide/configoptions.rst deleted file mode 100644 index cb5774a41..000000000 --- a/docs/configguide/configoptions.rst +++ /dev/null @@ -1,27 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Christopher Price (Ericsson AB) - -===================== -Configuration Options -===================== - -OPNFV provides a variety of virtual infrastructure deployments called scenarios designed to -host virtualised network functions (VNF's). Each scenario provide specific capabilities and/or -components aimed to solve specific problems for the deployment of VNF's. A scenario may include -components such as OpenStack, OpenDaylight, OVS, KVM etc. where each scenario will -include different source components or configurations. - -OPNFV Scenarios -================ - -Each OPNFV scenario provides unique features and capabilities, it is important to understand -your target platform capabilities before installing and configuring your target scenario. -This configuration guide outlines how to install and configure components in order to enable -the features you require. - -.. include:: ../scenario/scenariomatrix.rst - -This document will describe how to install and configure your target OPNFV scenarios. -Remember to check the associated validation procedures section following your installation for -details of the use cases and tests that have been run. diff --git a/docs/configguide/feature-config.rst b/docs/configguide/feature-config.rst deleted file mode 100644 index f40bff22c..000000000 --- a/docs/configguide/feature-config.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Christopher Price (Ericsson AB) - -===================== -Feature Configuration -===================== - -The following sections describe the configuration options for specific platform features provided in Brahmaputra. -Further details for each feature are captured in the referred project documentation. - -.. /docs/configguide/featureconfig.rst files will be imported below by the build script. diff --git a/docs/configguide/featureconfig.rst b/docs/configguide/featureconfig.rst deleted file mode 100644 index 0fe70060e..000000000 --- a/docs/configguide/featureconfig.rst +++ /dev/null @@ -1,28 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) - - configuration -======================= -Add a brief introduction to configure OPNFV with this specific feature including -dependancies on platform components, this description should be at a level that -will apply to any installer providing the pre-requisite components. - -Pre-configuration activities ----------------------------- -Describe specific pre-configuration activities. This should include ensuring the -right components are installed by the installation tools as required for your -feature to function. Refer to the previous installer configuration chapters, -installations guide and release notes - -Hardware configuration ----------------------- -Describe the hardware configuration needed for this specific feature - -Feature configuration ---------------------- -Describe the procedures to configure your feature on the platform in order -that it is ready to use according to the feature instructions in the platform -user guide. Where applicable you should add content in the postinstall.rst -to validate the feature is configured for use. -(checking components are installed correctly etc...) diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst deleted file mode 100644 index 1559fab0a..000000000 --- a/docs/configguide/index.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Christopher Price (Ericsson AB) - -************************* -OPNFV Configuration Guide -************************* - -.. toctree:: - :maxdepth: 2 - - ./abstract - ./configoptions - ./installer-config - ./feature-config - ./post-install - diff --git a/docs/configguide/installer-config.rst b/docs/configguide/installer-config.rst deleted file mode 100644 index a88d1f50e..000000000 --- a/docs/configguide/installer-config.rst +++ /dev/null @@ -1,21 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Christopher Price (Ericsson AB) - -======================= -Installer Configuration -======================= - -Installing the OPNFV platform requires either a physical environment as defined in the -Pharos lab specification, or a virtual infrastructure. When configuring a physical infrastructure -it is strongly advised to follow the Pharos configuration material. - -.. toctree:: - - pharos-config - - -The following sections describe the per installer configuration options. -Further details for each installer are captured in the referred project documentation. - -.. /docs/configguide/installerconfig.rst files will be imported below by the build script. diff --git a/docs/configguide/installerconfig.rst b/docs/configguide/installerconfig.rst deleted file mode 100644 index afb414bf5..000000000 --- a/docs/configguide/installerconfig.rst +++ /dev/null @@ -1,26 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) - - configuration -======================= -Add a brief introduction to configure OPNFV with this specific installer - -Pre-configuration activities ------------------------------ -Describe specific pre-configuration activities. Refer to Installations guide and release notes - -Hardware configuration ------------------------ -Describe the hardware configuration needed for this specific installer - -Jumphost configuration ------------------------ -Describe intial Jumphost configuration (network and software)needed in order to deploy the installer - -Platform components configuration ---------------------------------- -Describe the configuration of each component in the installer - - - diff --git a/docs/configguide/pharos-config.rst b/docs/configguide/pharos-config.rst deleted file mode 100644 index 013e21b34..000000000 --- a/docs/configguide/pharos-config.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -.. include:: ../projects/pharos/configguide/configguide.rst -.. include:: ../projects/pharos/configguide/jumpserverinstall.rst diff --git a/docs/configguide/post-install.rst b/docs/configguide/post-install.rst deleted file mode 100644 index c7bc27ea1..000000000 --- a/docs/configguide/post-install.rst +++ /dev/null @@ -1,59 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Christopher Price (Ericsson AB) - -============================= -Post Configuration Activities -============================= - -Once you have deployed and configured your scenario and features you should validate the -state of the system using the following guides. - -Scenario validation activities -============================== - -The following guides provide information on how to validate the installation of you scenario -based on the tools and test suites available for the installation tool you have selected: - -.. toctree:: - - postinstall-fuel - -.. toctree:: - - postinstall-joid - -Feature validation activities -============================= - -The following sections provide information on how to validate the features you have -installed in your scenario: - -.. toctree:: - - postinstall-copper - -.. toctree:: - - postinstall-ipv6 - - -Additional testing and validation activities -============================================ - -Many of our testing tools can be manually installed to facilitate targeted testing -of features and capabilities of your scenario. The following guides provide instruction on -setting up these testing suites: - -.. toctree:: - - postinstall-functest - -.. toctree:: - - postinstall-vswitchperf - -.. toctree:: - - postinstall-yardstick - diff --git a/docs/configguide/postinstall-copper.rst b/docs/configguide/postinstall-copper.rst deleted file mode 100644 index 06c4b151b..000000000 --- a/docs/configguide/postinstall-copper.rst +++ /dev/null @@ -1,4 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -.. include:: ../projects/copper/configguide/postinstall.rst diff --git a/docs/configguide/postinstall-fuel.rst b/docs/configguide/postinstall-fuel.rst deleted file mode 100644 index 877e548cb..000000000 --- a/docs/configguide/postinstall-fuel.rst +++ /dev/null @@ -1,4 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -.. include:: ../projects/fuel/configguide/postinstall.rst diff --git a/docs/configguide/postinstall-functest.rst b/docs/configguide/postinstall-functest.rst deleted file mode 100644 index 5c9e03ec3..000000000 --- a/docs/configguide/postinstall-functest.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -.. include:: ../projects/functest/userguide/introduction.rst -.. include:: ../projects/functest/configguide/configguide.rst diff --git a/docs/configguide/postinstall-ipv6.rst b/docs/configguide/postinstall-ipv6.rst deleted file mode 100644 index 8a51452b6..000000000 --- a/docs/configguide/postinstall-ipv6.rst +++ /dev/null @@ -1,4 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -.. include:: ../projects/ipv6/configguide/postinstall.rst diff --git a/docs/configguide/postinstall-joid.rst b/docs/configguide/postinstall-joid.rst deleted file mode 100644 index d986b6f22..000000000 --- a/docs/configguide/postinstall-joid.rst +++ /dev/null @@ -1,4 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -.. include:: ../projects/joid/configguide/postinstall.rst diff --git a/docs/configguide/postinstall-vswitchperf.rst b/docs/configguide/postinstall-vswitchperf.rst deleted file mode 100644 index e241d4978..000000000 --- a/docs/configguide/postinstall-vswitchperf.rst +++ /dev/null @@ -1,4 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -.. include:: ../projects/vswitchperf/configguide/installation.rst diff --git a/docs/configguide/postinstall-yardstick.rst b/docs/configguide/postinstall-yardstick.rst deleted file mode 100644 index 841b47ff1..000000000 --- a/docs/configguide/postinstall-yardstick.rst +++ /dev/null @@ -1,6 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -.. include:: ../projects/yardstick/userguide/comp-intro.rst -.. include:: ../projects/yardstick/userguide/03-installation.rst - diff --git a/docs/configguide/postinstall.rst b/docs/configguide/postinstall.rst deleted file mode 100644 index 959bb81eb..000000000 --- a/docs/configguide/postinstall.rst +++ /dev/null @@ -1,30 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) - - post installation procedures -====================================== -Add a brief introduction to the methods of validating the installation -according to this specific installer or feature. - -Automated post installation activities --------------------------------------- -Describe specific post installation activities performed by the OPNFV -deployment pipeline including testing activities and reports. Refer to -the relevant testing guides, results, and release notes. - -note: this section should be singular and derived from the test projects -once we have one test suite to run for all deploy tools. This is not the -case yet so each deploy tool will need to provide (hopefully very simillar) -documentation of this. - - post configuration procedures --------------------------------------- -Describe any deploy tool or feature specific scripts, tests or procedures -that should be carried out on the deployment post install and configuration -in this section. - -Platform components validation ---------------------------------- -Describe any component specific validation procedures necessary for your -deployment tool in this section. diff --git a/docs/configguide/projects-configguide.rst b/docs/configguide/projects-configguide.rst deleted file mode 100644 index 71ed0d821..000000000 --- a/docs/configguide/projects-configguide.rst +++ /dev/null @@ -1,6 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Christopher Price (Ericsson AB) - -.. This file will have links to other projects docs in composite doc build. - diff --git a/docs/configurationguide/abstract.rst b/docs/configurationguide/abstract.rst new file mode 100644 index 000000000..1263dfa56 --- /dev/null +++ b/docs/configurationguide/abstract.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) Christopher Price (Ericsson AB) + +======== +Abstract +======== + +This document provides guidance for the configurations available in the +Colorado release of OPNFV. + +The release includes four installer tools leveraging different +technologies; Apex, Compass4nfv, Fuel and JOID, which deploy +components of the platform. + +This document also includes the selection of tools and +components including guidelines for how to deploy and configure +the platform to an operational state. + diff --git a/docs/configurationguide/configuration.options.render.rst b/docs/configurationguide/configuration.options.render.rst new file mode 100644 index 000000000..f8f16ff54 --- /dev/null +++ b/docs/configurationguide/configuration.options.render.rst @@ -0,0 +1,27 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Christopher Price (Ericsson AB) + +===================== +Configuration Options +===================== + +OPNFV provides a variety of virtual infrastructure deployments called scenarios designed to +host virtualised network functions (VNF's). Each scenario provide specific capabilities and/or +components aimed to solve specific problems for the deployment of VNF's. A scenario may include +components such as OpenStack, OpenDaylight, OVS, KVM etc. where each scenario will +include different source components or configurations. + +OPNFV Scenarios +=============== + +Each OPNFV scenario provides unique features and capabilities, it is important to understand +your target platform capabilities before installing and configuring your target scenario. +This configuration guide outlines how to install and configure components in order to enable +the features you require. + +.. include:: ../scenario/scenariomatrix.rst + +This document will describe how to install and configure your target OPNFV scenarios. +Remember to check the associated validation procedures section following your installation for +details of the use cases and tests that have been run. diff --git a/docs/configurationguide/feature.configuration.description.rst b/docs/configurationguide/feature.configuration.description.rst new file mode 100644 index 000000000..717cd0fa2 --- /dev/null +++ b/docs/configurationguide/feature.configuration.description.rst @@ -0,0 +1,22 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Sofia Wallin (Ericsson AB) + +Configuration of +========================== + +Add a brief introduction to configure OPNFV with this specific feature including +dependancies on platform components, this description should be at a level that +will apply to any installer providing the pre-requisite components. + +Pre-configuration activities +---------------------------- +Describe specific pre-configuration activities. This should include ensuring the +right components are installed by the installation tools as required for your +feature to function. Refer to the previous installer configuration chapters, +installations guide and release notes + +Hardware configuration +---------------------- +Describe the hardware configuration needed for this specific feature + diff --git a/docs/configurationguide/index.rst b/docs/configurationguide/index.rst new file mode 100644 index 000000000..1b0fec4ce --- /dev/null +++ b/docs/configurationguide/index.rst @@ -0,0 +1,16 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Christopher Price (Ericsson AB) + +************************* +OPNFV Configuration Guide +************************* + +.. toctree:: + :maxdepth: 2 + + ./abstract + ./configuration.options.render + ./feature.configuration.description + ./installer.procedure.render + diff --git a/docs/configurationguide/installation.procedure.render.rst b/docs/configurationguide/installation.procedure.render.rst new file mode 100644 index 000000000..c0925c507 --- /dev/null +++ b/docs/configurationguide/installation.procedure.render.rst @@ -0,0 +1,20 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Sofia Wallin (Ericsson AB) + +===================== +Installation of +===================== + +Introduction +------------ +Describe the capabilities and associated features of each installer. + +Pre-installation activities +--------------------------- +List the acitvites needed for pre-installation. + +Hardware requirement +-------------------- +List the HW requirement for each installer + diff --git a/docs/installationprocedure/abstract.rst b/docs/installationprocedure/abstract.rst new file mode 100644 index 000000000..e69de29bb diff --git a/docs/installationprocedure/index.rst b/docs/installationprocedure/index.rst new file mode 100644 index 000000000..9503c7b50 --- /dev/null +++ b/docs/installationprocedure/index.rst @@ -0,0 +1,15 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Sofia Wallin Ericsson AB + +********************** +Installation procedure +********************** + +.. toctree:: + :numbered: + :maxdepth: 2 + + abstract.rst + scenario.installation.instruction + diff --git a/docs/installationprocedure/scenario.installation.instruction.rst b/docs/installationprocedure/scenario.installation.instruction.rst new file mode 100644 index 000000000..a3ddd3ac8 --- /dev/null +++ b/docs/installationprocedure/scenario.installation.instruction.rst @@ -0,0 +1,26 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) + +=================================== + installation instruction +=================================== + +Preparing the installation +-------------------------- +.. List the activities needed prior to installation and dependent feature configurations that +.. need to be is to be configured during this process. + +HW requirements +--------------- +.. A generic Pharos lab preparation instruction will be provided, this section should describe +.. scenario has any specific hardware or hardware configuration needs. + +Installation instruction +------------------------ +.. List of steps needed to install each verified installer. + +Post-installation activities +---------------------------- +.. List the activities needed post installation. + diff --git a/docs/installationprocedure/scenario.release.notes.rst b/docs/installationprocedure/scenario.release.notes.rst new file mode 100644 index 000000000..545e1d9bf --- /dev/null +++ b/docs/installationprocedure/scenario.release.notes.rst @@ -0,0 +1,132 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) + +================================================= +Release Note for the Brahmaputra release of OPNFV +================================================= + +.. toctree:: + :maxdepth: 2 + +Abstract +======== + +This document compiles the release notes for the Brahmaputra release of +OPNFV when using as a deployment tool. + +Introduction +============ + +Provide a breif introduction of how this release is used in OPNFV relese using as a deployment tool + +Be sure to reference your installation-instructions. + +Release Data +============ + ++--------------------------------------+--------------------------------------+ +| **Project** | | +| | | ++--------------------------------------+--------------------------------------+ +| **Repo/tag** | | +| | | ++--------------------------------------+--------------------------------------+ +| **Release designation** | | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | | +| | | ++--------------------------------------+--------------------------------------+ +| **Purpose of the delivery** | | +| | | ++--------------------------------------+--------------------------------------+ + +Deliverables +------------ + +Software deliverables +~~~~~~~~~~~~~~~~~~~~~ +-based installer iso file + +Documentation deliverables +~~~~~~~~~~~~~~~~~~~~~~~~~~ +- + +Version change +-------------- +.. This section describes the changes made since the last version of this document. + +Module version change +~~~~~~~~~~~~~~~~~~~~~ + +Document version change +~~~~~~~~~~~~~~~~~~~~~~~ + +Reason for new version +---------------------- + +Feature additions +~~~~~~~~~~~~~~~~~ + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| JIRA: | | +| | | ++--------------------------------------+--------------------------------------+ +| JIRA: | | +| | | ++--------------------------------------+--------------------------------------+ + +Bug corrections +~~~~~~~~~~~~~~~ + +**JIRA TICKETS:** + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| JIRA: | | +| | | ++--------------------------------------+--------------------------------------+ + + +Known Limitations, Issues and Workarounds +========================================= + +System Limitations +------------------ + +Known issues +------------ + +**JIRA TICKETS:** + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| JIRA: | | ++--------------------------------------+--------------------------------------+ +| JIRA: | | ++--------------------------------------+--------------------------------------+ + + +Workarounds +----------- +See JIRA: + + +Test Result +=========== +Brahmaputra test result using as deployment tool. + + +References +========== +For more information on the OPNFV Brahmaputra release, please visit +http://www.opnfv.org/brahmaputra + diff --git a/docs/release-notes/index.rst b/docs/release-notes/index.rst deleted file mode 100644 index c8cad46f4..000000000 --- a/docs/release-notes/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International Licence. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) - -======================= - Release Notes -======================= - -.. toctree:: - :numbered: - :maxdepth: 4 - - release-notes.rst - diff --git a/docs/release-notes/release-notes.rst b/docs/release-notes/release-notes.rst deleted file mode 100644 index 545e1d9bf..000000000 --- a/docs/release-notes/release-notes.rst +++ /dev/null @@ -1,132 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) - -================================================= -Release Note for the Brahmaputra release of OPNFV -================================================= - -.. toctree:: - :maxdepth: 2 - -Abstract -======== - -This document compiles the release notes for the Brahmaputra release of -OPNFV when using as a deployment tool. - -Introduction -============ - -Provide a breif introduction of how this release is used in OPNFV relese using as a deployment tool - -Be sure to reference your installation-instructions. - -Release Data -============ - -+--------------------------------------+--------------------------------------+ -| **Project** | | -| | | -+--------------------------------------+--------------------------------------+ -| **Repo/tag** | | -| | | -+--------------------------------------+--------------------------------------+ -| **Release designation** | | -| | | -+--------------------------------------+--------------------------------------+ -| **Release date** | | -| | | -+--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | | -| | | -+--------------------------------------+--------------------------------------+ - -Deliverables ------------- - -Software deliverables -~~~~~~~~~~~~~~~~~~~~~ --based installer iso file - -Documentation deliverables -~~~~~~~~~~~~~~~~~~~~~~~~~~ -- - -Version change --------------- -.. This section describes the changes made since the last version of this document. - -Module version change -~~~~~~~~~~~~~~~~~~~~~ - -Document version change -~~~~~~~~~~~~~~~~~~~~~~~ - -Reason for new version ----------------------- - -Feature additions -~~~~~~~~~~~~~~~~~ - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: | | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: | | -| | | -+--------------------------------------+--------------------------------------+ - -Bug corrections -~~~~~~~~~~~~~~~ - -**JIRA TICKETS:** - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: | | -| | | -+--------------------------------------+--------------------------------------+ - - -Known Limitations, Issues and Workarounds -========================================= - -System Limitations ------------------- - -Known issues ------------- - -**JIRA TICKETS:** - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: | | -+--------------------------------------+--------------------------------------+ -| JIRA: | | -+--------------------------------------+--------------------------------------+ - - -Workarounds ------------ -See JIRA: - - -Test Result -=========== -Brahmaputra test result using as deployment tool. - - -References -========== -For more information on the OPNFV Brahmaputra release, please visit -http://www.opnfv.org/brahmaputra - diff --git a/docs/testframework/framework.installation.procedure.render.rst b/docs/testframework/framework.installation.procedure.render.rst new file mode 100644 index 000000000..8eaa57d12 --- /dev/null +++ b/docs/testframework/framework.installation.procedure.render.rst @@ -0,0 +1,10 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) + + preparation and installation +============================================= + +.. Explain how to prepare for and install the test framework. +.. Need to identify the target structure of this document with the testing WG + diff --git a/docs/testframework/framework.userguide.render.rst b/docs/testframework/framework.userguide.render.rst new file mode 100644 index 000000000..3f9993c13 --- /dev/null +++ b/docs/testframework/framework.userguide.render.rst @@ -0,0 +1,10 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) + + userguide and reporting document +================================================= + +.. Explain how to use the test framework and read reports/results. +.. Need to identify the target structure of this document with the testing WG + diff --git a/docs/testframework/index.rst b/docs/testframework/index.rst new file mode 100644 index 000000000..16521c141 --- /dev/null +++ b/docs/testframework/index.rst @@ -0,0 +1,16 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Christopher Price (Ericsson AB) + +***************************** +OPNFV Test Framework document +***************************** + +.. toctree:: + :maxdepth: 2 + + ./abstract + ./opnfv.testframework.overview + ./framework.installation.procedure.render + ./framework.userguide.render + diff --git a/docs/testframework/opnfv.testframework.overview.rst b/docs/testframework/opnfv.testframework.overview.rst new file mode 100644 index 000000000..92cc88685 --- /dev/null +++ b/docs/testframework/opnfv.testframework.overview.rst @@ -0,0 +1,17 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Christopher Price (Ericsson AB) + +================================== +Using the test frameworks in OPNFV +================================== + +Testing is one of the key activities in OPNFV, validation can include component level testing, +system testing, automated deployment validation and performance characteristics testing. + +The following section outlines how to use the test projects that are delivered on the +OPNFV platform for the purpose of testing components and VNFs in the context of a +Brahmaputra deployment. + +Needs to be completed according to the testing WG needs. + diff --git a/docs/userguide/common.platform.render.rst b/docs/userguide/common.platform.render.rst new file mode 100644 index 000000000..1235c8f77 --- /dev/null +++ b/docs/userguide/common.platform.render.rst @@ -0,0 +1,26 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Christopher Price (Ericsson AB) + +================================ +Using common platform components +================================ + +This section outlines basic usage principals and methods for some of the commonly deployed +components of supported OPNFV scenario's in Brahmaputra. +The subsections provide an outline of how these components are commonly used and how to address them +in an OPNFV deployment. The components derive from autonomous upstream communities and where possible +this guide will provide direction to the relevant documentation made available by those communities +to better help you navigate the OPNFV deployment. + +Common VIM components +===================== + +.. include:: ./openstack.rst + +Common SDN components +===================== + +.. include:: ./opendaylight.rst +.. include:: ./onos.rst + diff --git a/docs/userguide/feature-usage.rst b/docs/userguide/feature-usage.rst deleted file mode 100644 index fa1186dc6..000000000 --- a/docs/userguide/feature-usage.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Christopher Price (Ericsson AB) - -========================== -Using Brahmaputra Features -========================== - -The following sections of the user guide provide feature specific usage guidelines and references. -Providing users the necessary information to leveraging the features in the platform, -some operation in this section may refer back to the guides in the general system usage section. - -.. /docs/userguide/featureusage.rst files will be imported below by the build script. - - diff --git a/docs/userguide/feature.userguide.render.rst b/docs/userguide/feature.userguide.render.rst new file mode 100644 index 000000000..fa1186dc6 --- /dev/null +++ b/docs/userguide/feature.userguide.render.rst @@ -0,0 +1,15 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Christopher Price (Ericsson AB) + +========================== +Using Brahmaputra Features +========================== + +The following sections of the user guide provide feature specific usage guidelines and references. +Providing users the necessary information to leveraging the features in the platform, +some operation in this section may refer back to the guides in the general system usage section. + +.. /docs/userguide/featureusage.rst files will be imported below by the build script. + + diff --git a/docs/userguide/feature.userguide.template.rst b/docs/userguide/feature.userguide.template.rst new file mode 100644 index 000000000..f133134df --- /dev/null +++ b/docs/userguide/feature.userguide.template.rst @@ -0,0 +1,12 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) + + capabilities and usage +================================ +Describe the specific capabilities and usage for feature. + + +----------------------------------------------- +Describe with examples how to use specfic features. + diff --git a/docs/userguide/featureusage.rst b/docs/userguide/featureusage.rst deleted file mode 100644 index f133134df..000000000 --- a/docs/userguide/featureusage.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) - - capabilities and usage -================================ -Describe the specific capabilities and usage for feature. - - ------------------------------------------------ -Describe with examples how to use specfic features. - diff --git a/docs/userguide/general-system.rst b/docs/userguide/general-system.rst deleted file mode 100644 index 1235c8f77..000000000 --- a/docs/userguide/general-system.rst +++ /dev/null @@ -1,26 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Christopher Price (Ericsson AB) - -================================ -Using common platform components -================================ - -This section outlines basic usage principals and methods for some of the commonly deployed -components of supported OPNFV scenario's in Brahmaputra. -The subsections provide an outline of how these components are commonly used and how to address them -in an OPNFV deployment. The components derive from autonomous upstream communities and where possible -this guide will provide direction to the relevant documentation made available by those communities -to better help you navigate the OPNFV deployment. - -Common VIM components -===================== - -.. include:: ./openstack.rst - -Common SDN components -===================== - -.. include:: ./opendaylight.rst -.. include:: ./onos.rst - diff --git a/docs/userguide/test-usage.rst b/docs/userguide/test-usage.rst deleted file mode 100644 index 423a3069d..000000000 --- a/docs/userguide/test-usage.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Christopher Price (Ericsson AB) - -================================== -Using the test frameworks in OPNFV -================================== - -Testing is one of the key activities in OPNFV, validation can include component level testing, -system testing, automated deployment validation and performance characteristics testing. - -The following section outlines how to use the test projects that are delivered on the -OPNFV platform for the purpose of testing components and VNFs in the context of a -Brahmaputra deployment. - -.. /docs/userguide/testusage.rst files will be imported below by the build script. - diff --git a/docs/userguide/testusage.rst b/docs/userguide/testusage.rst deleted file mode 100644 index 9f9bdc9de..000000000 --- a/docs/userguide/testusage.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) - - capabilities and usage -================================ -Describe the specific capabilities and usage for testing. - - --------------------------------------- -Describe with examples how to use specfic test frameworks. - -- cgit 1.2.3-korg