diff options
Diffstat (limited to 'docs')
42 files changed, 205 insertions, 95 deletions
diff --git a/docs/_static/my-styles.css b/docs/_static/my-styles.css index 94e72cdb7..311306238 100644 --- a/docs/_static/my-styles.css +++ b/docs/_static/my-styles.css @@ -1,18 +1,23 @@ -body{ - font-family:"Arial", Helvetica, sans-serif; +body { + font-family: Helvetica, sans-serif; + font-size: 18px; } -.navbar-brand img { - height: 200%; - margin-top: -5%; +body a { + color: #27CCC0; } -.navbar, h1, h2, h3, h4, h5, h6 { - font-family: "Arial",sans-serif; +body a:hover { + color: #676767; +} + +.navbar-brand img { + height: 200%; + margin-top: -5%; } -.navbar-fixed-top { - top: 10px +.navbar, h1, h2, h3, h4, h5, h6 { + font-family: Helvetica, sans-serif; } .navbar-text{ @@ -25,4 +30,4 @@ body{ .navbar-form .form-control{ width: 150px; -}
\ No newline at end of file +} diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html index 08baa3ec5..975cd9813 100644 --- a/docs/_templates/layout.html +++ b/docs/_templates/layout.html @@ -2,4 +2,4 @@ {% extends "!layout.html" %} {# Custom CSS overrides #} -{% set bootswatch_css_custom = ['_static/my-styles.css'] %}
\ No newline at end of file +{% set css_files = css_files + ['_static/my-styles.css'] %} diff --git a/docs/conf.py b/docs/conf.py index 38a8c8121..9d9f28168 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -41,9 +41,9 @@ author = 'Open Platform for NFV' # built documents. # # The short X.Y version. -version = 'Danube' +version = 'Latest' # The full version, including alpha/beta/rc tags. -release = 'Danube' +release = 'Latest' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/how-to-use-docs/documentation-guide.rst b/docs/how-to-use-docs/documentation-guide.rst index 3a3b0c40d..56bf273bc 100644 --- a/docs/how-to-use-docs/documentation-guide.rst +++ b/docs/how-to-use-docs/documentation-guide.rst @@ -66,6 +66,7 @@ Following representation shows the expected structure: │ ├── developer │ └── user └── infrastructure + ├── hardware-infrastructure ├── software-infrastructure ├── continuous-integration └── cross-community-continuous-integration @@ -139,4 +140,5 @@ You are encouraged to establish the following basic structure for your project a Infrastructure Documentation ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Infrastructure documentation can be stored under code:`<repo>/docs/infrastructure/` folder. +Infrastructure documentation can be stored under :code:`<repo>/docs/` folder of +corresponding infrastructure project. diff --git a/docs/index.rst b/docs/index.rst index c5ca8364a..2f6080412 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -50,3 +50,7 @@ Infrastructure .. toctree:: :maxdepth: 1 + + infrastructure/overview + infrastructure/ci + infrastructure/xci diff --git a/docs/infrastructure/ci.rst b/docs/infrastructure/ci.rst new file mode 100644 index 000000000..c779ffcbe --- /dev/null +++ b/docs/infrastructure/ci.rst @@ -0,0 +1,11 @@ +.. _ci: + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) Open Platform for NFV Project, Inc. and its contributors + +====================== +Continuous Integration +====================== + +TBD diff --git a/docs/infrastructure/hardware-infrastructure.rst b/docs/infrastructure/hardware-infrastructure.rst new file mode 100644 index 000000000..f800cdb05 --- /dev/null +++ b/docs/infrastructure/hardware-infrastructure.rst @@ -0,0 +1,11 @@ +.. _hardware-infrastructure: + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) Open Platform for NFV Project, Inc. and its contributors + +======================= +Hardware Infrastructure +======================= + +TBD diff --git a/docs/infrastructure/overview.rst b/docs/infrastructure/overview.rst index e80838628..1d503f9b3 100644 --- a/docs/infrastructure/overview.rst +++ b/docs/infrastructure/overview.rst @@ -1,14 +1,49 @@ -.. _opnfv-overview: +.. _overview: .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. SPDX-License-Identifier: CC-BY-4.0 .. (c) Open Platform for NFV Project, Inc. and its contributors ======================= -Infrastructure overview +Infrastructure Overview ======================= -Introduction -============ +OPNFV develops, operates, and maintains infrastructure which is used by the OPNFV +Community for development, integration, and testing purposes. `OPNFV +Infrastructure Working Group (Infra WG) <https://wiki.opnfv.org/display/INF>`_ +oversees the OPNFV Infrastructure, ensures it is kept in a state which serves +the community in best possible way and always up to date. + +Infra WG is working towards a model whereby we have a seamless pipeline +for handing resource requests from the OPNFV community for both development and +Continuous Integration perspectives. Automation of requests and integration to +existing automation tools is a primary driver in reaching this model. In the +Infra WG, we imagine a model where the Infrastructure Requirements that are +specified by a Feature, Installer or otherrelevant projects within OPNFV are +requested, provisioned, used, reported on and subsequently torn down with no (or +minimal) user intervention at the physical/infrastructure level. + +Objectives of the Infra WG are + +* Deliver efficiently dimensions resources to OPNFV community needs on request in a timely manner that ensure maximum usage (capacity) and maximum density (distribution of workloads) +* Satisfy the needs of the twice-yearly release projects, this includes being able to handle load (amount of projects and requests) as well as need (topology and different layouts) +* Support OPNFV community users. As the INFRA group, we are integral to all aspects of the OPNFV Community (since it starts with the Hardware) - this can mean troubleshooting any element within the stack +* Provide a method to expand and adapt as OPNFV community needs grow and provide this to Hosting Providers (lab providers) for input in growth forecast so they can better judge how best to contribute with their resources. +* Work with reporting and other groups to ensure we have adequate feedback to the end-users of the labs on how their systems, code, feature performs. + +The details of what is provided as part of the infrastructure can be seen in following chapters. + +Hardware Infrastructure +----------------------- TBD + +Software Infrastructure +----------------------- + +TBD + +.. toctree:: + :maxdepth: 1 + + ../submodules/releng/docs/sofware-infrastructure-index diff --git a/docs/infrastructure/software-infrastructure.rst b/docs/infrastructure/software-infrastructure.rst new file mode 100644 index 000000000..5c7158316 --- /dev/null +++ b/docs/infrastructure/software-infrastructure.rst @@ -0,0 +1,11 @@ +.. _software-infrastructure: + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) Open Platform for NFV Project, Inc. and its contributors + +======================= +Software Infrastructure +======================= + +TBD diff --git a/docs/infrastructure/xci.rst b/docs/infrastructure/xci.rst new file mode 100644 index 000000000..fe4eaf9de --- /dev/null +++ b/docs/infrastructure/xci.rst @@ -0,0 +1,16 @@ +.. _xci: + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) Open Platform for NFV Project, Inc. and its contributors + +============================================ +Cross Community Continuous Integration - XCI +============================================ + +Please see the details of XCI from the chapters below. + +- :ref:`XCI Overview <xci-overview>` +- :ref:`XCI Way of Working <xci-wow>` +- :ref:`XCI Sandbox and User Guide <xci-user-guide>` +- :ref:`XCI Developer Guide <xci-developer-guide>` diff --git a/docs/release/installation.introduction.rst b/docs/release/installation.introduction.rst index cc43aa199..cdf1479b2 100644 --- a/docs/release/installation.introduction.rst +++ b/docs/release/installation.introduction.rst @@ -2,19 +2,19 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. SPDX-License-Identifier: CC-BY-4.0 -.. (c) Sofia Wallin Ericsson AB +.. (c) Sofia Wallin Ericsson AB and other contributors -============= +============ Installation -============= +============ Abstract ======== -This document provides an overview of the installation of the Danube release of OPNFV. +This an overview document for the installation of the Euphrates release of OPNFV. -The Danube release can be installed making use of any of the installer projects in OPNFV: -Apex, Compass4Nfv, Fuel or JOID. Each installer provides the ability to install a common OPNFV +The Euphrates release can be installed making use of any of the installer projects in OPNFV: +Apex, Compass4Nfv, Daisy4NFV, Fuel or JOID. Each installer provides the ability to install a common OPNFV platform as well as integrating additional features delivered through a variety of scenarios by the OPNFV community. @@ -23,7 +23,7 @@ Introduction ============ The OPNFV platform is comprised of a variety of upstream components that may be deployed on your -infrastructure. A composition of components, tools and configurations is identified in OPNFV as a +infrastructure. A composition of components, tools and configurations is identified in OPNFV as a deployment scenario. The various OPNFV scenarios provide unique features and capabilities that you may want to leverage, and @@ -45,20 +45,16 @@ solving specific problems for the deployment of VNF’s. A scenario may, for instance, include components such as OpenStack, OpenDaylight, OVS, KVM etc., where each scenario will include different source components or configurations. -To learn more about the scenarios supported in the Danube release refer to the scenario +To learn more about the scenarios supported in the Euphrates release refer to the scenario description documents provided: - :ref:`os-nosdn-kvm-ha <kvmfornfv-os-nosdn-kvm-ha>` - :ref:`os-nosdn-kvm_ovs_dpdk-noha <kvmfornfv-os-nosdn-kvm_nfv_ovs_dpdk-noha>` -- :ref:`os-nosdn-kvm_ovs_dpdk_bar-noha <kvmfornfv-os-nosdn-kvm_nfv_ovs_dpdk_bar-noha>` -- :ref:`os-odl_l3-fdio-noha <os-odl_l3-fdio-noha>` -- :ref:`os-odl_l2-fdio-ha <os-odl_l2-fdio-ha>` -- :ref:`os-odl_l2-fdio-noha <os-odl_l2-fdio-noha>` +- :ref:`os-odl-fdio-ha <os-odl-fdio-ha>` +- :ref:`os-odl-fdio-noha <os-odl-fdio-noha>` - :ref:`os-nosdn-fdio-noha <os-nosdn-fdio-noha>` -- :ref:`os-odl_l2-bgpvpn-noha <sdnvpn-os-odl_l2-bgpvpn-noha>` -- :ref:`os-odl_l2-bgpvpn-ha <sdnvpn-os-odl_l2-bgpvpn-ha>` -- :ref:`os-odl-gluon-noha <gluon-scenario>` -- :ref:`os-nosdn-openo-ha <opera-os-nosdn-openo-ha>` +- :ref:`os-odl-bgpvpn-noha <sdnvpn-os-odl-bgpvpn-noha>` +- :ref:`os-odl-bgpvpn-ha <sdnvpn-os-odl-bgpvpn-ha>` - `os-odl_l2-sfc-ha <http://docs.opnfv.org/en/stable-danube/submodules/sfc/docs/release/scenarios/os-odl_l2-sfc-ha/index.html>`_ - `os-odl_l2-sfc-noha <http://docs.opnfv.org/en/stable-danube/submodules/sfc/docs/release/scenarios/os-odl_l2-sfc-noha/index.html>`_ - :ref:`os-nosdn-lxd-ha <os-nosdn-lxd-ha>` @@ -67,18 +63,36 @@ description documents provided: - :ref:`k8-nosdn-lb-noha <k8-nosdn-lb-noha>` - `os-nosdn-ovs-ha <http://docs.opnfv.org/en/stable-danube/submodules/ovsnfv/docs/release/scenarios/os-nosdn-ovs-ha/index.html>`_ - :ref:`os-nosdn-ovs-noha <os-nosdn-ovs-noha>` -- :ref:`os-nosdn-ovs <os-nosdn-ovs>` -- `os-odl_l3-ovs-ha <http://docs.opnfv.org/en/stable-danube/submodules/ovsnfv/docs/release/scenarios/os-odl_l3-ovs-ha/index.html>`_ -- :ref:`os-odl_l3-ovs-noha <os-odl_l3-ovs-noha>` -- :ref:`os-odl_l3-fdio-ha <os-odl_l3-fdio-ha>` - +- :ref:`os-nosdn-calipso-noha <os-nosdn-calipso-noha>` +- :ref:`os-nosdn-ovs_dpdk-ha <os-nosdn-ovs_dpdk-ha>` +- :ref:`os-nosdn-ovs_dpdk-noha <os-nosdn-ovs_dpdk-noha>` +- :ref:`os-odl-ovs_dpdk-ha <os-odl-ovs_dpdk-ha>` +- :ref:`os-odl-ovs_dpdk-noha <os-odl-ovs_dpdk-noha>` +- :ref:`os-odl-fdio-dvr-noha <os-odl-fdio-dvr-noha>` +- :ref:`os-odl-fdio-dvr-ha <os-odl-fdio-dvr-ha>` +- :ref:`os-odl-fdio-ipv6-noha <os-odl-fdio-ipv6-noha>` +- :ref:`os-odl-fdio-ipv6-ha <os-odl-fdio-ipv6-ha>` +- :ref:`os-nosdn-fdio-ha <os-nosdn-fdio-ha>` +- :ref:`os-k8s-fdio <os-k8s-fdio>` +- :ref:`os-odl-k8s_coe-noha <os-odl-k8s_coe-noha>` +- :ref:`os-odl-k8s_coe-ha <os-odl-k8s_coe-ha>` +- :ref:`os-nosdn-kvm_ovs_dpdk-ha <os-nosdn-kvm_ovs_dpdk-ha>` +- :ref:`os-nosdn-bar-ha <os-nosdn-bar-ha>` +- :ref:`os-nosdn-bar-noha <os-nosdn-bar-noha>` +- :ref:`os-odl_l2-moon-ha <os-odl_l2-moon-ha>` +- :ref:`k8-nosdn-lb-noha <k8-nosdn-lb-noha>` +- :ref:`os-odl-sfc-ha <os-odl-sfc-ha>` +- :ref:`os-onos-sfc-ha <os-onos-sfc-ha>` +- :ref:`os-nosdn-ovs_dpdk-ha <os-nosdn-ovs_dpdk-ha>` +- :ref:`os-nosdn-openbaton-ha <os-nosdn-openbaton-ha>` +- :ref:`k8-ovn-lb-noha <k8-ovn-lb-noha>` Installation Procedure ====================== Detailed step by step instructions for working with an installation toolchain and installing -the required scenario are provided by the installation projects. The four projects providing installation -support for the OPNFV Danube release are: Apex, Compass4nfv, Fuel and JOID. +the required scenario are provided by the installation projects. The projects providing installation +support for the OPNFV Euphrates release are: Apex, Compass4nfv, Daisy4NFV, Fuel and JOID. The instructions for each toolchain can be found in these links: @@ -91,10 +105,10 @@ The instructions for each toolchain can be found in these links: OPNFV Test Frameworks ===================== -If you have elected to install the OPNFV platform using the deployment toolchain provided by OPNFV +If you have elected to install the OPNFV platform using the deployment toolchain provided by OPNFV, your system will have been validated once the installation is completed. -The basic deployment validation only addresses a small part of capabilities provided in -the platform and you may want to execute more exhaustive tests. Some investigation will be required to +The basic deployment validation only addresses a small part of capabilities in +the platform and you may want to execute more exhaustive tests. Some investigation will be required to select the right test suites to run on your platform. Many of the OPNFV test project provide user-guide documentation and installation instructions in :ref:`this document <testing-userguide>` diff --git a/docs/release/release-notes.rst b/docs/release/release-notes.rst index 2eb74d723..9e6e5c301 100644 --- a/docs/release/release-notes.rst +++ b/docs/release/release-notes.rst @@ -3,12 +3,12 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -============== +============= Release Notes -============== +============= -Release notes as provided by the OPNFV participating documents are captured in this section. -These include details of software versions used, known limitations and outstanding trouble +Release notes as provided by participating projects in OPNFV are captured in this section. +These include details of software versions used, known limitations, and outstanding trouble reports. Project release notes: @@ -18,12 +18,12 @@ Project release notes: :ref:`Armband Release Notes <armband-release-notes-label>` +:ref:`Barometer Release Notes <barometer-releasenotes>` + :ref:`Bottlenecks Release Notes <bottlenecks-releasenotes>` :ref:`Compass4nfv Release Notes <compass4nfv-releasenotes>` -:ref:`Copper Release Notes <copper-releasenotes>` - :ref:`Daisy Release Notes <daisy-releasenotes>` :ref:`Doctor Release Notes <doctor-releasenotes>` @@ -40,14 +40,18 @@ Project release notes: :ref:`KVMforNFV Release Notes <kvmfornfv-releasenotes>` -:ref:`Netready Release Notes <netready-releasenotes>` +:ref:`NFVBench Release Notes <nfvbench-releasenotes>` -:ref:`Opera Release Notes <opera-releasenotes>` +:ref:`Orchestra Release Notes <orchestra-releasenotes>` :ref:`Parser Release Notes <parser-releasenotes>` +:ref:`Promise Release Notes <promise-releasenotes>` + :ref:`QTIP Release Notes <qtip-releasenotes>` +:ref:`SampleVNF Release Notes <samplenvf-releasenotes>` + :ref:`SDNVPN Release Notes <sdnvpn-releasenotes>` :ref:`SFC Release Notes <sfc-releasenotes>` diff --git a/docs/release/userguide.introduction.rst b/docs/release/userguide.introduction.rst index 888392762..ef48e590c 100644 --- a/docs/release/userguide.introduction.rst +++ b/docs/release/userguide.introduction.rst @@ -2,11 +2,11 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. SPDX-License-Identifier: CC-BY-4.0 -.. (c) Sofia Wallin (sofia.wallin@ericssion.com) +.. (c) Sofia Wallin (sofia.wallin@ericsson.com) and other contributors -================================= +================================ User Guide & Configuration Guide -================================= +================================ Abstract ======== @@ -14,11 +14,11 @@ Abstract OPNFV is a collaborative project aimed at providing a variety of virtualisation deployments intended to host applications serving the networking and carrier industries. This document provides guidance and instructions for using platform -features designed to support these applications, made available in the OPNFV -Danube release. +features designed to support these applications that are made available in the OPNFV +Euphrates release. This document is not intended to replace or replicate documentation from other -upstream open source projects such as KVM, OpenDaylight, or OpenStack, but to highlight the +upstream open source projects such as KVM, OpenDaylight, OpenStack, etc., but to highlight the features and capabilities delivered through the OPNFV project. @@ -27,43 +27,43 @@ Introduction OPNFV provides a suite of scenarios, infrastructure deployment options, which are able to be installed to host virtualised network functions (VNFs). -This Guide intends to help users of the platform leverage the features and -capabilities delivered by the OPNFV project. +This document intends to help users of the platform leverage the features and +capabilities delivered by OPNFV. OPNFVs' Continuous Integration builds, deploys and tests combinations of virtual infrastructure components in what are defined as scenarios. A scenario may include components such as KVM, OpenDaylight, OpenStack, OVS, etc., where each scenario will include different source components or configurations. Scenarios are designed to enable specific features and capabilities in the platform that -can be leveraged by the OPNFV User community. +can be leveraged by the OPNFV user community. Feature Overview ================ The following links outline the feature deliverables from participating OPNFV -projects in the Danube release. Each of the participating projects provides +projects in the Euphrates release. Each of the participating projects provides detailed descriptions about the delivered features including use cases, -implementation and configuration specifics. +implementation, and configuration specifics. The following Configuration Guides and User Guides assume that the reader already has some -information about a given project's specifics and deliverables. These Guides +knowledge about a given project's specifics and deliverables. These Guides are intended to be used following the installation with an OPNFV installer to allow users to deploy and implement feature delivered by OPNFV. If you are unsure about the specifics of a given project, please refer to the -OPNFV wiki page at http://wiki.opnfv.org, for more details. +OPNFV wiki page at http://wiki.opnfv.org for more details. Feature Configuration Guides ============================ -- :ref:`Copper Configuration Guide <copper-configguide>` +- :ref:`Barometer Configuration Guide <barometer-configguide>` - :ref:`Doctor Configuration Guide <doctor-configguide>` +- :ref:`Domino Configuration Guide <domino-configguide>` - :ref:`IPv6 Configuration Guide <ipv6-configguide>` - :ref:`KVMforNFV Configuration Guide <kvmfornfv-configguide>` -- :ref:`Netready Configuration Guide <netready-configguide>` -- :ref:`ONOSFW Configuration Guide <onosfw-configguide>` +- :ref:`Orchestra Configuration Guide <orchestra-configguide>` - :ref:`Parser Configuration Guide <parser-configguide>` - :ref:`Promise Configuration Guide <promise-configguide>` - :ref:`SDNVPN Configuration Guide <sdnvpn-configguide>` @@ -73,13 +73,13 @@ Feature Configuration Guides Feature User Guides =================== -- :ref:`Copper User Guide <copper-userguide>` +- :ref:`Barometer User Guide <barometer-userguide>` - :ref:`Doctor User Guide <doctor-userguide>` - :ref:`Domino User Guide <domino-userguide>` - :ref:`IPv6 User Guide <ipv6-userguide>` - :ref:`KVMforNFV User Guide <kvmfornfv-userguide>` -- :ref:`Netready User Guide <netready-userguide>` -- :ref:`ONOSFW User Guide <onosfw-userguide>` +- :ref:`OpenContrail Virtual Networking User Guide <ovno-userguide>` +- :ref:`Orchestra User Guide <orchestra-userguide>` - :ref:`Parser User Guide <parser-userguide>` - :ref:`Promise User Guide <promise-userguide>` - :ref:`SDNVPN User Guide <sdnvpn-userguide>` diff --git a/docs/submodules/apex b/docs/submodules/apex -Subproject 82460b8ed466cac2d97bd89f7072e3b13a0c5b4 +Subproject 75afddf0e4032e4af389c5d85b529704102a77a diff --git a/docs/submodules/armband b/docs/submodules/armband -Subproject a6f17c731f081664fa8c62389669b56b5e8b7c2 +Subproject 8ac5a461c90545aa06538f5376cc929b2297f19 diff --git a/docs/submodules/barometer b/docs/submodules/barometer -Subproject 21785d87913475a45bd9251c8d0e605eeeb4f57 +Subproject c10400426df872be3236677dcb749c755f4a559 diff --git a/docs/submodules/bottlenecks b/docs/submodules/bottlenecks -Subproject ad12c5707ac1191063af5cd33d54dd30ff64978 +Subproject 011a217f71c27f9b908b20f9145f461ddc12084 diff --git a/docs/submodules/compass4nfv b/docs/submodules/compass4nfv -Subproject f70d3aa8ffe7878e86b8f12c91c99018924a74b +Subproject d2b31ca70c3d8e49b7733401ce36114bd9f1c92 diff --git a/docs/submodules/daisy b/docs/submodules/daisy -Subproject af5ccd55863bd86f4ea6e71a161e2ffd5c964bd +Subproject 7fb4a641b9fd176dcad36d881bf5e1103539202 diff --git a/docs/submodules/doctor b/docs/submodules/doctor -Subproject 1336b9add0dc6fb91fbf71431e3bfa1cd0dd89d +Subproject ff43740199fc14ad01b05ed0d626f51f81eb82f diff --git a/docs/submodules/dovetail b/docs/submodules/dovetail -Subproject 61820ee85c967d90021e4089c6a790704668563 +Subproject 8b916429666565f5b7b1ffda7dc912addb30815 diff --git a/docs/submodules/fds b/docs/submodules/fds -Subproject dd85a6c21cc0c092748d25f410541be4f99777e +Subproject f20af6726aef99f3a1fcdc63068fe9f8b89e347 diff --git a/docs/submodules/fuel b/docs/submodules/fuel -Subproject 4b2dfa552656def5f56a48229705e79c5c7bcfc +Subproject d24e773f1cc9dc8aece460eef34f14d90a55349 diff --git a/docs/submodules/functest b/docs/submodules/functest -Subproject e1e1f44521cb36b05704d83adf3f51af838ac25 +Subproject b020adb0c47f5d85b5cc1b3b3927e689698499f diff --git a/docs/submodules/ipv6 b/docs/submodules/ipv6 -Subproject 9dcfb541a2af0738d5dab68ae4e9ae5b9a7889a +Subproject 003bd3adbd0f98119d95e5a079a30cc6e255b5f diff --git a/docs/submodules/joid b/docs/submodules/joid -Subproject 0aae5f09cedb4f9bfcb6af0e5f1a43824095284 +Subproject 08d9db4bb34558cfda9c2c8655253d5cced66fb diff --git a/docs/submodules/nfvbench b/docs/submodules/nfvbench -Subproject 216233299e082d2f3a67a697be66bb894f23f01 +Subproject 5511522fce8d3d394f2d9b73fbd910032f75f53 diff --git a/docs/submodules/orchestra b/docs/submodules/orchestra -Subproject d897a8fae077e366a9a9e1fa53d160b0db6e356 +Subproject 2c7eea345e76a641b65b567f6ebb2bf8b4f3a07 diff --git a/docs/submodules/ovno b/docs/submodules/ovno new file mode 160000 +Subproject fd876b7dbc7d517a706b22e52bf6f0e8f79a0b4 diff --git a/docs/submodules/parser b/docs/submodules/parser -Subproject b991369780f92cf7103881ce29cf589bd208269 +Subproject e0ff4c6768fdae895d529cd7975fe90c913169c diff --git a/docs/submodules/pharos b/docs/submodules/pharos -Subproject 908dab58edbbe8f22db14a9261693a54e9b2d8f +Subproject 2c4fac2e41aaca9dd679b200ffc968eeb448b39 diff --git a/docs/submodules/promise b/docs/submodules/promise -Subproject c0f8f3487b1782eeb05ce6d0d2c4b8578594e5d +Subproject 6dc47bec9e4e23b744c9d74c4fb4846604e7b80 diff --git a/docs/submodules/qtip b/docs/submodules/qtip -Subproject b95adaf14afff4215f773b2ef150fbc4b3a00ef +Subproject 3d5a7186f544797cc788c9a052b370aa072ad07 diff --git a/docs/submodules/releng b/docs/submodules/releng -Subproject e6cd3c6c77d2aaf6cb7d6765edb5baf9bc50bcf +Subproject f6255c45367f39533b589a91ca351ad0bcfd0ac diff --git a/docs/submodules/releng-xci b/docs/submodules/releng-xci -Subproject b1417cb094ec9c546b3230746278942d4c27340 +Subproject 9036d1c5fde99a57c08528293784de653efab67 diff --git a/docs/submodules/samplevnf b/docs/submodules/samplevnf -Subproject b9b9fb1b319f24b6240ca2cc0871ad1ea12988c +Subproject 48413cdea74b0fedfde4dac00951100b7d32580 diff --git a/docs/submodules/sfc b/docs/submodules/sfc -Subproject 7d3d673882b2fcf368c17b18fa1657ce547cf53 +Subproject fd707b3d268129d02e726523517dae837b2f055 diff --git a/docs/submodules/snaps b/docs/submodules/snaps -Subproject 14b6578d2d40a3335d361ad234accb804245e3e +Subproject 440acd77fbda4cf944cc915bef4183935527f65 diff --git a/docs/submodules/storperf b/docs/submodules/storperf -Subproject 41ba13aad1a57fe9b9bcc674cbfe3215e295f17 +Subproject eb138c529c3cb1a7223bd970685db874f5a6269 diff --git a/docs/submodules/vswitchperf b/docs/submodules/vswitchperf -Subproject 5d08ffdf317d31361a528bf1b6d33cd4d000760 +Subproject bde80dd0127ff65de738085a73832834e2ab190 diff --git a/docs/submodules/yardstick b/docs/submodules/yardstick -Subproject 12722dca61e657942182b236ca0281aabee47b9 +Subproject 49677852f2bc690d235318d2208504241eef61a diff --git a/docs/testing/ecosystem/overview.rst b/docs/testing/ecosystem/overview.rst index 42e38ac04..0ce35e048 100644 --- a/docs/testing/ecosystem/overview.rst +++ b/docs/testing/ecosystem/overview.rst @@ -56,17 +56,17 @@ The major testing projects are described in the table below: | | to run those tools on OPNFV's infrastructure. | +----------------+---------------------------------------------------------+ | Dovetail | This project intends to define and provide a set of | -| | OPNFV related validation criteria that will provide | -| | input for the evaluation of the use of OPNFV trademarks.| -| | The dovetail project is executed with the guidance and | -| | oversight of the Compliance and Certification committee | -| | and work to secure the goals of the C&C committee for | -| | each release. The project intends to incrementally | -| | define qualification criteria that establish the | -| | foundations of how we are able to measure the ability to| -| | utilize the OPNFV platform, how the platform itself | -| | should behave, and how applications may be deployed on | -| | the platform. | +| | OPNFV related validation criteria/tests that will | +| | provide input for the OPNFV Complaince Verification | +| | Program. The Dovetail project is executed with the | +| | guidance and oversight of the Complaince and | +| | Certification (C&C) committee and work to secure the | +| | goals of the C&C committee for each release. The | +| | project intends to incrementally define qualification | +| | criteria that establish the foundations of how one is | +| | able to measure the ability to utilize the OPNFV | +| | platform, how the platform itself should behave, and | +| | how applications may be deployed on the platform. | +----------------+---------------------------------------------------------+ | Functest | This project deals with the functional testing of the | | | VIM and NFVI. It leverages several upstream test suites | @@ -175,33 +175,30 @@ A Mongo DB Database was introduced for the Brahmaputra release. The following collections are declared in this database: * pods: the list of pods used for production CI * projects: the list of projects providing test cases - * testcases: the test cases related to a given project + * test cases: the test cases related to a given project * results: the results of the test cases * scenarios: the OPNFV scenarios tested in CI This database can be used by any project through the Test API. Please note that projects may also use additional databases. The Test Database is mainly use to collect CI test results and generate scenario -trust indicators. The Test Database is cloned for OPNFV Plugfests in +trust indicators. The Test Database is also cloned for OPNFV Plugfests in order to provide a private datastore only accessible to Plugfest participants. Test API description -------------------- The Test API is used to declare pods, projects, test cases and test results. -Pods correspond to the cluster of machines (3 controller and 2 compute nodes in -HA mode) used to run the tests and defined in Pharos project. +Pods correspond to a cluster of machines (3 controller and 2 compute nodes in +HA mode) used to run the tests and are defined in the Pharos project. The results pushed in the database are related to pods, projects and test cases. Trying to push results generated from a non-referenced pod will return an error message by the Test API. -An additional method dashboard has been added to post-process the raw results in -the Brahmaputra release (deprecated in Colorado release). - The data model is very basic, 5 objects are available: * Pods * Projects - * Testcases + * Test cases * Results * Scenarios @@ -237,7 +234,7 @@ The value of the header i.e the token can be accessed in the jenkins environment headers['X-Auth-Token'] = os.environ.get('TestApiToken') The above example is in Python. Token based authentication has been added so -that only CI pods running Jenkins jobs can access to the database. Please note +that only CI pods running Jenkins jobs can access the database. Please note that currently token authorization is implemented but is not yet enabled. @@ -256,7 +253,7 @@ This page provides reporting per OPNFV release and per testing project. :alt: Testing group Euphrates reporting page An evolution of the reporting page is planned to unify test reporting by creating -a landing page that shows the scenario status with one glance (this information was +a landing page that shows the scenario status in one glance (this information was previously consolidated manually on a wiki page). The landing page will be displayed per scenario and show: @@ -279,7 +276,7 @@ Test cases per project may be listed by calling: with project_name: bottlenecks, functest, qtip, storperf, vsperf, yardstick A test case catalog has now been realized `[TST4]`_. Roll over the project then -click to get the list of test cases, click on the case to get more details. +click to get the list of test cases, and then click on the case to get more details. .. figure:: ../../images/TestcaseCatalog.png :align: center @@ -291,7 +288,7 @@ Test Dashboards The Test Dashboard is used to provide a consistent view of the results collected in CI. The results shown on the dashboard are post processed from the Database, which only contains raw results. -The dashboard can be used in addition of the reporting page (high level view) to allow +The dashboard can be used in addition to the reporting page (high level view) to allow the creation of specific graphs according to what the test owner wants to show. In Brahmaputra, a basic dashboard was created in Functest. @@ -315,7 +312,7 @@ wiki: https://wiki.opnfv.org/testing mailing list: test-wg@lists.opnfv.org -IRC chan: #opnfv-testperf +IRC channel: #opnfv-testperf weekly meeting (https://wiki.opnfv.org/display/meetings/TestPerf): * Usual time: Every Thursday 15:00-16:00 UTC / 7:00-8:00 PST |