diff options
| author |   Georg Kunz <georg.kunz@ericsson.com> | 2018-09-06 10:45:01 +0200 |
|---|---|---|
| committer |   Dan Xu <xudan16@huawei.com> | 2018-09-18 03:02:17 +0000 |
| commit | 16e36edaec487300f1dd154110077d499bf7726e (patch) | |
| tree | f66ee65b5293d9279270970c1d27f94e8fac7aca | |
| parent | 01aecb7063ca10bb68a454bf3f324ea1f41b958f (diff) | |
Adapting local docs build and remove build warnings
The OPNFV docs project will remove its submodules and enable local docs
builds. This patch prepares the Dovetail repo according to the official
transition guide:
https://docs.opnfv.org/en/latest/how-to-use-docs/local-build-transition.html
This patch also applies syntactical changes which eliminate the sphinx
doc build warnings.
Change-Id: Ief8fd2d1c3e39b232d214a9ab392879ee4a492c8
Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
(cherry picked from commit a18e2b0d45c631709e457530f6f9d0b52f552156)
19 files changed, 341 insertions, 640 deletions
@@ -21,7 +21,7 @@ pip-log.txt # unittest/coverage reports .coverage -.tox +.tox/ .cache .pytest_cache nosetests.xml @@ -32,9 +32,4 @@ unittest_results.log # Sphinx documentation *.sw? -docs_build/ -docs_output/ -docs/_build -pre_config/ -docs/index.rst -docs/requirements.txt +docs/_build/* diff --git a/docs/conf.py b/docs/conf.py index fb87bf68..317a2aec 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,283 +1,6 @@ -#import sphinx_bootstrap_theme -import sphinx_opnfv_theme -import os +from docs_conf.conf import * -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -# needs_sphinx = '1.0' -needs_sphinx = '1.3' -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = ['sphinxcontrib.httpdomain', 'sphinx.ext.autodoc', - 'sphinx.ext.viewcode', 'sphinx.ext.napoleon'] -# Disable javasphinx generation until we have a solution to long build -# times. readthedocs timesout after 902 seconds. - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -# source_suffix = ['.rst', '.md'] -source_suffix = '.rst' - -# The encoding of source files. -# source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = '' -copyright = '2017, OPNFV. Licensed under CC BY 4.0' -author = 'Open Platform for NFV' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = 'Latest' -# The full version, including alpha/beta/rc tags. -release = 'Latest' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -# today = '' -# Else, today_fmt is used as the format for a strftime call. -# today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This patterns also effect to html_static_path and html_extra_path -exclude_patterns = [] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -# default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -# add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -# add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -# show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -# modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -# keep_warnings = False - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = False - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = 'opnfv' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -# html_theme_options = {} -html_theme_options = { - 'bootswatch_theme': "journal", - 'navbar_sidebarrel': False, -} - -# Add any paths that contain custom themes here, relative to this directory. -# html_theme_path = [] -html_theme_path = sphinx_opnfv_theme.get_html_theme_path() - -# The name for this set of Sphinx documents. -# "<project> v<release> documentation" by default. -# html_title = 'OpenDaylight Documentation v0.3.0' - -# A shorter title for the navigation bar. Default is the same as html_title. -# html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -html_logo = '_static/opnfv-logo.png' - -# The name of an image file (relative to this directory) to use as a favicon of -# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -html_favicon = '_static/favicon.ico' - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -# html_extra_path = [] - -# If not None, a 'Last updated on:' timestamp is inserted at every page -# bottom, using the given strftime format. -# The empty string is equivalent to '%b %d, %Y'. -# html_last_updated_fmt = None - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -# html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -# html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -# html_additional_pages = {} - -# If false, no module index is generated. -# html_domain_indices = True - -# If false, no index is generated. -# html_use_index = True - -# If true, the index is split into individual pages for each letter. -# html_split_index = False - -# If true, links to the reST sources are added to the pages. -# html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -# html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -# html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a <link> tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -# html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = None - -# Language to be used for generating the HTML full-text search index. -# Sphinx supports the following languages: -# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja' -# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh' -# html_search_language = 'en' - -# A dictionary with options for the search language support, empty by default. -# 'ja' uses this config value. -# 'zh' user can custom change `jieba` dictionary path. -# html_search_options = {'type': 'default'} - -# The name of a javascript file (relative to the configuration directory) that -# implements a search results scorer. If empty, the default will be used. -# html_search_scorer = 'scorer.js' - -# Output file base name for HTML help builder. -htmlhelp_basename = 'OPNFV' - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - #'papersize': 'letterpaper', - - # The font size ('10pt', '11pt' or '12pt'). - #'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - #'preamble': '', - - # Latex figure (float) alignment - #'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - (master_doc, 'OPNFV.tex', 'OPNFV Documentation', - 'OPNFV Project', 'manual'), +linkcheck_ignore = [ + 'https://github.com/opnfv/functest/blob/master/docs/testing/user/userguide/test_details.rst#', + 'https://review.openstack.org/#' ] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -# latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -# latex_use_parts = False - -# If true, show page references after internal links. -# latex_show_pagerefs = False - -# If true, show URL addresses after external links. -# latex_show_urls = False - -# Documents to append as an appendix to all manuals. -# latex_appendices = [] - -# If false, no module index is generated. -# latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - (master_doc, 'OPNFVDocs', 'OPNFV Documentation', - [author], 1) -] - -# If true, show URL addresses after external links. -# man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - (master_doc, 'OPNFVDocs', 'OPNFV Documentation', - author, 'OPNFV', 'One line description of project.', - 'Miscellaneous'), -] - -html_sidebars = {'**': ['localtoc.html', 'relations.html'],} -# Documents to append as an appendix to all manuals. -# texinfo_appendices = [] - -# If false, no module index is generated. -# texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -# texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -# texinfo_no_detailmenu = False - -# intersphinx_mapping = -# {'RTD':('http://opnfvdocsdemo.readthedocs.io/projects/', None)} diff --git a/docs/conf.yaml b/docs/conf.yaml new file mode 100644 index 00000000..5b62ac6e --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: opnfv +project: dovetail diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..88523e3b --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,24 @@ +.. 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 + +.. _<project-name>: dovetail + +======== +Dovetail +======== + +.. toctree:: + :numbered: + :maxdepth: 1 + + testing/user/certificationworkflow/index + testing/user/ovpaddendum/index + testing/user/reviewerguide/index + testing/user/systempreparation/index + testing/user/testspecification/index + testing/user/userguide/index + + testing/developer/testcaserequirements/index + + release/release-notes/index diff --git a/docs/release/release-notes/dovetail-release.rst b/docs/release/release-notes/dovetail-release.rst deleted file mode 100644 index 20129caf..00000000 --- a/docs/release/release-notes/dovetail-release.rst +++ /dev/null @@ -1,299 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. SPDX-License-Identifier: CC-BY-4.0 - -======= -License -======= - -OPNFV Fraser release note for Dovetail Docs -are licensed under a Creative Commons Attribution 4.0 International License. -You should have received a copy of the license along with this. -If not, see http://creativecommons.org/licenses/by/4.0/. - -================================================================== -OPNFV Verified Program (OVP) 2018.09 / Dovetail 2.0.0 Release Note -================================================================== - -Abstract -======== - -This document describes the release note of the OPNFV Verified Program and the Dovetail project. - - -Version History -=============== - -+------------+----------+--------------------------+ -| **Date** | **Ver.** | **Comment** | -| | | | -+------------+----------+--------------------------+ -| 2018-01-21 | 1.0.0 | Dovetail for OVP 2018.01 | -| | | Danube release | -+------------+----------+--------------------------+ -| 2018-08-09 | 2.0.0 | Dovetail for OVP 2018.09 | -| | | Fraser release | -+------------+----------+--------------------------+ - - -OPNFV 2018.09 Release -===================== - -The OPNFV Verified Program (OVP) allows vendors and operators to obtain 'OPNFV Verified' -status based on an agreed upon set of compliance verification test cases that align to OPNFV -releases. The reference System under Test (SUT) are the NFV components deployed by the OPNFV -installers for a given release, where OVP 2018.09 is based on the Fraser release. Participants -of the program can verify commercial or open source offerings against an OVP release. This implies -that the SUT used for verification has interfaces, components, functions and behaviors that align -to OPNFV installer integrations. - -Dovetail is the overall framework used to execute tests and collect results for OVP. Dovetail does -not deliver test content directly. Rather, test content is developed in other OPNFV test frameworks -such as Functest and upstream test communities such as OpenStack's RefStack/Tempest projects. -Dovetail leverages this upstream test content and provides a common set of test platform services -for the OVP. - -Dovetail works in conjunction with a web portal interface dubbed the 'OVP web portal' to allow -users to upload test results to a centralized community repository. This facilitates user -collaboration, result sharing, self-testing and community reviews. It also serves as a hub for -new participants to learn about the program and access key resources. The link for this portal -is at: `OPNFV Verified Program <https://verified.opnfv.org>`_. - -Use of the OVP web portal is open to all and only requires a valid Linux Foundation or OpenStack -ID to login. Users are welcome to use the portal to upload, inspect and share results in a private -manner. In order to submit results for official review, the first step is apply for acceptance -into the program with the participation form provided in the link: `OPNFV Verified Program -Participation Form <https://na3.docusign.net/Member/PowerFormSigning.aspx?PowerFormId=579ac00d-0a1f-4db3-82ea-ddd977769a60>`_ - -Test Suites & Test Areas ------------------------- - -OVP/Dovetail groups test cases into test suites and test areas. Test suites are currently a basic -categorization around releases for the most part. Executing the test suite 'ovp.2018.09' without -further specification will run all the test cases in the OVP 2018.09 release. Test suites are -divided into test areas that can be executed separately. - -Test areas include a division into **'mandatory'** and **'optional'** in an overarching -categorization. - -All the mandatory test cases are required to be executed with passing results for all inclusive -test cases for results to be reviewed and approved by the community made up of peer reviewers. -The optional test cases are not required to be executed for the official compliance verification -review in the OVP 2018.09 release. However, execution of these cases is encouraged, as some -optional test cases may become mandatory in future releases. - -Test Cases and Sub Test Cases ------------------------------ - -Each test area consists of multiple test cases where each test case can be a single test or -broken down into sub test cases. A listing of test cases with the number of sub test cases noted -in parenthesis is shown below for the OVP 2018.09 release. - -**Mandatory** - -- functest.vping.userdata (1) -- functest.vping.ssh (1) -- bottlenecks.stress.ping (1) -- functest.tempest.osinterop (200) -- functest.tempest.compute (12) -- functest.tempest.identity_v3 (11) -- functest.tempest.image (2) -- functest.tempest.network_api (14) -- functest.tempest.volume (2) -- functest.tempest.neutron_trunk_ports (38) -- functest.tempest.ipv6_api (21) -- functest.security.patrole (119) -- yardstick.ha.nova_api (1) -- yardstick.ha.neutron_server (1) -- yardstick.ha.keystone (1) -- yardstick.ha.glance_api (1) -- yardstick.ha.cinder_api (1) -- yardstick.ha.cpu_load (1) -- yardstick.ha.disk_load (1) -- yardstick.ha.haproxy (1) -- yardstick.ha.rabbitmq (1) -- yardstick.ha.database (1) - - -There are a total of 432 mandatory test cases. - -**Optional** - -- functest.vnf.vims (1) -- functest.vnf.vepc (1) -- functest.snaps.smoke (1) -- yardstick.ha.neutron_l3_agent (1) -- yardstick.ha.controller_restart (1) -- functest.tempest.ipv6_scenario (8) -- functest.tempest.multi_node_scheduling (6) -- functest.tempest.network_security (6) -- functest.tempest.vm_lifecycle (12) -- functest.tempest.network_scenario (5) -- functest.tempest.bgpvpn (15) -- functest.bgpvpn.subnet_connectivity (1) -- functest.bgpvpn.tenant_separation (1) -- functest.bgpvpn.router_association (1) -- functest.bgpvpn.router_association_floating_ip (1) - - -There are a total of 61 optional test cases. - -OPNFV Test Projects and Components ----------------------------------- - -The OPNFV test frameworks integrated into the Dovetail framework that deliver test content are: - - * Functest (leverages OpenStack RefStack/Tempest projects in addition to supplying native test cases) - * Yardstick - * Bottlenecks - - -Acceptence and Marketing ------------------------- - -Upon successful community review of results for OVP 2018.09, the Linux Foundation Compliance -Verification Committee (LFN CVC) on behalf of the Board of Directors can award a product 'OPNFV -Verified' status. Use of 'OPNFV Verified' Program Marks shall be awarded to the platform used -for compliance verification. The category label of 'Infrastructure' is used within the Program -Marks logo and limits the scope of this OVP release to a SUT consisting of NFVI and VIM components -using ETSI terminology. It does not provide compliance verification for specific VNFs in any fashion. -The date '2018.09' corresponds to a reference SUT that aligns to the OPNFV Fraser release and -currently aligns to the Dovetail framework version 2.0.0. - -Organizations shall not use the Program Marks in any way that would associate it with any -individual or company logo or brand, beyond the association to the specific platform to which it -was awarded. While OpenStack RefStack interoperability and Tempest integration test cases are -executed as part of the OVP 2018.09 compliance verification test suites, the OVP does not grant or -award OpenStack Marks in any fashion. 'OPNFV Verified' status does not assert readiness for -commercial deployment. - -Please refer to the program governance guidelines and term & conditions documents for additional -details using the respective links: - -* `OVP Governance Guidelines <https://www.opnfv.org/wp-content/uploads/sites/12/2018/01/OVP-Governance-Guidelines-1.0.1-012218.pdf>`_ -* `OVP Terms and Conditions <https://www.opnfv.org/wp-content/uploads/sites/12/2018/01/OVP-Terms-and-Conditions-011918.pdf>`_ - -Release Data -============ - -+--------------------------------------+---------------------------------------+ -| **Project** | Dovetail | -| | | -+--------------------------------------+---------------------------------------+ -| **Repo tag** | ovp.2.0.0 | -| | | -+--------------------------------------+---------------------------------------+ -| **Release designation** | OPNFV Verified Program (OVP) | -| | 2018.09 (Fraser) | -+--------------------------------------+---------------------------------------+ -| **Release date** | August xxxx 2018 | -| | | -+--------------------------------------+---------------------------------------+ -| **Purpose of the delivery** | Support OVP 2018.09 release with | -| | OPNFV Fraser release as reference SUT | -+--------------------------------------+---------------------------------------+ - -Deliverables -============ - -Software --------- -+-------------------------+-----------------------------------+---------------+ -| **Docker Container** | **Docker Image** | **Tag** | -+-------------------------+-----------------------------------+---------------+ -| dovetail | opnfv/dovetail | ovp.2.0.0 | -+-------------------------+-----------------------------------+---------------+ -| functest | opnfv/functest-smoke | fraser | -+-------------------------+-----------------------------------+---------------+ -| functest | opnfv/functest-healthcheck | fraser | -+-------------------------+-----------------------------------+---------------+ -| functest | opnfv/functest-features | fraser | -+-------------------------+-----------------------------------+---------------+ -| functest | opnfv/functest-vnf | fraser | -+-------------------------+-----------------------------------+---------------+ -| yardstick | opnfv/yardstick | stable | -+-------------------------+-----------------------------------+---------------+ -| bottlenecks | opnfv/bottlenecks | stable | -+-------------------------+-----------------------------------+---------------+ - - -Docker images: - -- `Dovetail Docker images <https://hub.docker.com/r/opnfv/dovetail>`_ -- `Functest-smoke Docker images <https://hub.docker.com/r/opnfv/functest-smoke/>`_ -- `Functest-healthcheck Docker images <https://hub.docker.com/r/opnfv/functest-healthcheck/>`_ -- `Functest-features Docker images <https://hub.docker.com/r/opnfv/functest-features/>`_ -- `Functest-vnf Docker images <https://hub.docker.com/r/opnfv/functest-vnf/>`_ -- `Yardstick Docker images <https://hub.docker.com/r/opnfv/yardstick/>`_ -- `Bottlenecks Docker images <https://hub.docker.com/r/opnfv/bottlenecks/>`_ - - - -Documents ---------- - -- `System Preparation Guide <http://docs.opnfv.org/en/stable-fraser/submodules/dovetail/docs/testing/user/systempreparation/index.html>`_ - -- `User Guide <http://docs.opnfv.org/en/stable-fraser/submodules/dovetail/docs/testing/user/userguide/testing_guide.html>`_ - -- `OPV Test Specifications <http://docs.opnfv.org/en/stable-fraser/submodules/dovetail/docs/testing/user/testspecification/index.html>`_ - -- `Dovetail CLI Reference <http://docs.opnfv.org/en/stable-fraser/submodules/dovetail/docs/testing/user/userguide/cli_reference.html>`_ - -- `OPV Workflow <http://docs.opnfv.org/en/stable-fraser/submodules/dovetail/docs/testing/user/certificationworkflow/index.html>`_ - -- `OPV Reviewer Guide <http://docs.opnfv.org/en/stable-fraser/submodules/dovetail/docs/testing/user/reviewerguide/index.html>`_ - - -Testing with OPNFV Fraser Installers -==================================== - -OVP 2018.09 and Dovetail 2.0.0 are known to be have been tested with the following OPNFV -Fraser installer versions. - -+-----------------+----------------------+ -| Installer | Version | -+=================+======================+ -| Apex | opnfv-6.2.0 | -+-----------------+----------------------+ -| Compass | opnfv-6.2.0 | -+-----------------+----------------------+ -| Fuel | fraser.x.x | -+-----------------+----------------------+ - - -Fraser Known Restrictions/Issues -================================ - -Please refer to the following link for known issues with the Dovetail Fraser release: - -.. https://wiki.opnfv.org/display/dovetail/Running+history+for+the+dovetail+tool#Runninghistoryforthedovetailtool-4.KnownIssuesList - -Open JIRA Tickets -================= - -+------------------+-----------------------------------------------+ -| JIRA | Description | -+==================+===============================================+ -| | | -| xxxxxx | | -+------------------+-----------------------------------------------+ - -All blocking tickets have been fixed. - - -Useful Links -============ - - - `OVP Web Portal <https://verified.opnfv.org>`_ - - - `Wiki Project Page <https://wiki.opnfv.org/display/dovetail>`_ - - - `Dovetail Repo <https://git.opnfv.org/dovetail/>`_ - - - `Dovetail CI dashboard <https://build.opnfv.org/ci/view/dovetail/>`_ - - - `JIRA dashboard <https://jira.opnfv.org/secure/RapidBoard.jspa?rapidView=149>`_ - - - Dovetail IRC Channel: #opnfv-dovetail - - - `Dovetail Test Configuration <https://git.opnfv.org/dovetail/tree/dovetail/compliance/ovp.1.0.0.yml>`_ diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst index ad4cade0..0332622f 100644 --- a/docs/release/release-notes/index.rst +++ b/docs/release/release-notes/index.rst @@ -3,18 +3,259 @@ .. _dovetail-releasenotes: -********************** -Dovetail Release Notes -********************** +================================================================== +OPNFV Verified Program (OVP) 2018.09 / Dovetail 2.0.0 Release Note +================================================================== -.. toctree:: - :numbered: - :maxdepth: 4 - dovetail-release.rst +OPNFV 2018.09 Release +===================== -Revision: _sha1_ +The OPNFV Verified Program (OVP) allows vendors and operators to obtain 'OPNFV Verified' +status based on an agreed upon set of compliance verification test cases that align to OPNFV +releases. The reference System under Test (SUT) are the NFV components deployed by the OPNFV +installers for a given release, where OVP 2018.09 is based on the Fraser release. Participants +of the program can verify commercial or open source offerings against an OVP release. This implies +that the SUT used for verification has interfaces, components, functions and behaviors that align +to OPNFV installer integrations. -:Author: Eddie Arrage (eddie.arrage@huawei.com) +Dovetail is the overall framework used to execute tests and collect results for OVP. Dovetail does +not deliver test content directly. Rather, test content is developed in other OPNFV test frameworks +such as Functest and upstream test communities such as OpenStack's RefStack/Tempest projects. +Dovetail leverages this upstream test content and provides a common set of test platform services +for the OVP. -Build date: |today| +Dovetail works in conjunction with a web portal interface dubbed the 'OVP web portal' to allow +users to upload test results to a centralized community repository. This facilitates user +collaboration, result sharing, self-testing and community reviews. It also serves as a hub for +new participants to learn about the program and access key resources. The link for this portal +is at: `OPNFV Verified Program <https://verified.opnfv.org>`_. + +Use of the OVP web portal is open to all and only requires a valid Linux Foundation or OpenStack +ID to login. Users are welcome to use the portal to upload, inspect and share results in a private +manner. In order to submit results for official review, the first step is apply for acceptance +into the program with the participation form provided in the link: `OPNFV Verified Program +Participation Form <https://na3.docusign.net/Member/PowerFormSigning.aspx?PowerFormId=579ac00d-0a1f-4db3-82ea-ddd977769a60>`_ + +Test Suites & Test Areas +------------------------ + +OVP/Dovetail groups test cases into test suites and test areas. Test suites are currently a basic +categorization around releases for the most part. Executing the test suite 'ovp.2018.09' without +further specification will run all the test cases in the OVP 2018.09 release. Test suites are +divided into test areas that can be executed separately. + +Test areas include a division into **'mandatory'** and **'optional'** in an overarching +categorization. + +All the mandatory test cases are required to be executed with passing results for all inclusive +test cases for results to be reviewed and approved by the community made up of peer reviewers. +The optional test cases are not required to be executed for the official compliance verification +review in the OVP 2018.09 release. However, execution of these cases is encouraged, as some +optional test cases may become mandatory in future releases. + +Test Cases and Sub Test Cases +----------------------------- + +Each test area consists of multiple test cases where each test case can be a single test or +broken down into sub test cases. A listing of test cases with the number of sub test cases noted +in parenthesis is shown below for the OVP 2018.09 release. + +**Mandatory** + +- functest.vping.userdata (1) +- functest.vping.ssh (1) +- bottlenecks.stress.ping (1) +- functest.tempest.osinterop (200) +- functest.tempest.compute (12) +- functest.tempest.identity_v3 (11) +- functest.tempest.image (2) +- functest.tempest.network_api (14) +- functest.tempest.volume (2) +- functest.tempest.neutron_trunk_ports (38) +- functest.tempest.ipv6_api (21) +- functest.security.patrole (119) +- yardstick.ha.nova_api (1) +- yardstick.ha.neutron_server (1) +- yardstick.ha.keystone (1) +- yardstick.ha.glance_api (1) +- yardstick.ha.cinder_api (1) +- yardstick.ha.cpu_load (1) +- yardstick.ha.disk_load (1) +- yardstick.ha.haproxy (1) +- yardstick.ha.rabbitmq (1) +- yardstick.ha.database (1) + + +There are a total of 432 mandatory test cases. + +**Optional** + +- functest.vnf.vims (1) +- functest.vnf.vepc (1) +- functest.snaps.smoke (1) +- yardstick.ha.neutron_l3_agent (1) +- yardstick.ha.controller_restart (1) +- functest.tempest.ipv6_scenario (8) +- functest.tempest.multi_node_scheduling (6) +- functest.tempest.network_security (6) +- functest.tempest.vm_lifecycle (12) +- functest.tempest.network_scenario (5) +- functest.tempest.bgpvpn (15) +- functest.bgpvpn.subnet_connectivity (1) +- functest.bgpvpn.tenant_separation (1) +- functest.bgpvpn.router_association (1) +- functest.bgpvpn.router_association_floating_ip (1) + + +There are a total of 61 optional test cases. + +OPNFV Test Projects and Components +---------------------------------- + +The OPNFV test frameworks integrated into the Dovetail framework that deliver test content are: + + * Functest (leverages OpenStack RefStack/Tempest projects in addition to supplying native test cases) + * Yardstick + * Bottlenecks + + +Acceptence and Marketing +------------------------ + +Upon successful community review of results for OVP 2018.09, the Linux Foundation Compliance +Verification Committee (LFN CVC) on behalf of the Board of Directors can award a product 'OPNFV +Verified' status. Use of 'OPNFV Verified' Program Marks shall be awarded to the platform used +for compliance verification. The category label of 'Infrastructure' is used within the Program +Marks logo and limits the scope of this OVP release to a SUT consisting of NFVI and VIM components +using ETSI terminology. It does not provide compliance verification for specific VNFs in any fashion. +The date '2018.09' corresponds to a reference SUT that aligns to the OPNFV Fraser release and +currently aligns to the Dovetail framework version 2.0.0. + +Organizations shall not use the Program Marks in any way that would associate it with any +individual or company logo or brand, beyond the association to the specific platform to which it +was awarded. While OpenStack RefStack interoperability and Tempest integration test cases are +executed as part of the OVP 2018.09 compliance verification test suites, the OVP does not grant or +award OpenStack Marks in any fashion. 'OPNFV Verified' status does not assert readiness for +commercial deployment. + +Please refer to the program governance guidelines and term & conditions documents for additional +details using the respective links: + +* `OVP Governance Guidelines <https://www.opnfv.org/wp-content/uploads/sites/12/2018/01/OVP-Governance-Guidelines-1.0.1-012218.pdf>`_ +* `OVP Terms and Conditions <https://www.opnfv.org/wp-content/uploads/sites/12/2018/01/OVP-Terms-and-Conditions-011918.pdf>`_ + +Release Data +============ + ++--------------------------------------+---------------------------------------+ +| **Project** | Dovetail | +| | | ++--------------------------------------+---------------------------------------+ +| **Repo tag** | ovp.2.0.0 | +| | | ++--------------------------------------+---------------------------------------+ +| **Release designation** | OPNFV Verified Program (OVP) | +| | 2018.09 (Fraser) | ++--------------------------------------+---------------------------------------+ +| **Release date** | September 2018 | +| | | ++--------------------------------------+---------------------------------------+ +| **Purpose of the delivery** | Support OVP 2018.09 release with | +| | OPNFV Fraser release as reference SUT | ++--------------------------------------+---------------------------------------+ + +Deliverables +============ + +Software +-------- ++-------------------------+-----------------------------------+---------------+ +| **Docker Container** | **Docker Image** | **Tag** | ++-------------------------+-----------------------------------+---------------+ +| dovetail | opnfv/dovetail | ovp.2.0.0 | ++-------------------------+-----------------------------------+---------------+ +| functest | opnfv/functest-smoke | fraser | ++-------------------------+-----------------------------------+---------------+ +| functest | opnfv/functest-healthcheck | fraser | ++-------------------------+-----------------------------------+---------------+ +| functest | opnfv/functest-features | fraser | ++-------------------------+-----------------------------------+---------------+ +| functest | opnfv/functest-vnf | fraser | ++-------------------------+-----------------------------------+---------------+ +| yardstick | opnfv/yardstick | stable | ++-------------------------+-----------------------------------+---------------+ +| bottlenecks | opnfv/bottlenecks | stable | ++-------------------------+-----------------------------------+---------------+ + + +Docker images: + +- `Dovetail Docker images <https://hub.docker.com/r/opnfv/dovetail>`_ +- `Functest-smoke Docker images <https://hub.docker.com/r/opnfv/functest-smoke/>`_ +- `Functest-healthcheck Docker images <https://hub.docker.com/r/opnfv/functest-healthcheck/>`_ +- `Functest-features Docker images <https://hub.docker.com/r/opnfv/functest-features/>`_ +- `Functest-vnf Docker images <https://hub.docker.com/r/opnfv/functest-vnf/>`_ +- `Yardstick Docker images <https://hub.docker.com/r/opnfv/yardstick/>`_ +- `Bottlenecks Docker images <https://hub.docker.com/r/opnfv/bottlenecks/>`_ + + + +Documents +--------- + +- `System Preparation Guide <http://docs.opnfv.org/en/stable-fraser/submodules/dovetail/docs/testing/user/systempreparation/index.html>`_ + +- `User Guide <http://docs.opnfv.org/en/stable-fraser/submodules/dovetail/docs/testing/user/userguide/testing_guide.html>`_ + +- `OPV Test Specifications <http://docs.opnfv.org/en/stable-fraser/submodules/dovetail/docs/testing/user/testspecification/index.html>`_ + +- `Dovetail CLI Reference <http://docs.opnfv.org/en/stable-fraser/submodules/dovetail/docs/testing/user/userguide/cli_reference.html>`_ + +- `OPV Workflow <http://docs.opnfv.org/en/stable-fraser/submodules/dovetail/docs/testing/user/certificationworkflow/index.html>`_ + +- `OPV Reviewer Guide <http://docs.opnfv.org/en/stable-fraser/submodules/dovetail/docs/testing/user/reviewerguide/index.html>`_ + + +Testing with OPNFV Fraser Installers +==================================== + +OVP 2018.09 and Dovetail 2.0.0 are known to be have been tested with the following OPNFV +Fraser installer versions. + ++-----------------+----------------------+ +| Installer | Version | ++=================+======================+ +| Apex | stable/fraser | ++-----------------+----------------------+ +| Compass | stable/fraser | ++-----------------+----------------------+ +| Fuel | stable/fraser | ++-----------------+----------------------+ + + +Fraser Known Restrictions/Issues +================================ + +Please refer to the Dovetail project JIRA for known issues with the Dovetail +Fraser release: + +.. https://jira.opnfv.org/projects/DOVETAIL + + +Useful Links +============ + + - `OVP Web Portal <https://verified.opnfv.org>`_ + + - `Wiki Project Page <https://wiki.opnfv.org/display/dovetail>`_ + + - `Dovetail Repo <https://git.opnfv.org/dovetail/>`_ + + - `Dovetail CI dashboard <https://build.opnfv.org/ci/view/dovetail/>`_ + + - `JIRA dashboard <https://jira.opnfv.org/secure/RapidBoard.jspa?rapidView=149>`_ + + - Dovetail IRC Channel: #opnfv-dovetail + + - `Dovetail Test Configuration <https://git.opnfv.org/dovetail/tree/etc/compliance/ovp.2018.09.yaml>`_ diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..44084358 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,5 @@ +lfdocs-conf +sphinx_opnfv_theme +# Uncomment the following line if your project uses Sphinx to document +# HTTP APIs +# sphinxcontrib-httpdomain diff --git a/docs/testing/user/ovpaddendum/exemption-strict-API-validation.rst b/docs/testing/user/ovpaddendum/exemption-strict-API-validation.rst index b4466111..aaac6c4c 100644 --- a/docs/testing/user/ovpaddendum/exemption-strict-API-validation.rst +++ b/docs/testing/user/ovpaddendum/exemption-strict-API-validation.rst @@ -89,7 +89,7 @@ Example: additional attributes per VM for HA policy --------------------------------------------------- This fictional example showcases the presence of an additional attribute in an -API response. The example shows that the 'server details', i.e. the VM +API response. The example shows that the 'server details' [3]_, i.e. the VM metadata, includes an additional attribute 'ha-policy' which is used to associate high-availability policies with a VM instance. This attribute is utilized by a proprietary add-on component to manage VM migration and recovery diff --git a/docs/testing/user/reviewerguide/index.rst b/docs/testing/user/reviewerguide/index.rst index 25dc2f68..dd9456ce 100644 --- a/docs/testing/user/reviewerguide/index.rst +++ b/docs/testing/user/reviewerguide/index.rst @@ -155,7 +155,7 @@ The bottlenecks log must contain the 'SUCCESS' result as shown in following exam Functest logs opens an html page that lists all test cases as shown in figure 7. All test cases must have run successfuly. -.. image:: images/ovp_log_functest_image.png +.. image:: images/ovp_log_files_functest_image.png :align: center :scale: 100% diff --git a/docs/testing/user/systempreparation/index.rst b/docs/testing/user/systempreparation/index.rst index 4e101146..5bc150a3 100644 --- a/docs/testing/user/systempreparation/index.rst +++ b/docs/testing/user/systempreparation/index.rst @@ -52,7 +52,7 @@ The SUT is expected to be connected with high performance networks. These networ are expected in the SUT: - A management network by which the Test Node can reach all identity, image, network, -and compute services in the SUT + and compute services in the SUT - A data network that supports the virtual network capabilities and data path testing Additional networks, such as Light Out Management or storage networks, may be diff --git a/docs/testing/user/testspecification/highavailability/index.rst b/docs/testing/user/testspecification/highavailability/index.rst index e024b1fc..dd98ba94 100644 --- a/docs/testing/user/testspecification/highavailability/index.rst +++ b/docs/testing/user/testspecification/highavailability/index.rst @@ -810,9 +810,10 @@ For second monitor is used a process monitor and the main purpose is to watch whether the database processes on the host node are killed properly. Therefore, in this test case, there are two metrics: -- service_outage_time, which indicates the maximum outage time (seconds) + +* service_outage_time, which indicates the maximum outage time (seconds) of the specified OpenStack command request -- process_recover_time, which indicates the maximum time (seconds) from the +* process_recover_time, which indicates the maximum time (seconds) from the process being killed to recovered Test execution @@ -1056,7 +1057,7 @@ Process recovery is verified by checking the existence of processes of Test execution '''''''''''''' * Test action 1: Two host VMs are booted, these two hosts are in two different -networks, the networks are connected by a virtual router. + networks, the networks are connected by a virtual router. * Test action 2: Start monitors: each monitor will run with independently process. The monitor info will be collected. * Test action 3: Do attacker: Connect the host through SSH, and then execute the kill diff --git a/docs/testing/user/testspecification/index.rst b/docs/testing/user/testspecification/index.rst index fff07ee9..9fff4689 100644 --- a/docs/testing/user/testspecification/index.rst +++ b/docs/testing/user/testspecification/index.rst @@ -25,24 +25,24 @@ All tests areas addressed in the OVP are covered in the following test specification documents. .. toctree:: - :maxdepth: 1 - - ./highavailability/index.rst - ./tempest_osinterop/index.rst - ./vping/index.rst - ./tempest_trunk_ports/index.rst - ./security_patrole/index.rst - ./tempest_ipv6/index.rst - ./tempest_network_security/index.rst - ./tempest_network/network_scenario.rst - ./tempest_vm_lifecycle/index.rst - ./tempest_multi_node_scheduling/index.rst - ./vpn/index.rst - ./vnf/index.rst - ./stress/index.rst - ./snaps_smoke/index.rst - ./tempest_compute/index.rst - ./tempest_identity_v3/index.rst - ./tempest_image/index.rst - ./tempest_network/index.rst - ./tempest_volume/index.rst
\ No newline at end of file + :maxdepth: 2 + + highavailability/index + security_patrole/index + snaps_smoke/index + stress/index + tempest_compute/index + tempest_identity_v3/index + tempest_image/index + tempest_ipv6/index + tempest_multi_node_scheduling/index + tempest_network_api/index + tempest_network_scenario/index + tempest_network_security/index + tempest_osinterop/index + tempest_trunk_ports/index + tempest_vm_lifecycle/index + tempest_volume/index + vnf/index + vping/index + vpn/index diff --git a/docs/testing/user/testspecification/stress/index.rst b/docs/testing/user/testspecification/stress/index.rst index 41c84e7c..74961fd1 100644 --- a/docs/testing/user/testspecification/stress/index.rst +++ b/docs/testing/user/testspecification/stress/index.rst @@ -18,7 +18,7 @@ the SUT is able to absorb failures while providing an acceptable level of servic References -================ +========== This test area references the following specifications, definitions and reviews: @@ -96,7 +96,7 @@ Basic test flow execution description and pass/fail criteria ------------------------------------------------------------ Methodology for validating capacity of the SUT -''''''''''''''''''''''''''''''''''''''''''''' +'''''''''''''''''''''''''''''''''''''''''''''' Validating capacity of the SUT based on life-cycle ping test generally involves 2 subtests which provides secondary validation for the SUT furnishing users with reliable capacity without being crushed. diff --git a/docs/testing/user/testspecification/tempest_identity_v3/index.rst b/docs/testing/user/testspecification/tempest_identity_v3/index.rst index e5e8f901..bb60b204 100644 --- a/docs/testing/user/testspecification/tempest_identity_v3/index.rst +++ b/docs/testing/user/testspecification/tempest_identity_v3/index.rst @@ -31,7 +31,7 @@ These runtime operations may include that create, list, verify and delete: References ========== -`Identity API v3.0 <https://developer.openstack.org/api-ref/identity/v3/index.html.`_ +`Identity API v3.0 <https://developer.openstack.org/api-ref/identity/v3/index.html>`_ System Under Test (SUT) ======================= @@ -52,7 +52,7 @@ OVP test suite. - `Create, Get, Update and Delete Credentials <https://github.com/openstack/tempest/blob/12.2.0/tempest/api/identity/admin/v3/test_credentials.py#L21>`_ - tempest.api.identity.admin.v3.test_credentials.CredentialsTestJSON.test_credentials_create_get_update_delete -- `Create and Verify Domain <https://github.com/openstack/tempest/blob/12.2.0/tempest/api/identity/admin/v3/test_domains.py#L159>`_ +- `Create and Verify Domain <https://github.com/openstack/tempest/blob/12.2.0/tempest/api/identity/admin/v3/test_domains.py#L159>`_ - tempest.api.identity.admin.v3.test_domains.DefaultDomainTestJSON.test_default_domain_exists - `Create, Update and Delete Domain <https://github.com/openstack/tempest/blob/12.2.0/tempest/api/identity/admin/v3/test_domains.py>`_ @@ -80,4 +80,4 @@ OVP test suite. - tempest.api.identity.admin.v3.test_trusts.TrustsV3TestJSON.test_get_trusts_all - `List API Versions <https://github.com/openstack/tempest/blob/18.0.0/tempest/api/identity/v3/test_api_discovery.py>`_ - - tempest.api.identity.v3.test_api_discovery.TestApiDiscovery.test_list_api_versions
\ No newline at end of file + - tempest.api.identity.v3.test_api_discovery.TestApiDiscovery.test_list_api_versions diff --git a/docs/testing/user/testspecification/tempest_ipv6/ipv6_api.rst b/docs/testing/user/testspecification/tempest_ipv6/ipv6_api.rst index 79005329..60a5633e 100644 --- a/docs/testing/user/testspecification/tempest_ipv6/ipv6_api.rst +++ b/docs/testing/user/testspecification/tempest_ipv6/ipv6_api.rst @@ -161,10 +161,12 @@ Test preconditions ------------------ 1. The SUT has at least one external network. -2. In the external network list, there is no network without external router, i.e., -all networks in this list are with external router. + +2. In the external network list, there is no network without external router, + i.e., all networks in this list are with external router. + 3. There is one external network with configured public network id and there is -no subnet on this network + no subnet on this network Basic test flow execution description and pass/fail criteria ------------------------------------------------------------ diff --git a/docs/testing/user/testspecification/tempest_network/network_scenario.rst b/docs/testing/user/testspecification/tempest_network_scenario/index.rst index 6c172474..6c172474 100644 --- a/docs/testing/user/testspecification/tempest_network/network_scenario.rst +++ b/docs/testing/user/testspecification/tempest_network_scenario/index.rst diff --git a/docs/testing/user/testspecification/tempest_trunk_ports/index.rst b/docs/testing/user/testspecification/tempest_trunk_ports/index.rst index 0507cd9a..fd60a32e 100644 --- a/docs/testing/user/testspecification/tempest_trunk_ports/index.rst +++ b/docs/testing/user/testspecification/tempest_trunk_ports/index.rst @@ -36,7 +36,7 @@ test. For detailed information on the individual steps and assertions performed by the tests, review the Python source code accessible via the following links: - `Neutron Trunk API tests <https://github.com/openstack/neutron/blob/stable/pike/neutron/tests/tempest/api/test_trunk.py>`_ -- `Neutron Trunk API negative tests <https://github.com/openstack/neutron/blob/stable/pike/neutron/tests/tempest/api/test_trunk_details.py>`_ +- `Neutron Trunk API trunk details <https://github.com/openstack/neutron/blob/stable/pike/neutron/tests/tempest/api/test_trunk_details.py>`_ - `Neutron Trunk API negative tests <https://github.com/openstack/neutron/blob/stable/pike/neutron/tests/tempest/api/test_trunk_negative.py>`_ @@ -117,7 +117,7 @@ These group of tests comprise negative tests which verify that invalid operation are handled correctly by the system under test. Implementation: -`TrunkTestJSON <https://github.com/openstack/neutron/blob/stable/pike/neutron/tests/tempest/api/test_trunk_negative.py#L24>`_ +`TrunkTestNegative <https://github.com/openstack/neutron/blob/stable/pike/neutron/tests/tempest/api/test_trunk_negative.py#L24>`_ - neutron.tests.tempest.api.test_trunk_negative.TrunkTestJSON.test_add_subport_duplicate_segmentation_details - neutron.tests.tempest.api.test_trunk_negative.TrunkTestJSON.test_add_subport_passing_dict diff --git a/docs/testing/user/userguide/cli_reference.rst b/docs/testing/user/userguide/cli_reference.rst index 891617aa..97eccffc 100644 --- a/docs/testing/user/userguide/cli_reference.rst +++ b/docs/testing/user/userguide/cli_reference.rst @@ -72,7 +72,7 @@ Commands List | dovetail run --optional --testsuite <test_suite_name> | Run Dovetail with all optional test cases within test suite <test_suite_name> | | | | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+ -| dovetail run --debug | -d | Run Dovetail with debug mode and show all debug logs | +| dovetail run --debug | -d | Run Dovetail with debug mode and show all debug logs | | | | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+ | dovetail run --offline | Run Dovetail offline, use local docker images instead of download online | @@ -1,7 +1,11 @@ [tox] minversion = 2.5 skipsdist = True -envlist = pep8,py27 +envlist = + pep8, + py27, + docs, + docs-linkcheck [testenv] basepython=python2 @@ -34,10 +38,12 @@ ignore = E123,E125,H803,E722 exclude = .tox,dist,docs,*egg,build,.venv,.git [testenv:docs] +deps = -rdocs/requirements.txt commands = - touch ./docs/index.rst - - wget -q -nc https://raw.githubusercontent.com/opnfv/opnfvdocs/master/etc/requirements.txt -O ./docs/requirements.txt - pip install -r ./docs/requirements.txt - pip install sphinx_opnfv_theme sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html echo "Generated docs available in {toxinidir}/docs/_build/html" +whitelist_externals = echo + +[testenv:docs-linkcheck] +deps = -rdocs/requirements.txt +commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck |