From 1e00995886720000624145ad181ea70ac97a233a Mon Sep 17 00:00:00 2001 From: Trevor Cooper Date: Thu, 23 Mar 2017 15:09:43 -0700 Subject: Added index files user and developer docs Change-Id: I37b8acb98bca6fa4428be2722496eb1f7a476798 Signed-off-by: Trevor Cooper --- docs/index.rst | 90 --------------------------------- docs/testing/developer/index.rst | 73 ++++++++++++++++++++++++++ docs/testing/user/configguide/index.rst | 50 ++++++++++++++++++ docs/testing/user/userguide/index.rst | 10 ++++ 4 files changed, 133 insertions(+), 90 deletions(-) delete mode 100644 docs/index.rst create mode 100644 docs/testing/developer/index.rst create mode 100644 docs/testing/user/configguide/index.rst create mode 100644 docs/testing/user/userguide/index.rst diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 9bfc2f4f..00000000 --- a/docs/index.rst +++ /dev/null @@ -1,90 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) OPNFV, Intel Corporation, AT&T, Red Hat, Spirent, Ixia and others. - -.. OPNFV VSPERF Documentation master file. - -====== -VSPERF -====== -VSPERF is an OPNFV testing project. - -VSPERF provides an automated test-framework and comprehensive test suite based on -industry standards for measuring data-plane performance of Telco NFV switching -technologies as well as physical and virtual network interfaces (NFVI). The VSPERF -architecture is switch and traffic generator agnostic and provides full control of -software component versions and configurations as well as test-case customization. - -The Danube release of VSPERF includes improvements in documentation and capabilities. -This includes additional test-cases such as RFC 5481 Latency test and RFC-2889 -address-learning-rate test. Hardware traffic generator support is now provided for -Spirent and Xena in addition to Ixia. The Moongen software traffic generator is also -now fully supported. VSPERF can be used in a variety of modes for configuration and -setup of the network and/or for control of the test-generator and test execution. - -* Wiki: https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases -* Repository: https://git.opnfv.org/vswitchperf -* Artifacts: https://artifacts.opnfv.org/vswitchperf.html -* Continuous Integration status: https://build.opnfv.org/ci/view/vswitchperf/ - -****************************** -VSPERF User Guide -****************************** - -.. toctree:: - :caption: VSPERF User Guide - :maxdepth: 5 - :numbered: 5 - - ./testing/user/configguide/installation.rst - ./testing/user/configguide/upgrade.rst - ./testing/user/configguide/trafficgen.rst - - ./testing/user/userguide/testusage.rst - ./testing/user/userguide/teststeps.rst - ./testing/user/userguide/integration.rst - ./testing/user/userguide/yardstick.rst - -**************************** -VSPERF Developer Guide -**************************** - -.. toctree:: - :caption: VSPERF Developer Guide - :maxdepth: 5 - :numbered: 5 - - ./testing/developer/design/trafficgen_integration_guide.rst - ./testing/developer/design/vswitchperf_design.rst - - ./testing/developer/requirements/vswitchperf_ltd.rst - ./testing/developer/requirements/vswitchperf_ltp.rst - -***************************** -VSPERF - IETF Internet Draft -***************************** - -.. toctree:: - :caption: IETF Internet Draft - :maxdepth: 5 - :numbered: 5 - -`Benchmarking Virtual Switches in OPNFV `_ - -Location of xml drafts :doc:`./testing/developer/requirements/ietf_draft/` - -******************************** -VSPERF Scenarios and CI Results -******************************** - -.. toctree:: - :caption: VSPERF Scenarios & Results - :maxdepth: 5 - :numbered: 5 - - ./testing/developer/results/scenario.rst - ./testing/developer/results/results.rst - -Indices -======= -* :ref:`search` diff --git a/docs/testing/developer/index.rst b/docs/testing/developer/index.rst new file mode 100644 index 00000000..fa3b7b2b --- /dev/null +++ b/docs/testing/developer/index.rst @@ -0,0 +1,73 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV, Intel Corporation, AT&T, Red Hat, Spirent, Ixia and others. + +.. OPNFV VSPERF Documentation master file. + +====== +VSPERF +====== +VSPERF is an OPNFV testing project. + +VSPERF provides an automated test-framework and comprehensive test suite based on +industry standards for measuring data-plane performance of Telco NFV switching +technologies as well as physical and virtual network interfaces (NFVI). The VSPERF +architecture is switch and traffic generator agnostic and provides full control of +software component versions and configurations as well as test-case customization. + +The Danube release of VSPERF includes improvements in documentation and capabilities. +This includes additional test-cases such as RFC 5481 Latency test and RFC-2889 +address-learning-rate test. Hardware traffic generator support is now provided for +Spirent and Xena in addition to Ixia. The Moongen software traffic generator is also +now fully supported. VSPERF can be used in a variety of modes for configuration and +setup of the network and/or for control of the test-generator and test execution. + +* Wiki: https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases +* Repository: https://git.opnfv.org/vswitchperf +* Artifacts: https://artifacts.opnfv.org/vswitchperf.html +* Continuous Integration status: https://build.opnfv.org/ci/view/vswitchperf/ + + +**************************** +VSPERF Developer Guide +**************************** + +.. toctree:: + :caption: VSPERF Developer Guide + :maxdepth: 5 + :numbered: 5 + + ./design/trafficgen_integration_guide.rst + ./design/vswitchperf_design.rst + + ./requirements/vswitchperf_ltd.rst + ./requirements/vswitchperf_ltp.rst + +***************************** +VSPERF - IETF Internet Draft +***************************** + +.. toctree:: + :caption: IETF Internet Draft + :maxdepth: 5 + :numbered: 5 + +`Benchmarking Virtual Switches in OPNFV `_ + +Drafts (xml) are maintained in IETF repo https://tools.ietf.org/html/ + +******************************** +VSPERF Scenarios and CI Results +******************************** + +.. toctree:: + :caption: VSPERF Scenarios & Results + :maxdepth: 5 + :numbered: 5 + + ./results/scenario.rst + ./results/results.rst + +Indices +======= +* :ref:`search` diff --git a/docs/testing/user/configguide/index.rst b/docs/testing/user/configguide/index.rst new file mode 100644 index 00000000..5c55ffab --- /dev/null +++ b/docs/testing/user/configguide/index.rst @@ -0,0 +1,50 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV, Intel Corporation, AT&T, Red Hat, Spirent, Ixia and others. + +.. OPNFV VSPERF Documentation master file. + +====== +VSPERF +====== +VSPERF is an OPNFV testing project. + +VSPERF provides an automated test-framework and comprehensive test suite based on +industry standards for measuring data-plane performance of Telco NFV switching +technologies as well as physical and virtual network interfaces (NFVI). The VSPERF +architecture is switch and traffic generator agnostic and provides full control of +software component versions and configurations as well as test-case customization. + +The Danube release of VSPERF includes improvements in documentation and capabilities. +This includes additional test-cases such as RFC 5481 Latency test and RFC-2889 +address-learning-rate test. Hardware traffic generator support is now provided for +Spirent and Xena in addition to Ixia. The Moongen software traffic generator is also +now fully supported. VSPERF can be used in a variety of modes for configuration and +setup of the network and/or for control of the test-generator and test execution. + +* Wiki: https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases +* Repository: https://git.opnfv.org/vswitchperf +* Artifacts: https://artifacts.opnfv.org/vswitchperf.html +* Continuous Integration status: https://build.opnfv.org/ci/view/vswitchperf/ + +****************************** +VSPERF User Guide +****************************** + +.. toctree:: + :caption: VSPERF User Guide + :maxdepth: 5 + :numbered: 5 + + ./installation.rst + ./upgrade.rst + ./trafficgen.rst + + ../userguide/testusage.rst + ../userguide/teststeps.rst + ../userguide/integration.rst + ../userguide/yardstick.rst + +Indices +======= +* :ref:`search` diff --git a/docs/testing/user/userguide/index.rst b/docs/testing/user/userguide/index.rst new file mode 100644 index 00000000..5c6886bf --- /dev/null +++ b/docs/testing/user/userguide/index.rst @@ -0,0 +1,10 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV, Intel Corporation, AT&T, Red Hat, Spirent, Ixia and others. + +.. OPNFV VSPERF Documentation master file. + + +Indices +======= +* :ref:`search` -- cgit 1.2.3-korg