diff options
Diffstat (limited to 'docs')
18 files changed, 764 insertions, 22 deletions
diff --git a/docs/development/templates/intregration/index.rst b/docs/development/templates/integration/index.rst index 2e7dd06d3..2e7dd06d3 100644 --- a/docs/development/templates/intregration/index.rst +++ b/docs/development/templates/integration/index.rst diff --git a/docs/how-to-use-docs/include-documentation.rst b/docs/how-to-use-docs/include-documentation.rst new file mode 100644 index 000000000..8ad1a2753 --- /dev/null +++ b/docs/how-to-use-docs/include-documentation.rst @@ -0,0 +1,66 @@ + +============================================= +OPNFV User guide documentation instruction +============================================= + +Including your Documentation +------------------------------ + +Add your documentation to your repository in the folder structure and according to the template listed above. The documentation template you will require are available in the opnfvdocs repository, you should copy the relevant templates to the /docs/userguide directory in your repository. For instance if I wanted to document enabling my feature set in the platform I would follow an example like: + +.. code-block:: bash + mkdir <my_repo>/docs/userguide + git clone ssh://<your_id>@gerrit.opnfv.org:29418/opnfvdocs.git + cp opnfvdocs/docs/userguide/userguide.rst <my_repo>/docs/userguide + + +You should then add the relevant information to the template that will explain the usage of your feature and instructions for validating that the feature was used successfully like checking the results of specific test cases. Be sure to maintain the creative commons license from the template and ensure all your documentation files include the license information. + +Once your documentation is ready you should ensure they are compiled into the staging files by adding them to the master <section>.rst file in the opnfvdocs repository. The staging files are structured in such a way that you should refer to your document in the correct section of the document structure. + +An example of how to add your documentation to the relevant sections of the feature-usage.rst file might be: + +.. code-block:: bash + git clone ssh://<your_id>@gerrit.opnfv.org:29418/opnfvdocs.git + cd opnfvdocs + git review -s + vim docs/userguide/feature-usage.rst ' + + +At this point you should add the references to your files into the index.rst file, for instance in the feature description section you would add the line: +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. + +.. code-block:: bash +.. include:: ../projects/promise/userguide/userguide.rst +.. include:: ../projects/copper/userguide/userguide.rst Using Brahmaputra Features +.. include:: ../projects/<my_repo>/userguide/userguide.rst'' + + +If this is the first contribution from your project to the composite document files you will need to add your project to the build-composite.sh file in the opnfvdocs directory. This is done my editing the jsdgf file and adding your repository name to the get_repo_names() function of the script. Assuming you are still in the opnfvdocs directory edit the file with the following command: +' vim build-composite.sh ' + + +Once you have the file open, add your projects repository to the get_repo_names() function: + +.. code-block:: python + get_repo_names() { + # NOTE: Not all repositories are ready for the composite docs, + # so we have the repo name list here to add project docs + # one by one. This will be replaced by the list in project.cfg . + # grep -v '^#' releng/jjb/opnfvdocs/project.cfg | sort + echo "sdnvpn" + echo "<my_repo>" + + +Once you have made these changes you need to push the patch back to the opnfvdocs team for review and integration. + +.. code-block:: bash + ' git add . ' + ' git commit --signoff --all ' + ' git review ' + + + +Be sure to add the project leader of the opnfvdocs project as a reviewer of the change you just pushed in gerrit. Also be aware that once the text is available in the context of the broader release document it may require some revising and editorial work to prepare it for release. diff --git a/docs/development/templates/scenario/index.rst b/docs/release/templates/scenario/index.rst index 44605fe7a..44605fe7a 100644 --- a/docs/development/templates/scenario/index.rst +++ b/docs/release/templates/scenario/index.rst diff --git a/docs/development/templates/scenario/scenario.description.rst b/docs/release/templates/scenario/scenario.description.rst index 36098fd2f..36098fd2f 100644 --- a/docs/development/templates/scenario/scenario.description.rst +++ b/docs/release/templates/scenario/scenario.description.rst diff --git a/docs/templates/developer/overview/index.rst b/docs/templates/developer/overview/index.rst new file mode 100644 index 000000000..caf4dfc70 --- /dev/null +++ b/docs/templates/developer/overview/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) OPNFV, Ericsson AB and others. + +============================================= +OPNFV <Project Name> <Release Name> Overview +============================================= + +For example, the title might be "Qtip Danube Overview" + +.. toctree:: + :maxdepth: 1 + + overview diff --git a/docs/templates/developer/overview/overview.rst b/docs/templates/developer/overview/overview.rst new file mode 100644 index 000000000..498dc0662 --- /dev/null +++ b/docs/templates/developer/overview/overview.rst @@ -0,0 +1,16 @@ +============================================== +OPNFV <Release Name> <Project Name> Overview +============================================== + +.. contents:: + :depth: 3 + :local: + +Introduction +---------------- +Describing the components and behaviours in a manner that helps people understand the platform and how to work with it + +Upgrades from <Previous Release> +----------------------------------- +<optional, required if there's a previous release for the project> +Describe the new features diff --git a/docs/templates/release/configguide/featureconfig.rst b/docs/templates/release/configguide/featureconfig.rst new file mode 100644 index 000000000..8c063f06d --- /dev/null +++ b/docs/templates/release/configguide/featureconfig.rst @@ -0,0 +1,32 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +======================== +<Project> 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. + +.. contents:: + :depth: 3 + :local: + +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/templates/release/configguide/index.rst b/docs/templates/release/configguide/index.rst new file mode 100644 index 000000000..9c940eb1a --- /dev/null +++ b/docs/templates/release/configguide/index.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 + +========================================================= +OPNFV <Project Name> Configuration Guide +========================================================= + +.. toctree:: + :maxdepth: 1 + + featureconfig + postinstall diff --git a/docs/templates/release/configguide/postinstall.rst b/docs/templates/release/configguide/postinstall.rst new file mode 100644 index 000000000..51981a124 --- /dev/null +++ b/docs/templates/release/configguide/postinstall.rst @@ -0,0 +1,35 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +======================================= +<Project> Post Installation Procedure +======================================= + +Add a brief introduction to the methods of validating the installation +according to this specific installer or feature. + +.. contents:: + :depth: 3 + :local: + +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. + +<Project> 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/templates/release/installation/index.rst b/docs/templates/release/installation/index.rst new file mode 100644 index 000000000..fe0134112 --- /dev/null +++ b/docs/templates/release/installation/index.rst @@ -0,0 +1,11 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +================================================== +OPNFV <Project Name> Installation +================================================== + +.. toctree:: + :maxdepth: 1 + + installation.instruction diff --git a/docs/templates/release/installation/installation.instruction.rst b/docs/templates/release/installation/installation.instruction.rst new file mode 100644 index 000000000..c9476095e --- /dev/null +++ b/docs/templates/release/installation/installation.instruction.rst @@ -0,0 +1,203 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +========================================= +OPNFV <Project Name> Installation Guide +========================================= + +This document describes how to install <Component>, it's dependencies and required system resources. + +.. contents:: + :depth: 3 + :local: + +Version history +--------------------- + ++--------------------+--------------------+--------------------+--------------------+ +| **Date** | **Ver.** | **Author** | **Comment** | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| 2015-04-14 | 0.1.0 | Jonas Bjurel | First draft | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| | 0.1.1 | | | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| | 1.0 | | | +| | | | | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ + +Introduction +------------------- +<INTRODUCTION TO THE SCOPE AND INTENTION OF THIS DOCUMENT AS WELL AS TO THE SYSTEM TO BE INSTALLED> + +<EXAMPLE>: + +This document describes the supported software and hardware configurations for the +Fuel OPNFV reference platform as well as providing guidelines on how to install and +configure such reference system. + +Although the available installation options gives a high degree of freedom in how the system is set-up, +with what architecture, services and features, etc., not nearly all of those permutations provides +a OPNFV compliant reference architecture. Following the guidelines in this document ensures +a result that is OPNFV compliant. + +The audience of this document is assumed to have good knowledge in network and Unix/Linux administration. + +Preface +------------- +<DESCRIBE NEEDED PREREQUISITES, PLANNING, ETC.> + +<EXAMPLE>: + +Before starting the installation of Fuel@OPNFV, some planning must preceed. + +First of all, the Fuel@OPNFV .iso image needs to be retrieved, +the Latest stable Arno release of Fuel@OPNFV can be found here: <www.opnfv.org/abc/def> + +Alternatively, you may build the .iso from source by cloning the opnfv/genesis git repository: +<git clone https://<linux foundation uid>@gerrit.opnf.org/gerrit/genesis> +Check-out the Arno release: +<cd genesis; git checkout arno> +Goto the fuel directory and build the .iso +<cd fuel/build; make all> + +Familiarize yourself with the Fuel 6.0.1 version by reading the following documents: +- abc <http://wiki.openstack.org/abc> +- def <http://wiki.openstack.org/def> +- ghi <http://wiki.openstack.org/ghi> + +Secondly, a number of deployment specific parameters must be collected, those are: + +1. Provider sub-net and gateway information + +2. Provider VLAN information + +3. Provider DNS addresses + +4. Provider NTP addresses + +This information will be needed for the configuration procedures provided in this document. + +Hardware requirements +------------------------ +<PROVIDE A LIST OF MINIMUM HARDWARE REQUIREMENTS NEEDED FOR THE INSTALL> + +<EXAMPLE>: + +Following minimum hardware requirements must be met for installation of Fuel@OPNFV: + ++--------------------+----------------------------------------------------+ +| **HW Aspect** | **Requirement** | +| | | ++--------------------+----------------------------------------------------+ +| **# of servers** | Minimum 5 (3 for non redundant deployment) | +| | 1 Fuel deployment master (may be virtualized) | +| | 3(1) Controllers | +| | 1 Compute | ++--------------------+----------------------------------------------------+ +| **CPU** | Minimum 1 socket x86_AMD64 Ivy bridge 1.6 GHz | +| | | ++--------------------+----------------------------------------------------+ +| **RAM** | Minimum 16GB/server (Depending on VNF work load) | +| | | ++--------------------+----------------------------------------------------+ +| **Disk** | Minimum 256GB 10kRPM spinning disks | +| | | ++--------------------+----------------------------------------------------+ +| **NICs** | 2(1)x10GE Niantec for Private/Public (Redundant) | +| | | +| | 2(1)x10GE Niantec for SAN (Redundant) | +| | | +| | 2(1)x1GE for admin (PXE) and control (RabitMQ,etc) | +| | | ++--------------------+----------------------------------------------------+ + +Top of the rack (TOR) Configuration requirements +--------------------------------------------------- +<DESCRIBE NEEDED NETWORK TOPOLOGY SETUP IN THE TORs> + +<EXAMPLE>: + +The switching infrastructure provides connectivity for the OPNFV infra-structure operations as well as +for the tenant networks (East/West) and provider connectivity (North/South bound connectivity). +The switching connectivity can (but does not need to) be fully redundant, +in case it and comprises a redundant 10GE switch pair for "Traffic/Payload/SAN" purposes as well as +a 1GE switch pair for "infrastructure control-, management and administration" + +The switches are **not** automatically configured from the OPNFV reference platform. +All the networks involved in the OPNFV infra-structure as well as the provider networks +and the private tenant VLANs needs to be manually configured. + +This following sections guides through required black-box switch configurations. + +VLAN considerations and blue-print +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +IP Address plan considerations and blue-print +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +OPNFV Software installation and deployment +-------------------------------------------- +<DESCRIBE THE FULL PROCEDURES FOR THE INSTALLATION OF THE OPNFV COMPONENT INSTALLATION AND DEPLOYMENT> + +<EXAMPLE>: + +This section describes the installation of the Fuel@OPNFV installation server (Fuel master) +as well as the deployment of the full OPNFV reference platform stack across a server cluster. +Etc. + +Install Fuel master +^^^^^^^^^^^^^^^^^^^^^ + +Create an OPNV (Fuel Environment) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Configure the OPNFV environment +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Deploy the OPNFV environment +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Installation health-check +--------------------------- +<DESCRIBE ANY MEANS TO DO VERIFY THE INTEGRITY AND HEALTHYNESS OF THE INSTALL> + +<EXAMPLE>: + +Now that the OPNFV environment has been created, and before the post installation configurations is started, +perform a system health check from the Fuel GUI: + +- Select the "Health check" TAB. +- Select all test-cases +- And click "Run tests" + +All test cases except the following should pass: + +Post installation and deployment actions +------------------------------------------ +<DESCRIBE ANY POST INSTALLATION ACTIONS/CONFIGURATIONS NEEDED> + +<EXAMPLE>: +After the OPNFV deployment is completed, the following manual changes needs to be performed in order +for the system to work according OPNFV standards. + +**Change host OS password:** +Change the Host OS password by...... + +References +------------- +<PROVIDE NEEDED/USEFUL REFERENCES> + +<EXAMPLES>: + +OPNFV +^^^^^^^^^^ + +OpenStack +^^^^^^^^^^^ + +OpenDaylight +^^^^^^^^^^^^^^^ diff --git a/docs/templates/release/release-notes/index.rst b/docs/templates/release/release-notes/index.rst new file mode 100644 index 000000000..a0759f77f --- /dev/null +++ b/docs/templates/release/release-notes/index.rst @@ -0,0 +1,11 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +================================================== +OPNFV <Project Name> Release Notes +================================================== + +.. toctree:: + :maxdepth: 1 + + release-notes diff --git a/docs/templates/release/release-notes/release-notes.rst b/docs/templates/release/release-notes/release-notes.rst new file mode 100644 index 000000000..ad6759b08 --- /dev/null +++ b/docs/templates/release/release-notes/release-notes.rst @@ -0,0 +1,233 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +====================================================================== +OPNFV <Project Name> Release Notes +====================================================================== + +This document provides the release notes for <RELEASE> of <COMPONENT>. + +.. contents:: + :depth: 3 + :local: + + +Version history +------------------ + ++--------------------+--------------------+--------------------+--------------------+ +| **Date** | **Ver.** | **Author** | **Comment** | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| 2015-04-14 | 0.1.0 | Jonas Bjurel | First draft | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| | 0.1.1 | | | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| | 1.0 | | | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ + +Important notes +----------------- + +<STATE IMPORTANT NOTES/DEVIATIONS SINCE PREVIOUS ITERATIVE RELEASE AND OTHER IMPORTANT NOTES FOR THIS RELEASE> + +<EXAMPLE>: + +**Attention:** Please be aware that since LSV3 a pre-deploy script must be ran on the Fuel master - +see the OPNFV@Fuel SW installation instructions + +Summary +------------ + +<SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES> + +<EXAMPLE>: + +Arno Fuel@OPNFV is based the OpenStack Fuel upstream project version 6.0.1, +but adds OPNFV unique components such as OpenDaylight version: Helium as well as other OPNFV unique configurations...... + +Release Data +--------------- +<STATE RELEVANT RELEASE DATA/RECORDS> + +<EXAMPLE>: + ++--------------------------------------+--------------------------------------+ +| **Project** | E.g. Arno/genesis/fuel@opnfv | +| | | ++--------------------------------------+--------------------------------------+ +| **Repo/commit-ID** | E.g. genesis/adf634a0d4..... | +| | | ++--------------------------------------+--------------------------------------+ +| **Release designation** | E.g. Arno RC2 | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | E.g. 2015-04-16 | +| | | ++--------------------------------------+--------------------------------------+ +| **Purpose of the delivery** | E.g. OPNFV Internal quality assurance| +| | | ++--------------------------------------+--------------------------------------+ + +Version change +^^^^^^^^^^^^^^^^ + +Module version changes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +<STATE WHAT UPSTREAM, - AS WELL AS OPNFV MODULE VERSIONS HAVE CHANGED> + +<EXAMPLE>: + +- Fuel have changed from 5.1 to 6.0.1 + +- OpenDaylight has changed from Helium-SR1 to Helium-SR2 + +Document version changes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +<STATE WHAT RELATED DOCUMENTS THAT CHANGES WITH THIS RELEASE> + +<EXAMPLE>: + +- The Fuel@OPNFV installation guide version has changed from version 0.1 to to 0.2 + +Reason for version +^^^^^^^^^^^^^^^^^^^^ +Feature additions +~~~~~~~~~~~~~~~~~~~~~~~ +<STATE ADDED FEATURES BY REFERENCE TO JIRA> + +<EXAMPLE>: + +**JIRA BACK-LOG:** + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| BGS-123 | ADD OpenDaylight ml2 integration | +| | | ++--------------------------------------+--------------------------------------+ +| BGS-456 | Add auto-deployment of Fuel@OPNFV | +| | | ++--------------------------------------+--------------------------------------+ + +Bug corrections +~~~~~~~~~~~~~~~~~~~~~ + +**JIRA TICKETS:** + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| BGS-888 | Fuel doesn't deploy | +| | | ++--------------------------------------+--------------------------------------+ +| BGS-999 | Floating IP doesn't work | +| | | ++--------------------------------------+--------------------------------------+ + +Deliverables +---------------- + +Software deliverables +^^^^^^^^^^^^^^^^^^^^^^^ + +<STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED> + +<EXAMPLE>: + +Documentation deliverables +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +<STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED> + +<EXAMPLE>: + +Known Limitations, Issues and Workarounds +-------------------------------------------- + +System Limitations +^^^^^^^^^^^^^^^^^^^^ +<STATE ALL RELEVANT SYSTEM LIMITATIONS> + +<EXAMPLE>: + +**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:** 3800 (Needs special switch config.) + +**L3Agent:** L3 agent and floating IPs is not supported. + +Known issues +^^^^^^^^^^^^^^^ +<STATE ALL KNOWN ISSUES WITH JIRA REFERENCE> + +<EXAMPLE>: + +**JIRA TICKETS:** + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| BGS-987 | Nova-compute process does | +| | not re-spawn when killed | +| | | ++--------------------------------------+--------------------------------------+ +| BGS-654 | MOS 5.1 : neutron net-list returns | +| | "400 Bad request" | +| | | ++--------------------------------------+--------------------------------------+ + +Workarounds +^^^^^^^^^^^^^^^^^ + +<STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE> + +<EXAMPLE>: + +- In case the contact with a compute is lost - restart the compute host +- In case the disk is full on a controller - delete all files in /tmp + +Test Result +--------------- +<STATE THE QA COVERAGE AND RESULTS> + +<EXAMPLE>: + +Fuel@OPNFV Arno RC2 has undergone QA test runs with the following results: + ++--------------------------------------+--------------------------------------+ +| **TEST-SUITE** | **Results:** | +| | | ++--------------------------------------+--------------------------------------+ +| Tempest test suite 123 | Following tests failed: | +| | | +| | 1. Image resizing.... | +| | | +| | 2. Heat deploy.... | ++--------------------------------------+--------------------------------------+ +| Robot test suite 456 | Following tests failed: | +| | | +| | 1....... | +| | | +| | 2....... | ++--------------------------------------+--------------------------------------+ + +References +------------ +<STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION> + +<EXAMPLE>: + +For more information on the OPNFV Danube release, please see: + +http://opnfv.org/danube diff --git a/docs/templates/release/scenarios/scenario.name/index.rst b/docs/templates/release/scenarios/scenario.name/index.rst new file mode 100644 index 000000000..7487e63bd --- /dev/null +++ b/docs/templates/release/scenarios/scenario.name/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) <optionally add copywriters name> + +================== +<scenario name> +================== +.. This document will be used to provide a description of the scenario for an end user. +.. You should explain the purpose of the scenario, the types of capabilities provided and +.. the unique components that make up the scenario including how they are used. + +.. toctree:: + :maxdepth: 1 + + scenario.description + diff --git a/docs/templates/release/scenarios/scenario.name/scenario.description.rst b/docs/templates/release/scenarios/scenario.name/scenario.description.rst new file mode 100644 index 000000000..9c45b7da4 --- /dev/null +++ b/docs/templates/release/scenarios/scenario.name/scenario.description.rst @@ -0,0 +1,42 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) <optionally add copywriters name> + +========================= +OPNFV <Scenario Name> +========================= + +This document provides scenario level details for <RELEASE> of <COMPONENT>. + +.. contents:: + :depth: 3 + :local: + +Introduction +--------------- +.. In this section explain the purpose of the scenario and the types of capabilities provided + +Scenario components and composition +------------------------------------- +.. In this section describe the unique components that make up the scenario, +.. what each component provides and why it has been included in order +.. to communicate to the user the capabilities available in this scenario. + +Scenario usage overview +---------------------------- +.. Provide a brief overview on how to use the scenario and the features available to the +.. user. This should be an "introduction" to the userguide document, and explicitly link to it, +.. where the specifics of the features are covered including examples and API's + +Limitations, Issues and Workarounds +--------------------------------------- +.. Explain scenario limitations here, this should be at a design level rather than discussing +.. faults or bugs. If the system design only provide some expected functionality then provide +.. some insight at this point. + +References +----------------- + +For more information on the OPNFV Danube release, please visit +http://www.opnfv.org/danube + diff --git a/docs/templates/release/userguide/feature.userguide.rst b/docs/templates/release/userguide/feature.userguide.rst new file mode 100644 index 000000000..733c2f99a --- /dev/null +++ b/docs/templates/release/userguide/feature.userguide.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) <optionally add copywriters name> + +=================================== +OPNFV <Project Name> User Guide +=================================== + +.. contents:: + :depth: 3 + :local: + +<Feature> 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. + +<Feature> capabilities and usage +------------------------------------ +.. Describe the specific capabilities and usage for <XYZ> feature. +.. Provide enough information that a user will be able to operate the feature on a deployed scenario. + +<Feature and API usage guidelines and example> +----------------------------------------------- +.. 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/templates/release/userguide/index.rst b/docs/templates/release/userguide/index.rst new file mode 100644 index 000000000..5fec00019 --- /dev/null +++ b/docs/templates/release/userguide/index.rst @@ -0,0 +1,23 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) <optionally add copywriters name> + +===================== +<Feature> User Guide +===================== + +.. The feature user guide should provide an OPNFV user with enough information to +.. use the features provided by the feature project in the supported scenarios. +.. This guide should walk a user through the usage of the features once a scenario +.. has been deployed and is active according to the installation guide provided +.. by the installer project. + +.. toctree:: + :maxdepth: 1 + + feature.userguide +.. The feature.userguide.rst file should contain the text for this document +.. additional documents can be added to this directory and added in the right order +.. to this file as a list below. + + diff --git a/docs/testing/ecosystem/overview.rst b/docs/testing/ecosystem/overview.rst index 940e720ab..ffd4c597d 100644 --- a/docs/testing/ecosystem/overview.rst +++ b/docs/testing/ecosystem/overview.rst @@ -8,18 +8,20 @@ OPNFV testing Introduction ============ -Testing is one of the key activities in OPNFV, including component level testing, -system testing, automated deployment validation and performance characteristics -or stress testing. +Testing is one of the key activities in OPNFV and includes unit, feature, component, system +level testing for development, automated deployment, performance characterization or stress +testing. -Some projects are fully dedicated to testing, they provide frameworks or tooling. -The feature projects also include their own test suites. -he test projects fulfill different roles (such as functional checks, performance -measurement, platform and component benchmarks, and analysis) on the scenarios -released in OPNFV. +Test projects are dedicated to provide frameworks, tooling and test-cases catagorized as +functional, performance or compliance testing. Test projects fulfill different roles such as +verifying VIM functionality, benchmarking components and platforms or analysis of measured +KPIs for the scenarios released in OPNFV. -This document will detail the OPNFV testing ecosystem, describe the commons used -by the projects and provide the links to project specific documentation. +Feature projects also provide their own test suites that either run independently or within a +test project. + +This document details the OPNFV testing ecosystem, describes test commonality used +by the projects and provides links to project specific documentation. OPNFV testing ecosystem @@ -34,7 +36,7 @@ The OPNFV testing projects may be summarized as follows: :align: center :alt: Overview of OPNFV Testing projects -The main projects of the testing projects are described in the table below: +The major testing projects are described in the table below: +----------------+---------------------------------------------------------+ | Project | Description | @@ -46,8 +48,8 @@ The main projects of the testing projects are described in the table below: | | production environment, an automatic method for | | | executing benchmarks which plans to validate the | | | deployment during staging is adopted. This project | -| | provides a framework to find the bottlenecks of OPNFV | -| | infrastructure. | +| | forms a staging framework to find bottlenecks and to do | +| | analysis of the OPNFV infrastructure. | +----------------+---------------------------------------------------------+ | CPerf | SDN Controller benchmarks and performance testing, | | | applicable to controllers in general. | @@ -86,15 +88,13 @@ The main projects of the testing projects are described in the table below: | | pass/fail thresholds for test, staging, and production | | | NFVI environments. | +----------------+---------------------------------------------------------+ -| VSperf | The Project “vSwitch Performance" develops a generic and| -| | architecture agnostic vSwitch testing framework and | -| | associated tests, that will serve as a basis for | -| | validating the suitability of different vSwitch | -| | implementations in a Telco NFV deployment environment. | -| | The output of this project will be utilized by the OPNFV| -| | Performance and Test group and its associated projects, | -| | as part of OPNFV Platform and VNF level testing and | -| | validation. | +| VSperf | This project provides a framework for automation of NFV | +| | data-plane performance testing and benchmarking. The | +| | NFVI fast-path includes switch technology and network | +| | with physical and virtual interfaces. Vsperf can be | +| | used to evaluate the suitability of different Switch | +| | implementations and features, quantify data-path | +| | performance and optimize platform configurations. | +----------------+---------------------------------------------------------+ | Yardstick | The goal of the Project is to verify the infrastructure | | | compliance when running VNF applications. NFV Use Cases | |