From 605102bb6a8a3b48f0c66d817614eec0ef42e017 Mon Sep 17 00:00:00 2001 From: opensource-tnbt Date: Tue, 20 Oct 2020 14:41:59 +0530 Subject: DOCS: Cleanup for Jerma Release. This patch cleans up documentation folder. 1. Broken links are fixed. 2. LMA docs reorganized. 3. Placeholder for K8S and Openstack Support. Remove tls_verify = False line JIRA: VSPERF-627 Signed-off-by: Sridhar K. N. Rao Change-Id: I5ef93919755d351b79fa0bd0416d7d6baeb134a9 --- .../developer/devguide/design/vswitchperf_design.rst | 2 +- docs/testing/developer/devguide/index.rst | 6 +----- .../ietf_draft/rfc8204-vsperf-bmwg-vswitch-opnfv.rst | 2 +- .../devguide/requirements/vswitchperf_ltd.rst | 16 ++++++++-------- .../devguide/requirements/vswitchperf_ltp.rst | 20 ++++++++++---------- docs/testing/developer/devguide/results/scenario.rst | 2 +- 6 files changed, 22 insertions(+), 26 deletions(-) (limited to 'docs/testing/developer/devguide') diff --git a/docs/testing/developer/devguide/design/vswitchperf_design.rst b/docs/testing/developer/devguide/design/vswitchperf_design.rst index 50682a93..5fa892e0 100644 --- a/docs/testing/developer/devguide/design/vswitchperf_design.rst +++ b/docs/testing/developer/devguide/design/vswitchperf_design.rst @@ -23,7 +23,7 @@ Example Connectivity to DUT Establish connectivity to the VSPERF DUT Linux host. If this is in an OPNFV lab following the steps provided by `Pharos `_ -to `access the POD `_ +to `access the POD `_ The followign steps establish the VSPERF environment. diff --git a/docs/testing/developer/devguide/index.rst b/docs/testing/developer/devguide/index.rst index 49659792..64a4758c 100644 --- a/docs/testing/developer/devguide/index.rst +++ b/docs/testing/developer/devguide/index.rst @@ -31,7 +31,7 @@ new techniques together. A new IETF benchmarking specification (RFC8204) is base 2015. VSPERF is also contributing to development of ETSI NFV test specifications through the Test and Open Source Working Group. -* Wiki: https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases +* Wiki: https://wiki.opnfv.org/display/vsperf * Repository: https://git.opnfv.org/vswitchperf * Artifacts: https://artifacts.opnfv.org/vswitchperf.html * Continuous Integration: https://build.opnfv.org/ci/view/vswitchperf/ @@ -43,7 +43,6 @@ Design Guides .. toctree:: :caption: Traffic Gen Integration, VSPERF Design, Test Design, Test Plan :maxdepth: 2 - :numbered: ./design/trafficgen_integration_guide.rst ./design/vswitchperf_design.rst @@ -75,6 +74,3 @@ VSPERF CI Test Cases :numbered: CI Test cases run daily on the VSPERF Pharos POD for master and stable branches. - - ./results/scenario.rst - ./results/results.rst diff --git a/docs/testing/developer/devguide/requirements/ietf_draft/rfc8204-vsperf-bmwg-vswitch-opnfv.rst b/docs/testing/developer/devguide/requirements/ietf_draft/rfc8204-vsperf-bmwg-vswitch-opnfv.rst index ee7f98b5..10b07d54 100644 --- a/docs/testing/developer/devguide/requirements/ietf_draft/rfc8204-vsperf-bmwg-vswitch-opnfv.rst +++ b/docs/testing/developer/devguide/requirements/ietf_draft/rfc8204-vsperf-bmwg-vswitch-opnfv.rst @@ -13,7 +13,7 @@ informational RFC published by the IETF available here https://tools.ietf.org/ht For more information about VSPERF refer to: -* Wiki: https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases +* Wiki: https://wiki.opnfv.org/display/vsperf * Repository: https://git.opnfv.org/vswitchperf * Artifacts: https://artifacts.opnfv.org/vswitchperf.html * Continuous Integration: https://build.opnfv.org/ci/view/vswitchperf/ diff --git a/docs/testing/developer/devguide/requirements/vswitchperf_ltd.rst b/docs/testing/developer/devguide/requirements/vswitchperf_ltd.rst index c703ff40..1ea99f7e 100644 --- a/docs/testing/developer/devguide/requirements/vswitchperf_ltd.rst +++ b/docs/testing/developer/devguide/requirements/vswitchperf_ltd.rst @@ -62,21 +62,21 @@ References ========== * `RFC 1242 Benchmarking Terminology for Network Interconnection - Devices `__ + Devices `__ * `RFC 2544 Benchmarking Methodology for Network Interconnect - Devices `__ + Devices `__ * `RFC 2285 Benchmarking Terminology for LAN Switching - Devices `__ + Devices `__ * `RFC 2889 Benchmarking Methodology for LAN Switching - Devices `__ + Devices `__ * `RFC 3918 Methodology for IP Multicast - Benchmarking `__ + Benchmarking `__ * `RFC 4737 Packet Reordering - Metrics `__ + Metrics `__ * `RFC 5481 Packet Delay Variation Applicability - Statement `__ + Statement `__ * `RFC 6201 Device Reset - Characterization `__ + Characterization `__ .. 3.2 diff --git a/docs/testing/developer/devguide/requirements/vswitchperf_ltp.rst b/docs/testing/developer/devguide/requirements/vswitchperf_ltp.rst index e5147bea..c0b63859 100644 --- a/docs/testing/developer/devguide/requirements/vswitchperf_ltp.rst +++ b/docs/testing/developer/devguide/requirements/vswitchperf_ltp.rst @@ -63,21 +63,21 @@ References =============== * `RFC 1242 Benchmarking Terminology for Network Interconnection - Devices `__ + Devices `__ * `RFC 2544 Benchmarking Methodology for Network Interconnect - Devices `__ + Devices `__ * `RFC 2285 Benchmarking Terminology for LAN Switching - Devices `__ + Devices `__ * `RFC 2889 Benchmarking Methodology for LAN Switching - Devices `__ + Devices `__ * `RFC 3918 Methodology for IP Multicast - Benchmarking `__ + Benchmarking `__ * `RFC 4737 Packet Reordering - Metrics `__ + Metrics `__ * `RFC 5481 Packet Delay Variation Applicability - Statement `__ + Statement `__ * `RFC 6201 Device Reset - Characterization `__ + Characterization `__ .. 3.1.4 @@ -633,7 +633,7 @@ General Methodology: -------------------------- To establish the baseline performance of the virtual switch, tests would initially be run with a simple workload in the VNF (the recommended -simple workload VNF would be `DPDK `__'s testpmd +simple workload VNF would be `DPDK `__'s testpmd application forwarding packets in a VM or vloop\_vnf a simple kernel module that forwards traffic between two network interfaces inside the virtualized environment while bypassing the networking stack). @@ -656,7 +656,7 @@ tests: - Reference application: Simple forwarding or Open Source VNF. - Frame size (bytes): 64, 128, 256, 512, 1024, 1280, 1518, 2K, 4k OR Packet size based on use-case (e.g. RTP 64B, 256B) OR Mix of packet sizes as - maintained by the Functest project . + maintained by the Functest project . - Reordering check: Tests should confirm that packets within a flow are not reordered. - Duplex: Unidirectional / Bidirectional. Default: Full duplex with diff --git a/docs/testing/developer/devguide/results/scenario.rst b/docs/testing/developer/devguide/results/scenario.rst index dbdc7877..f7eadd33 100644 --- a/docs/testing/developer/devguide/results/scenario.rst +++ b/docs/testing/developer/devguide/results/scenario.rst @@ -34,7 +34,7 @@ Deployment topologies: Loopback applications in the Guest: -* `DPDK testpmd `_. +* `DPDK testpmd `_. * Linux Bridge. * :ref:`l2fwd-module` -- cgit 1.2.3-korg