summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGeorg Kunz <georg.kunz@ericsson.com>2017-10-06 16:07:17 +0200
committerGeorg Kunz <georg.kunz@ericsson.com>2017-10-23 11:44:34 +0000
commit413355acbcb70074d6861754ad8eb3de0423c417 (patch)
tree43031f0fddb6ab086009299f6de269ab2299bb59
parenta5c7a5358ab160f7518798dc977bf85fed32ddb9 (diff)
Fixing references and layout in the docs
This patchset introduces labels for documentation-internal references and replaces footnote-style citations with inline hyperlinks. Additional minor changes for a nicer rendering of bullet lists. JIRA: DOVETAIL-521 Change-Id: Ic847fc05d546d673dadc7b8efee86fcb688133f5 Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
-rw-r--r--docs/testing/developer/testcaserequirements/index.rst4
-rw-r--r--docs/testing/developer/testscope/index.rst2
-rw-r--r--docs/testing/user/certificationworkflow/index.rst66
-rw-r--r--docs/testing/user/cvpaddendum/index.rst93
-rw-r--r--docs/testing/user/systempreparation/index.rst2
-rw-r--r--docs/testing/user/testspecification/index.rst2
-rw-r--r--docs/testing/user/userguide/index.rst2
7 files changed, 90 insertions, 81 deletions
diff --git a/docs/testing/developer/testcaserequirements/index.rst b/docs/testing/developer/testcaserequirements/index.rst
index ecb56a5..daed918 100644
--- a/docs/testing/developer/testcaserequirements/index.rst
+++ b/docs/testing/developer/testcaserequirements/index.rst
@@ -2,6 +2,8 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) Ericsson AB, and others
+.. _dovetail-test_case_requirements:
+
==========================================================
Compliance Verification Program test case requirements
==========================================================
@@ -28,7 +30,7 @@ The following requirements are mandatory for a test to be submitted for
consideration in the CVP test suite:
- All test cases must be fully documented, in a common format. Please consider
- the existing :ref:`dovetail_testspecifications` as examples.
+ the existing :ref:`dovetail-test_case_specification` as examples.
- Clearly identifying the test procedure and expected results / metrics to
determine a “pass” or “fail” result.
diff --git a/docs/testing/developer/testscope/index.rst b/docs/testing/developer/testscope/index.rst
index 5e15055..218e74c 100644
--- a/docs/testing/developer/testscope/index.rst
+++ b/docs/testing/developer/testscope/index.rst
@@ -2,6 +2,8 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) OPNFV
+.. _dovetail-test_scope:
+
=======================================================
Compliance and Verification program accepted test cases
=======================================================
diff --git a/docs/testing/user/certificationworkflow/index.rst b/docs/testing/user/certificationworkflow/index.rst
index 2983192..022b2c2 100644
--- a/docs/testing/user/certificationworkflow/index.rst
+++ b/docs/testing/user/certificationworkflow/index.rst
@@ -2,6 +2,8 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) Intel Corporation, Ericsson AB, Huawei, and others
+.. _dovetail-certification_workflow:
+
================================================================
OPNFV Compliance Verification Program certification workflow
================================================================
@@ -14,7 +16,7 @@ certification. The OPNFV Compliance Verification Program (CVP) is administered b
the OPNFV Compliance and Certification (C&C) committee.
For further information about the workflow and general inquiries about the
-program, please check out the CVP web portal https://cvp.opnfv.org, or contact
+program, please check out the `CVP web portal`_, or contact
the C&C committee by email address cvp@opnfv.org. This email address should be used
for all communication with the CVP.
@@ -22,29 +24,27 @@ Step 1: Applying
================
A tester should start the process by completing an application.
-The application form can found on the CVP portal and the following
+The application form can found on the `CVP web portal`_ and the following
information should be provided:
- - Organization name
- - Organization website (if public)
- - Product name and/or identifier
- - Product specifications
- - Product public documentation
- - Product categories, choose one: (i) software and hardware (ii) software
- and third party hardware (please specify)
- - Primary contact name, business email, postal address and phone number
- Only the primary email address should be used for
- official communication with OPNFV CVP.
- - User ID for CVP web portal
- The CVP web portal supports (i) Linux Foundation user ID, and (ii) Openstack user
- ID, in the current release. Specify either one as user ID for the CVP web portal.
- If a new user ID is needed, visit https://identity.linuxfoundation.org, or
- https://www.openstack.org/join/register.
- - Location where the verification testing is to be conducted. Choose one:
- (internal vendor lab, third-party lab)
- - If the test is to be conducted by a third-party lab, please specify
- name and contact information of the third-party lab, including email, address and
- phone number.
+- Organization name
+- Organization website (if public)
+- Product name and/or identifier
+- Product specifications
+- Product public documentation
+- Product categories, choose one: (i) software and hardware (ii) software
+ and third party hardware (please specify)
+- Primary contact name, business email, postal address and phone number
+ Only the primary email address should be used for
+ official communication with OPNFV CVP.
+- User ID for CVP web portal
+ The CVP web portal supports the Linux Foundation user ID in the current release.
+ If a new user ID is needed, visit https://identity.linuxfoundation.org.
+- Location where the verification testing is to be conducted. Choose one:
+ (internal vendor lab, third-party lab)
+- If the test is to be conducted by a third-party lab, please specify
+ name and contact information of the third-party lab, including email, address and
+ phone number.
Please email the completed application using the primary contact email
account in order to establish identity.
@@ -61,12 +61,9 @@ Step 2: Testing
The following documents guide testers to prepare the test environment and run tests:
- - System Requirements and Preparation Guide for OPNFV CVP [2]
- - OPNFV CVP Test Case Specifications [3]
- - Dovetail Test Tool User Guide [4]
-
-[Editor's note: The above three documents are still work in progress. Names and
-references will be corrected when they are merged.]
+- :ref:`dovetail-system_preparation_guide`
+- :ref:`dovetail-test_case_specification`
+- :ref:`dovetail-testing_user_guide`
A unique Test ID is generated by the Dovetail tool for each test run. Please take a note
of this ID for future reference.
@@ -74,7 +71,7 @@ of this ID for future reference.
Step 3: Submitting Test Results
===============================
-Testers can upload the test results to the CVP web portal https://cvp.opnfv.org.
+Testers can upload the test results to the `CVP web portal`_.
By default, the results are visible only to the tester who uploaded the data.
Testers can self-review the test results through the portal until they are ready to ask
@@ -109,13 +106,6 @@ Step 5: Grant of Use of Logo
If an application is approved, further information will be communicated to the tester
on the guidelines of using OPNFV CVP logos and the status of compliance for promotional purposes.
-References
-==========
-
-[1] The OPNFV CVP Guidelines v.16 [Editor's note: link to be provided.]
-[2] System Requirements and Preparation Guide for OPNFV CVP [Editor's note: link to be provided.]
-[3] OPNFV CVP Test Case Specifications v1.0 [Editor's note: link to be provided.]
-[4] Dovetail Test Tool User Guide v1.0 [Editor's note: link to be provided.]
Appendix
========
@@ -124,3 +114,7 @@ Appendix
:maxdepth: 2
ApplicationForm
+
+
+.. References
+.. _`CVP web portal`: https://cvp.opnfv.org
diff --git a/docs/testing/user/cvpaddendum/index.rst b/docs/testing/user/cvpaddendum/index.rst
index 69c10b9..cd8a296 100644
--- a/docs/testing/user/cvpaddendum/index.rst
+++ b/docs/testing/user/cvpaddendum/index.rst
@@ -3,6 +3,8 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) Intel and others
+.. _dovetail-cvp_addendum:
+
====================================================================
Compliance Verification Program - Guidelines Addendum for Danube
====================================================================
@@ -49,25 +51,31 @@ SUT Assumptions
Assumptions about the System Under Test (SUT) include ...
- - The minimal specification of physical infrastructure, including controller
- nodes, compute nodes and networks, is defined by the Pharos specification
- [2].
- - The SUT is fully deployed and operational, i.e. SUT deployment tools are
- out of scope of testing.
+- The minimal specification of physical infrastructure, including controller
+ nodes, compute nodes and networks, is defined by the `Pharos specification`_.
+
+- The SUT is fully deployed and operational, i.e. SUT deployment tools are
+ out of scope of testing.
Scope of Testing
================
-The OPNFV CVP Guidelines [1], as approved by the Board of Directors, outlines
+The `OPNFV CVP Guidelines`_, as approved by the Board of Directors, outlines
the key objectives of the CVP as follows:
- - Help build the market for
- - OPNFV based infrastructure
- - applications designed to run on that infrastructure
- - Reduce adoption risks for end-users
- - Decrease testing costs by verifying hardware and software platform
- interfaces and components
- - Enhance interoperability
+
+- Help build the market for
+
+ - OPNFV based infrastructure
+
+ - applications designed to run on that infrastructure
+
+- Reduce adoption risks for end-users
+
+- Decrease testing costs by verifying hardware and software platform
+ interfaces and components
+
+- Enhance interoperability
The guidelines further directs the scope to be constrained to "features,
capabilities, components, and interfaces included in an OPNFV release that are
@@ -150,18 +158,19 @@ A basic VNF can be thought of as a single virtual machine that is networked
and can perform the simplest network functions, for example, a simple forwarding
gateway, or a set of such virtual machines connected only by simple virtual network
services. Running such basic VNF leads to a set of common requirements, including:
- - image management (Refstack testing Glance API)
- - identity management (Refstack testing Keystone Identity API)
- - virtual compute (Refstack testing Nova Compute API)
- - virtual storage (Refstack testing Cinder API)
- - virtual networks (Refstack testing Neutron Network API)
- - forwarding packets through virtual networks in data path
- - filtering packets based on security rules and port security in data path
- - dynamic network runtime operations through the life of a VNF (e.g. attach/detach,
- enable/disable, read stats)
- - correct behavior after common virtual machine life cycles events (e.g.
- suspend/resume, reboot, migrate)
- - simple virtual machine resource scheduling on multiple nodes
+
+- image management (Refstack testing Glance API)
+- identity management (Refstack testing Keystone Identity API)
+- virtual compute (Refstack testing Nova Compute API)
+- virtual storage (Refstack testing Cinder API)
+- virtual networks (Refstack testing Neutron Network API)
+- forwarding packets through virtual networks in data path
+- filtering packets based on security rules and port security in data path
+- dynamic network runtime operations through the life of a VNF (e.g. attach/detach,
+ enable/disable, read stats)
+- correct behavior after common virtual machine life cycles events (e.g.
+ suspend/resume, reboot, migrate)
+- simple virtual machine resource scheduling on multiple nodes
OPNFV mainly supports OpenStack as the VIM up to the Danube release. The
VNFs used in the CVP program, and features in scope for the program which are
@@ -373,19 +382,19 @@ Based on the previous analysis, the following items are outside the scope of
the Danube release of the CV but are being considered for inclusion in future
releases:
- - service assurance
- - use case testing
- - platform in-place upgrade
- - API backward compatibility / micro-versioning
- - workload migration
- - multi-site federation
- - service function chaining
- - platform operational insights, e.g. telemetry, logging
- - efficiency, e.g. hardware and energy footprint of the platform
- - interoperability with workload automation platforms e.g. ONAP
- - resilience
- - security and vulnerability scanning
- - performance measurements
+- service assurance
+- use case testing
+- platform in-place upgrade
+- API backward compatibility / micro-versioning
+- workload migration
+- multi-site federation
+- service function chaining
+- platform operational insights, e.g. telemetry, logging
+- efficiency, e.g. hardware and energy footprint of the platform
+- interoperability with workload automation platforms e.g. ONAP
+- resilience
+- security and vulnerability scanning
+- performance measurements
Criteria for Awarding Compliance
@@ -407,9 +416,7 @@ documented and accepted by the reviewers.
Applicants who choose to run the optional test cases can include the results
of the optional test cases to highlight the additional compliance.
-References
-==========
-
-[1] The OPNFV CVP Guidelines v.16 [Editor's note: link to be provided.]
-[2] Pharos specification xxx [Editor's note: link to be provided.]
+.. References
+.. _`OPNFV CVP Guidelines`: https://wiki.opnfv.org/display/dovetail/CVP+document
+.. _`Pharos specification`: https://wiki.opnfv.org/display/pharos/Pharos+Specification
diff --git a/docs/testing/user/systempreparation/index.rst b/docs/testing/user/systempreparation/index.rst
index 3364bec..9d05a76 100644
--- a/docs/testing/user/systempreparation/index.rst
+++ b/docs/testing/user/systempreparation/index.rst
@@ -2,6 +2,8 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) Ericsson AB
+.. _dovetail-system_preparation_guide:
+
============================================================
Compliance and Verification program system preparation guide
============================================================
diff --git a/docs/testing/user/testspecification/index.rst b/docs/testing/user/testspecification/index.rst
index f37eba4..871ec06 100644
--- a/docs/testing/user/testspecification/index.rst
+++ b/docs/testing/user/testspecification/index.rst
@@ -2,7 +2,7 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) Ericsson AB
-.. _dovetail_testspecifications:
+.. _dovetail-test_case_specification:
==================================================
Compliance Verification program test specification
diff --git a/docs/testing/user/userguide/index.rst b/docs/testing/user/userguide/index.rst
index c2dd32a..89e76c1 100644
--- a/docs/testing/user/userguide/index.rst
+++ b/docs/testing/user/userguide/index.rst
@@ -2,6 +2,8 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) OPNFV
+.. _dovetail-testing_user_guide:
+
********************************************************
Compliance Verification Program Testing User Guide
********************************************************