diff options
| -rw-r--r-- | .gitignore | 4 | ||||
| -rw-r--r-- | docs/conf.py | 62 | ||||
| -rw-r--r-- | docs/featureprojects.rst | 176 | ||||
| -rw-r--r-- | docs/images/gambia.png | bin | 0 -> 156776 bytes | |||
| -rw-r--r-- | docs/index.rst | 5 | ||||
| -rw-r--r-- | docs/infrastructure/overview.rst | 8 | ||||
| -rw-r--r-- | docs/release/installation.introduction.rst | 9 | ||||
| -rw-r--r-- | docs/release/overview.rst | 38 | ||||
| -rw-r--r-- | docs/release/release-notes.rst | 6 | ||||
| -rw-r--r-- | docs/release/subrelease.rst | 28 | ||||
| -rw-r--r-- | docs/release/userguide.introduction.rst | 13 | ||||
| -rw-r--r-- | docs/testing/developer/devguide/index.rst | 2 | ||||
| -rw-r--r-- | docs/testing/testing-dev.rst | 24 | ||||
| -rw-r--r-- | docs/testing/testing-user.rst | 41 |
14 files changed, 138 insertions, 278 deletions
diff --git a/.gitignore b/.gitignore index 7c4785069..f0b2bd26a 100644 --- a/.gitignore +++ b/.gitignore @@ -3,4 +3,6 @@ /docs_build/ /docs/projects/ /docs_output/ -/releng/
\ No newline at end of file +/releng/ +.tox +docs/_build/* diff --git a/docs/conf.py b/docs/conf.py index d966487bf..8bf54b054 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -285,44 +285,44 @@ html_sidebars = {'**': ['localtoc.html', 'relations.html'],} # texinfo_no_detailmenu = False intersphinx_mapping = {} +intersphinx_mapping['apex'] = ('https://opnfv-apex.readthedocs.io/en/%s' % branch, None) intersphinx_mapping['armband'] = ('https://opnfv-armband.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['auto'] = ('https://opnfv-auto.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['auto'] = ('https://opnfv-auto.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['availability'] = ('https://opnfv-availability.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['barometer'] = ('https://opnfv-barometer.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['bottlenecks'] = ('https://opnfv-bottlenecks.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['calipso'] = ('https://opnfv-calipso.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['clover'] = ('https://opnfv-clover.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['compass4nfv'] = ('https://opnfv-compass4nfv.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['container4nfv'] = ('https://opnfv-container4nfv.readthedocs.io/en/%s' % branch, None) intersphinx_mapping['copper'] = ('https://opnfv-copper.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['daisy'] = ('https://opnfv-daisy.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['doctor'] = ('https://opnfv-doctor.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['dovetail'] = ('https://opnfv-dovetail.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['edgecloud'] = ('https://opnfv-edgecloud.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['fds'] = ('https://opnfv-fds.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['fuel'] = ('https://opnfv-fuel.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['functest'] = ('https://opnfv-functest.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['ipv6'] = ('https://opnfv-ipv6.readthedocs.io/en/%s' % branch, None) intersphinx_mapping['moon'] = ('https://opnfv-moon.readthedocs.io/en/%s' % branch, None) intersphinx_mapping['netready'] = ('https://opnfv-netready.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['promise'] = ('https://opnfv-promise.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['releng'] = ('https://opnfv-releng.readthedocs.io/en/latest', None) +intersphinx_mapping['nfvbench'] = ('https://opnfv-nfvbench.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['onosfw'] = ('https://opnfv-onosfw.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['orchestra'] = ('https://opnfv-orchestra.readthedocs.io/en/%s' % branch, None) intersphinx_mapping['ovn4nfv'] = ('https://opnfv-ovn4nfv.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['fuel'] = ('https://opnfv-fuel.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['auto'] = ('https://opnfv-auto.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['stor4nfv'] = ('https://opnfv-stor4nfv.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['daisy'] = ('https://opnfv-daisy.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['ovno'] = ('https://opnfv-ovno.readthedocs.io/en/%s' % branch, None) intersphinx_mapping['parser'] = ('https://opnfv-parser.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['qtip'] = ('https://opnfv-qtip.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['ipv6'] = ('https://opnfv-ipv6.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['functest'] = ('https://opnfv-functest.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['doctor'] = ('https://opnfv-doctor.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['compass4nfv'] = ('https://opnfv-compass4nfv.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['yardstick'] = ('https://opnfv-yardstick.readthedocs.io/en/%s' % branch, None) intersphinx_mapping['pharos'] = ('https://opnfv-pharos.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['vswitchperf'] = ('https://opnfv-vswitchperf.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['barometer'] = ('https://opnfv-barometer.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['promise'] = ('https://opnfv-promise.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['qtip'] = ('https://opnfv-qtip.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['releng'] = ('https://opnfv-releng.readthedocs.io/en/latest', None) intersphinx_mapping['releng-xci'] = ('https://opnfv-releng-xci.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['sfc'] = ('https://opnfv-sfc.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['orchestra'] = ('https://opnfv-orchestra.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['bottlenecks'] = ('https://opnfv-bottlenecks.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['onosfw'] = ('https://opnfv-onosfw.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['apex'] = ('https://opnfv-apex.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['sdnvpn'] = ('https://opnfv-sdnvpn.readthedocs.io/en/%s' % branch, None) intersphinx_mapping['samplevnf'] = ('https://opnfv-samplevnf.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['container4nfv'] = ('https://opnfv-container4nfv.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['auto'] = ('https://opnfv-auto.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['edgecloud'] = ('https://opnfv-edgecloud.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['availability'] = ('https://opnfv-availability.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['storperf'] = ('https://opnfv-storperf.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['ovno'] = ('https://opnfv-ovno.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['fds'] = ('https://opnfv-fds.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['calipso'] = ('https://opnfv-calipso.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['nfvbench'] = ('https://opnfv-nfvbench.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['sdnvpn'] = ('https://opnfv-sdnvpn.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['sfc'] = ('https://opnfv-sfc.readthedocs.io/en/%s' % branch, None) intersphinx_mapping['snaps'] = ('https://opnfv-snaps.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['clover'] = ('https://opnfv-clover.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['dovetail'] = ('https://opnfv-dovetail.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['stor4nfv'] = ('https://opnfv-stor4nfv.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['storperf'] = ('https://opnfv-storperf.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['vswitchperf'] = ('https://opnfv-vswitchperf.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['yardstick'] = ('https://opnfv-yardstick.readthedocs.io/en/%s' % branch, None) diff --git a/docs/featureprojects.rst b/docs/featureprojects.rst index b2eac4314..447f81617 100644 --- a/docs/featureprojects.rst +++ b/docs/featureprojects.rst @@ -5,184 +5,102 @@ OPNFV Projects Apex ---- -.. toctree:: - :maxdepth: 1 - - ../submodules/apex/docs/development/overview/index - ../submodules/apex/docs/development/requirements/index - ../submodules/apex/docs/release/installation/index - ../submodules/apex/docs/release/configguide/index - ../submodules/apex/docs/release/userguide/index - ../submodules/apex/docs/development/design/index - ../submodules/apex/docs/development/manuals/index +* :doc:`Apex Overview <apex:index>` +* :doc:`Apex Installation instructions <apex:release/installation/index>` Armband ------- * :doc:`Armband Overview <armband:index>` -* :doc:`Installation Guide <armband:release/installation/index>` -* :doc:`User Guide <armband:release/userguide/index>` +* :doc:`Armband Installation <armband:release/installation/index>` +* :doc:`Fuel User Guide <armband:release/userguide/index>` Availability ------------ -.. toctree:: - :maxdepth: 1 - ../submodules/availability/docs/development/overview/index - ../submodules/availability/docs/development/requirements/index - ../submodules/availability/docs/release/installation/index - ../submodules/availability/docs/release/configguide/index - ../submodules/availability/docs/release/userguide/index - ../submodules/availability/docs/development/design/index - ../submodules/availability/docs/development/manuals/index +* :doc:`Availability overview <availability:index>` +* :doc:`High Availability Requirement Analysis in OPNFV <availability:development/overview/index>` Barometer --------- -.. toctree:: - :maxdepth: 1 - ../submodules/barometer/docs/development/overview/index - ../submodules/barometer/docs/development/requirements/index - ../submodules/barometer/docs/release/installation/index - ../submodules/barometer/docs/release/configguide/index - ../submodules/barometer/docs/release/userguide/index - ../submodules/barometer/docs/development/design/index - ../submodules/barometer/docs/development/manuals/index +* :doc:`Barometer Overview <barometer:index>` +* :doc:`Barometer Requirements <barometer:development/requirements/index>` +* :doc:`Barometer Config Guide <barometer:release/configguide/index>` +* :doc:`Barometer User Guide <barometer:release/userguide/index>` +* :doc:`Barometer Design Guide <barometer:development/design/index>` Clover ------ -.. toctree:: - :maxdepth: 1 - ../submodules/clover/docs/development/design/index - ../submodules/clover/docs/release/configguide/index - ../submodules/clover/docs/release/userguide/index + +* :doc:`Clover Overview <clover:index>` Compass4Nfv ----------- -.. toctree:: - :maxdepth: 1 - - ../submodules/compass4nfv/docs/development/overview/index - ../submodules/compass4nfv/docs/development/requirements/index - ../submodules/compass4nfv/docs/release/installation/index - ../submodules/compass4nfv/docs/release/configguide/index - ../submodules/compass4nfv/docs/release/userguide/index - ../submodules/compass4nfv/docs/development/design/index - ../submodules/compass4nfv/docs/development/manuals/index +* :doc:`Compass4nfv Overview <compass4nfv:index>` +* :doc:`Compass4nfv Installation <compass4nfv:release/installation/index>` +* :doc:`Compass4nfv Design Guide <compass4nfv:development/design/index>` Daisy4NFV --------- -.. toctree:: - :maxdepth: 1 - - ../submodules/daisy/docs/development/design/index - ../submodules/daisy/docs/release/configguide/index - ../submodules/daisy/docs/release/installation/index +* :doc:`Daisy overview <daisy:index>` +* :doc:`Daisy Design Guide <daisy:development/design/index>` +* :doc:`Daisy Config Guide <daisy:release/configguide/index>` +* :doc:`Daisy Installation Guide <daisy:release/installation/index>` Doctor ------ -.. toctree:: - :maxdepth: 1 - ../submodules/doctor/docs/development/overview/index - ../submodules/doctor/docs/development/requirements/index - ../submodules/doctor/docs/release/installation/index - ../submodules/doctor/docs/release/configguide/index - ../submodules/doctor/docs/release/userguide/index - ../submodules/doctor/docs/development/design/index - ../submodules/doctor/docs/development/manuals/index +* :doc:`Doctor overview <doctor:index>` +* :doc:`Doctor Requirements <doctor:development/requirements/index>` +* :doc:`Doctor Config Guide <doctor:release/configguide/index>` +* :doc:`Doctor User Guide <doctor:release/userguide/index>` +* :doc:`Doctor Design Guide <doctor:development/design/index>` +* :doc:`OpenStack NOVA API for marking host down <doctor:development/manuals/index>` Edgecloud --------- -.. toctree:: - :maxdepth: 1 - ../submodules/edgecloud/docs/development/requirements/index +* :doc:`Edgecloud Overview <edgecloud:index>` +* :doc:`Edgecloud Requirements <edgecloud:development/requirements/index>` IPV6 ---- -.. toctree:: - :maxdepth: 1 - - ../submodules/ipv6/docs/development/overview/index - ../submodules/ipv6/docs/development/requirements/index - ../submodules/ipv6/docs/release/installation/index - ../submodules/ipv6/docs/release/configguide/index - ../submodules/ipv6/docs/release/userguide/index - ../submodules/ipv6/docs/development/design/index - ../submodules/ipv6/docs/development/manuals/index - - -Joid ----- -.. toctree:: - :maxdepth: 1 - - ../submodules/joid/docs/development/overview/index - ../submodules/joid/docs/development/requirements/index - ../submodules/joid/docs/release/installation/index - ../submodules/joid/docs/release/configguide/index - ../submodules/joid/docs/release/userguide/index - ../submodules/joid/docs/development/design/index - ../submodules/joid/docs/development/manuals/index - - -Opera ------ -.. toctree:: - :maxdepth: 1 - ../submodules/opera/docs/development/overview/index - ../submodules/opera/docs/development/requirements/index - ../submodules/opera/docs/release/installation/index - ../submodules/opera/docs/release/configguide/index - ../submodules/opera/docs/release/userguide/index - ../submodules/opera/docs/development/design/index - ../submodules/opera/docs/development/manuals/index +* :doc:`IPV6 Overview <ipv6:index>` +* :doc:`IPV6 Installation Guide <ipv6:release/installation/index>` +* :doc:`IPV6 Config Guide <ipv6:release/configguide/index>` +* :doc:`IPV6 User Guide <ipv6:release/userguide/index>` Parser ------ -.. toctree:: - :maxdepth: 1 - - ../submodules/parser/docs/development/overview/index - ../submodules/parser/docs/development/requirements/index - ../submodules/parser/docs/release/installation/index - ../submodules/parser/docs/release/configguide/index - ../submodules/parser/docs/release/userguide/index - ../submodules/parser/docs/development/design/index - ../submodules/parser/docs/development/manuals/index +* :doc:`Parser overview <parser:index>` +* :doc:`Parser Installation Guide <parser:release/installation/index>` +* :doc:`Parser Config Guide <parser:release/configguide/index>` +* :doc:`Parser User Guide <parser:release/userguide/index>` SDNVPN -------- -.. toctree:: - :maxdepth: 1 - - ../submodules/sdnvpn/docs/development/overview/index - ../submodules/sdnvpn/docs/development/requirements/index - ../submodules/sdnvpn/docs/release/installation/index - ../submodules/sdnvpn/docs/release/configguide/index - ../submodules/sdnvpn/docs/release/userguide/index - ../submodules/sdnvpn/docs/development/design/index +* :doc:`Sdnvpn Overview <sdnvpn:index>` +* :doc:`Sdnvpn Requirements <sdnvpn:development/requirements/index>` +* :doc:`Sdnvpn Installation Guide <sdnvpn:release/installation/index>` +* :doc:`Sdnvpn Config Guide <sdnvpn:release/configguide/index>` +* :doc:`Sdnvpn User Guide <sdnvpn:release/userguide/index>` +* :doc:`Sdnvpn Feature and API usage guidelines <sdnvpn:development/design/index>` SFC --- -.. toctree:: - :maxdepth: 1 - - ../submodules/sfc/docs/development/overview/index - ../submodules/sfc/docs/development/requirements/index - ../submodules/sfc/docs/release/installation/index - ../submodules/sfc/docs/release/configguide/index - ../submodules/sfc/docs/release/userguide/index - ../submodules/sfc/docs/development/design/index - ../submodules/sfc/docs/development/manuals/index +* :doc:`SFC Overview <sfc:index>` +* :doc:`SFC Requirements <sfc:development/requirements/index>` +* :doc:`SFC Config Guide <sfc:release/configguide/index>` +* :doc:`SFC User Guide <sfc:release/userguide/index>` +* :doc:`SFC Devlopment Guide <sfc:development/design/index>` diff --git a/docs/images/gambia.png b/docs/images/gambia.png Binary files differnew file mode 100644 index 000000000..1e89f9f09 --- /dev/null +++ b/docs/images/gambia.png diff --git a/docs/index.rst b/docs/index.rst index 8e55576b5..d9bf9bbf3 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -54,10 +54,7 @@ Infrastructure Operations Supporting Tools --------------------------- -.. toctree:: - :maxdepth: 1 - - submodules/calipso/docs/release/index +* :ref:`Calipso <calipso-release-guide>` Found a typo or any other feedback? Send an email to users@opnfv.org or talk to us on IRC_. diff --git a/docs/infrastructure/overview.rst b/docs/infrastructure/overview.rst index 3100907ce..3b15c0ec3 100644 --- a/docs/infrastructure/overview.rst +++ b/docs/infrastructure/overview.rst @@ -42,11 +42,3 @@ Software Infrastructure ----------------------- - :ref:`releng:software-infrastructure` - -Security --------- - -.. toctree:: - :maxdepth: 1 - - ../submodules/releng-anteater/docs/index diff --git a/docs/release/installation.introduction.rst b/docs/release/installation.introduction.rst index da654168b..e4e1f690f 100644 --- a/docs/release/installation.introduction.rst +++ b/docs/release/installation.introduction.rst @@ -57,15 +57,10 @@ description documents provided: - :ref:`os-nosdn-vpp-noha <os-nosdn-vpp-noha>` - :ref:`os-nosdn-vpp-ha <os-nosdn-vpp-ha>` - :ref:`os-odl-ovs-noha <os-odl-ovs-noha>` -- :ref:`os-odl-sfc-noha-xci <os-odl-sfc-noha>` -- :ref:`os-odl-sfc-noha-apex <os-odl-sfc-noha2>` -- :ref:`os-odl-sfc-noha-compass <os-odl-sfc-noha3>` -- :ref:`os-odl-sfc-ha-apex <os-odl-sfc-ha>` -- :ref:`os-odl-sfc-ha-compass <os-odl-sfc-ha2>` +- :ref:`os-odl-sfc-noha <os-odl-sfc-noha>` +- :ref:`os-odl-sfc-ha <os-odl-sfc-ha>` - :ref:`os-odl-bgpvpn-noha <os-odl-bgpvpn-noha>` - :ref:`os-odl-bgpvpn-ha <os-odl-bgpvpn-ha>` -- :ref:`os-odl-bgpvpn-noha <os-odl-bgpvpn-noha>` -- :ref:`os-odl-bgpvpn-ha-xci <os-odl-bgpvpn-ha2>` - :ref:`os-nosdn-bar-ha <os-nosdn-bar-ha>` - :ref:`os-nosdn-bar-noha <os-nosdn-bar-noha>` - :ref:`k8-nosdn-virtlet-noha <k8-nosdn-virtlet-noha>` diff --git a/docs/release/overview.rst b/docs/release/overview.rst index 03300ed0e..a3f174806 100644 --- a/docs/release/overview.rst +++ b/docs/release/overview.rst @@ -28,13 +28,10 @@ NFV use cases. OPNFV also works upstream with other open source communities to b and learnings from its work directly to those communities in the form of blueprints, patches, bugs, and new code. -OPNFV focuses on building NFV Infrastructure (NFVI) and Virtualised Infrastructure -Management (VIM) by integrating components from upstream projects such as OpenDaylight, ONOS, Tungsen Fabric, -OVN, OpenStack, Kubernetes, Ceph Storage, KVM, Open vSwitch, and Linux. -More recently, OPNFV has extended its portfolio of forwarding solutions to include DPDK, fd.io and ODP, -is able to run on both Intel and ARM commercial and white-box hardware, support VM, Container and -BareMetal workloads, and includes Management and Network Orchestration MANO components primarily -for application composition and management in the Fraser release. +OPNFV focuses on building NFV Infrastructure (NFVI) and Virtualized Infrastructure Management (VIM) by +integrating components from upstream projects such as OpenDaylight, OVN, OpenStack, Kubernetes, +Ceph Storage, KVM, Open vSwitch, Linux, DPDK, FD.io and ODP. OPNFV- is able to run on both Intel and +ARM commercial and white-box hardware, support VM, Container and BareMetal workloads. These capabilities, along with application programmable interfaces (APIs) to other NFV elements, form the basic infrastructure required for Virtualized Network Functions (VNF) @@ -55,7 +52,7 @@ platform including common hardware requirements, software architecture, MANO and OPNFV Platform Overview Diagram -.. image:: ../images/diagram_fraser.png +.. image:: ../images/gambia.png :alt: Overview infographic of the opnfv platform and projects. @@ -105,17 +102,16 @@ components in conjunction with our upstream communities. Virtual Infrastructure Management --------------------------------- -OPNFV derives it's virtual infrastructure management from one of our largest upstream ecosystems -OpenStack. OpenStack provides a complete reference cloud management system and associated technologies. -While the OpenStack community sustains a broad set of projects, not all technologies are relevant in -the NFV domain, the OPNFV community consumes a sub-set of OpenStack projects and the usage and -composition may vary depending on the installer and scenario. +OPNFV derives its Virtual Infrastructure Management from OpenStack and Kubernetes. OpenStack provides a +complete reference cloud management system and associated technologies. While the OpenStack community +sustains a broad set of projects, not all technologies are relevant in the NFV domain, the OPNFV community +consumes a sub-set of OpenStack projects and the usage and composition may vary depending on the installer and scenario. +Additionally, OPNFV also uses Kubernetes, the popular Container Orchestration Engine. Kubernetes is intended to be a VIM for +Cloud Native Network Functions (CNFs). For details on the scenarios available in OPNFV and the specific composition of components refer to the :ref:`OPNFV User Guide & Configuration Guide <opnfv-user-config>`. -OPNFV now also has initial support for containerized VNFs. - ----------------- Operating Systems ----------------- @@ -142,8 +138,6 @@ being worked on by the community during this release of OPNFV include: interface devices (e.g., vNICs) managed by other OpenStack services (e.g. Nova). * OpenDaylight: addresses multivendor, traditional and greenfield networks, establishing the industry’s de facto SDN platform and providing the foundation for networks of the future. -* Tungsen Fabric: An open source SDN controller designed for cloud and NFV use cases. It has an - analytics engine, well defined northbound REST APIs to configure and gather ops/analytics data. * OVN: A virtual networking solution developed by the same team that created OVS. OVN stands for Open Virtual Networking and is dissimilar from the above projects in that it focuses only on overlay networks. @@ -245,6 +239,9 @@ There are two types of test cases in Yardstick: * OPNFV feature test cases include basic telecom feature testing from OPNFV projects; for example nfv-kvm, sfc, ipv6, Parser, Availability and SDN VPN +With the addition of the Network Service Benchmarking (NSB) initiative, it is possible to use Yardstick NSB +for benchmarking the performance of VNFs and Network Services. + System Evaluation and compliance testing ======================================== @@ -253,12 +250,9 @@ behaviors and capabilities for NFV systems developed externally from the OPNFV e evaluate and measure their ability to provide the features and capabilities developed in the OPNFV ecosystem. -The Dovetail project will provide a test framework and methodology able to be used on any NFV platform, +The Dovetail project provides a test framework and methodology able to be used on any NFV platform, including an agreed set of test cases establishing an evaluation criteria for exercising -an OPNFV compatible system. The Dovetail project has begun establishing the test framework -and will provide a preliminary methodology for the Fraser release. Work will continue to -develop these test cases to establish a stand alone compliance evaluation solution -in future releases. +an OPNFV compatible system. Additional Testing ================== diff --git a/docs/release/release-notes.rst b/docs/release/release-notes.rst index 4a5000d28..d102382ff 100644 --- a/docs/release/release-notes.rst +++ b/docs/release/release-notes.rst @@ -28,6 +28,8 @@ Project release notes: :ref:`Compass4nfv Release Notes <compass4nfv-releasenotes>` +:ref:`Daisy4nfv Release Notes <daisy4nfv-releasenotes>` + :ref:`Doctor Release Notes <doctor-releasenotes>` :ref:`FDS Release Notes <fds-releasenotes>` @@ -38,12 +40,12 @@ Project release notes: :ref:`IPV6 Release Notes <ipv6-releasenotes>` -:ref:`Joid Release Notes <joid-releasenotes>` - :ref:`NFVBench Release Notes <nfvbench-releasenotes>` :ref:`Orchestra Release Notes <orchestra-releasenotes>` +:ref:`ONOSFW Release Notes <onosfw-releasenotes>` + :ref:`OVN4NFV Release Notes <ovn4nfv-releasenotes>` :ref:`Promise Release Notes <promise-releasenotes>` diff --git a/docs/release/subrelease.rst b/docs/release/subrelease.rst index fa4bd95bb..2013377c8 100644 --- a/docs/release/subrelease.rst +++ b/docs/release/subrelease.rst @@ -4,38 +4,24 @@ Subrelease Guides Apex ----- -.. toctree:: - :maxdepth: 1 - ../submodules/apex/docs/releasenotes/index - ../submodules/apex/docs/installationprocedure/index +* :ref:`Release Notes <apex:apex-releasenotes>` +* :ref:`Installation <apex:apex-installation>` Compass -------- -.. toctree:: - :maxdepth: 1 - ../submodules/compass4nfv/docs/releasenotes/index - ../submodules/compass4nfv/docs/installationprocedure/index +* :ref:`Release Notes <compass4nfv:compass4nfv-releasenotes>` +* :ref:`Installation <compass4nfv:compass4nfv-installation>` Daisy ------- -.. toctree:: - :maxdepth: 1 - ../submodules/daisy/docs/release/release-notes/index - ../submodules/daisy/docs/release/installation/index +* :ref:`Release Notes <daisy:daisy-releasenotes>` +* :ref:`Installation <daisy:daisy-installation>` Fuel ----- -* :ref:`Release Notes <fuel:fuel-release-notes-label>` +* :ref:`Release Notes <fuel:fuel-releasenotes>` * :ref:`Installation <fuel:fuel-installation>` - -Joid ------ -.. toctree:: - :maxdepth: 1 - - ../submodules/joid/docs/releasenotes/index - ../submodules/joid/docs/installationprocedure/index diff --git a/docs/release/userguide.introduction.rst b/docs/release/userguide.introduction.rst index 1a8a096ba..47598745b 100644 --- a/docs/release/userguide.introduction.rst +++ b/docs/release/userguide.introduction.rst @@ -61,21 +61,14 @@ Feature Configuration Guides - :ref:`Auto Configuration Guide <auto-configguide>` - :ref:`Barometer Configuration Guide <barometer-configguide>` - :ref:`Clover Configuration Guide <clover-configguide>` -- :ref:`Container4NFV Configuration Guide <xyz-configguide>` - :ref:`Doctor Configuration Guide <doctor-configguide>` -- :ref:`Edge Cloud Configuration Guide <xyz-configguide>` -- :ref:`FDS Configuration Guide <fds-configguide>` -- :ref:`High Availability Configuration Guide <xyz-configguide>` - :ref:`IPv6 Configuration Guide <ipv6-configguide>` - :ref:`ONOSFW Configuration Guide <onosfw-configguide>` - :ref:`Orchestra Configuration Guide <orchestra-configguide>` -- :ref:`OVN4NFV Configuration Guide <xyz-configguide>` -- :ref:`OVNO Configuration Guide <ovno-configguide>` - :ref:`Parser Configuration Guide <parser-configguide>` - :ref:`Promise Configuration Guide <promise:promise-configguide>` - :ref:`SDNVPN Configuration Guide <sdnvpn-configguide>` - :ref:`SFC Configuration Guide <sfc-configguide>` -- :ref:`Stor4NFV Configuration Guide <stor4nfv:stor4nfv-configguide>` Feature User Guides =================== @@ -83,16 +76,12 @@ Feature User Guides - :ref:`Auto User Guide <auto-userguide>` - :ref:`Barometer User Guide <barometer-userguide>` - :ref:`Clover User Guide <clover-userguide>` -- :ref:`Container4NFV User Guide <xyz-userguide>` -- :ref:`Edge Cloud User Guide <xyz-userguide>` +- :ref:`Container4NFV User Guide <container4nfv-userguide>` - :ref:`Doctor User Guide <doctor-userguide>` -- :ref:`FDS User Guide <fds-userguide>` -- :ref:`High Availability User Guide <xyz-userguide>` - :ref:`IPv6 User Guide <ipv6-userguide>` - :ref:`OpenContrail Virtual Networking User Guide <ovno-userguide>` - :ref:`ONOSFW User Guide <onosfw-userguide>` - :ref:`Orchestra User Guide <orchestra-userguide>` -- :ref:`OVN4NFV User Guide <xyz-userguide>` - :ref:`OVNO User Guide <ovno-userguide>` - :ref:`Parser User Guide <parser-userguide>` - :ref:`SDNVPN User Guide <sdnvpn-userguide>` diff --git a/docs/testing/developer/devguide/index.rst b/docs/testing/developer/devguide/index.rst index f661ed335..1c7576b97 100644 --- a/docs/testing/developer/devguide/index.rst +++ b/docs/testing/developer/devguide/index.rst @@ -1,3 +1,5 @@ +.. _developer-devguide: + .. 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) diff --git a/docs/testing/testing-dev.rst b/docs/testing/testing-dev.rst index 291781455..566cb67be 100644 --- a/docs/testing/testing-dev.rst +++ b/docs/testing/testing-dev.rst @@ -16,46 +16,34 @@ Testing group Bottlenecks ------------ -.. toctree:: - :maxdepth: 1 - ../submodules/bottlenecks/docs/testing/developer/devguide/index +* :doc:`Bottlenecks Developer Guide <bottlenecks:testing/developer/devguide/index>` Dovetail / OPNFV Verified Program --------------------------------- -.. toctree:: - :maxdepth: 1 - ../submodules/dovetail/docs/testing/developer/testcaserequirements/index +* :doc:`OVP Test Case Requirements <dovetail:testing/developer/testcaserequirements/index>` Functest --------- -.. toctree:: - :maxdepth: 1 - ../submodules/functest/docs/testing/developer/devguide/index +* :doc:`Functest Developer Guide <functest:testing/developer/devguide/index>` StorPerf -------- -.. toctree:: - :maxdepth: 1 - ../submodules/storperf/docs/testing/developer/devguide/index +* :doc:`StorPerf Developer Guide <storperf:testing/developer/devguide/index>` VSPERF ------- -.. toctree:: - :maxdepth: 1 - ../submodules/vswitchperf/docs/testing/developer/devguide/index +* :doc:`VSPERF Developer Guide <vswitchperf:testing/developer/devguide/index>` Yardstick --------- -.. toctree:: - :maxdepth: 1 - ../submodules/yardstick/docs/testing/developer/devguide/index +* :doc:`Yardstick Developer Guide <yardstick:testing/developer/devguide/index>` diff --git a/docs/testing/testing-user.rst b/docs/testing/testing-user.rst index 7a57ed47b..8bfb37ae7 100644 --- a/docs/testing/testing-user.rst +++ b/docs/testing/testing-user.rst @@ -1,10 +1,3 @@ -.. _testing-userguide: - -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -=================== -Testing User Guides =================== This page provides the links to the installation, configuration and user guides @@ -15,8 +8,8 @@ Bottlenecks .. toctree:: :maxdepth: 1 - ../submodules/bottlenecks/docs/testing/user/configguide/index - ../submodules/bottlenecks/docs/testing/user/userguide/index +* :doc:`Bottlenecks Config Guide <bottlenecks:testing/user/configguide/index>` +* :doc:`Bottlenecks User Guide <bottlenecks:testing/user/userguide/index>` Dovetail / OPNFV Verified Program @@ -24,27 +17,27 @@ Dovetail / OPNFV Verified Program .. toctree:: :maxdepth: 1 - ../submodules/dovetail/docs/testing/user/certificationworkflow/index - ../submodules/dovetail/docs/testing/user/ovpaddendum/index - ../submodules/dovetail/docs/testing/user/reviewerguide/index - ../submodules/dovetail/docs/testing/user/systempreparation/index - ../submodules/dovetail/docs/testing/user/testspecification/index - ../submodules/dovetail/docs/testing/user/userguide/index +* :doc:`OVP Workflow <dovetail:testing/user/certificationworkflow/index>` +* :doc:`Guidelines Addendum for 2018.09 release <dovetail:testing/user/ovpaddendum/index>` +* :doc:`OVP Reviewer Guide <dovetail:testing/user/reviewerguide/index>` +* :doc:`OVP System Preparation Guide <dovetail:testing/user/systempreparation/index>` +* :doc:`OVP Testing Specification <dovetail:testing/user/testspecification/index>` +* :doc:`OVP Testing User Guide <dovetail:testing/user/userguide/index>` Functest --------- .. toctree:: :maxdepth: 1 - ../submodules/functest/docs/testing/user/configguide/index - ../submodules/functest/docs/testing/user/userguide/index +* :doc:`Functest Installation Guide <functest:testing/user/configguide/index>` +* :doc:`Functest User Guide <functest:testing/user/userguide/index>` NFVbench -------- .. toctree:: :maxdepth: 1 - ../submodules/nfvbench/docs/testing/user/userguide/index +* :doc:`NFVbench User Guide <nfvbench:testing/user/userguide/index>` Storperf @@ -53,7 +46,7 @@ Storperf .. toctree:: :maxdepth: 1 - ../submodules/storperf/docs/testing/user/index +* :doc:`StorPerf User Guide <storperf:testing/user/index>` VSPERF @@ -62,8 +55,8 @@ VSPERF .. toctree:: :maxdepth: 1 - ../submodules/vswitchperf/docs/testing/user/configguide/index - ../submodules/vswitchperf/docs/testing/user/userguide/index +* :doc:`VSPERF Configuration and User Guide <vswitchperf:testing/user/configguide/index>` +* :doc:`VSPERF Test Guide <vswitchperf:testing/user/userguide/index>` Yardstick @@ -71,5 +64,7 @@ Yardstick .. toctree:: :maxdepth: 1 - ../submodules/yardstick/docs/testing/user/configguide/index - ../submodules/yardstick/docs/testing/user/userguide/index +* :doc:`Yardstick Configuration Guide <yardstick:testing/user/configguide/index>` +* :doc:`Yardstick User Guide <yardstick:testing/user/userguide/index>` + + |
