diff options
| -rw-r--r-- | INFO | 6 | ||||
| -rw-r--r-- | INFO.yaml | 6 | ||||
| -rw-r--r-- | docs/k8s/artifacts.rst | 55 | ||||
| -rw-r--r-- | docs/k8s/helm.rst | 4 | ||||
| -rw-r--r-- | docs/k8s/index.rst | 14 | ||||
| -rw-r--r-- | docs/release/release-notes/release-notes.rst | 30 | ||||
| -rw-r--r-- | docs/testing/user/configguide/trafficgen.rst | 59 |
7 files changed, 163 insertions, 11 deletions
@@ -5,9 +5,9 @@ Lifecycle State: Mature Primary Contact: Sridhar Rao Project Lead: (Sridhar Rao) sridhar.rao@spirent.com Jira name vSwitch Characterization -JIRA tag : VSPERF -Repository: vswitchperf -Mailing list tag: [vsperf] +JIRA tag : VINEPERF +Repository: vineperf +Mailing list tag: [vineperf] IRC: Server:freenode.net Channel: #opnfv-vswitchperf Commiters: @@ -12,12 +12,12 @@ project_lead: &opnfv_vswitchperf_ptl primary_contact: *opnfv_vswitchperf_ptl issue_tracking: type: 'jira' - url: 'https://jira.opnfv.org/projects/VSPERF' + url: 'https://jira.anuket.io/projects/VINEPERF' key: '' mailing_list: type: 'mailman2' url: 'opnfv-tech-discuss@lists.opnfv.org' - tag: '[vsperf]' + tag: '[vineperf]' realtime_discussion: type: irc server: 'freenode.net' @@ -31,7 +31,7 @@ meetings: repeats: 'weekly' time: '15:00 UTC' # eg: '16:00 UTC' repositories: - - 'vswitchperf' + - 'vineperf' committers: - <<: *opnfv_vswitchperf_ptl - name: 'Maryam Tahhan' diff --git a/docs/k8s/artifacts.rst b/docs/k8s/artifacts.rst new file mode 100644 index 00000000..d5911038 --- /dev/null +++ b/docs/k8s/artifacts.rst @@ -0,0 +1,55 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Anuket, Spirent, AT&T and others. + +================================ +Kubernetes Artifacts in ViNePerf +================================ + +Container Artifacts +------------------- + +.. list-table:: Container Artifacts in ViNeperf + :widths: 50 100 + :header-rows: 1 + + * - Container + - Dockerfile Path + * - ViNePerf + - tools/docker/vineperf + * - CNI: Userspace CNI + - tools/k8s/cluster-deployment/uscni + * - Traffic Generator - Prox + - tools/k8s/test-containers/trafficgen-pods/prox + * - Traffic Generator - TRex + - tools/k8s/test-containers/trafficgen-pods/trex + * - Traffic Generator - pktgen + - tools/k8s/test-containers/trafficgen-pods/pktgen + * - DPDK-Forwarding + - tools/k8s/test-containers/dpdk-forwarding-pods + +Pod and Network Reference Definitions +------------------------------------- + +.. list-table:: Pod and Network Definitions + :widths: 50 100 + :header-rows: 1 + + * - Pod-Definition: ViNePerf + - tools/k8s/reference-definitions/pod-defs/vineperf + * - Pod-Definition: OVSDPDK + - tools/k8s/reference-definitions/pod-defs/ovsdpdk + * - Pod-Definition: VPP + - tools/k8s/reference-definitions/pod-defs/vpp + * - Pod-Definition: SRIOV + - tools/k8s/reference-definitions/pod-defs/sriov + * - Traffic Generator - TRex + - tools/k8s/reference-definitions/pod-defs/trex + * - Traffic Generator - Prox + - tools/k8s/reference-definitions/pod-defs/prox + * - Network Attachment - OVSPDDK + - tools/k8s/reference-definitions/network-attachments/ovsdpdk + * - Network Attachment - VPP + - tools/k8s/reference-definitions/network-attachments/vpp + * - Network Attachment - SRIOV + - tools/k8s/reference-definitions/network-attachments/sriov diff --git a/docs/k8s/helm.rst b/docs/k8s/helm.rst index add15a7b..17e22555 100644 --- a/docs/k8s/helm.rst +++ b/docs/k8s/helm.rst @@ -2,8 +2,6 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) Anuket, Spirent, AT&T, Ixia and others. -.. Anuket ViNePerf Documentation master file. - ============================================================ Automated deployment of helm charts with python ============================================================ @@ -134,4 +132,4 @@ Output Future Enhancements ******************** -In future, more information can be extracted by adding new functions to the file. The process of getting interfaces using regex can be made more proficient.
\ No newline at end of file +In future, more information can be extracted by adding new functions to the file. The process of getting interfaces using regex can be made more proficient. diff --git a/docs/k8s/index.rst b/docs/k8s/index.rst index 22d459da..58df4c41 100644 --- a/docs/k8s/index.rst +++ b/docs/k8s/index.rst @@ -19,13 +19,13 @@ First step is achieved through the tool present in *tools/k8s/cluster-deployment User can choose to perform all the remaining steps (2, 3, and 4), by running the following command. .. code-block:: console - + vsperf --k8s --conf-file k8s.conf pcp_tput User can also chose to perform only steps 3 and 4, by choosing to run following test cases. .. code-block:: console - + vsperf --k8s --conf-file k8s.conf pcp_evs_tput or vsperf --k8s --conf-file k8s.conf pccp_evs_tput @@ -55,3 +55,13 @@ In Kali release, two testscases were added: 2. pccp_evs_tput: Two-Pod throughput test, where virtual switch is externally deployed and managed. In future releases, more testcases for kubernetes will be added. + + +.. toctree:: + :numbered: + :maxdepth: 2 + + helm.rst + artifacts.rst + +Build date: |today| diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst index b730e2ad..60da2b5c 100644 --- a/docs/release/release-notes/release-notes.rst +++ b/docs/release/release-notes/release-notes.rst @@ -3,6 +3,36 @@ .. (c) OPNFV, Intel Corporation, Spirent Communications, AT&T and others. +Anuket Lakelse Release +====================== + +* Supported Software Versions - DPDK:20.05, OVS:2.14.0, VPP:21.01, QEMU:3.1.1, Trex:2.86, PROX:Kali + +* Traffic generator + + * Support for DPPD-Prox is added. This is the sixth traffic generator supported by ViNeperf. + * T-Rex statistics are improved to provide better latency results. + +* Kubernetes + + * ViNePerf container and corresponding pod-deployment file is included. + * A tool to deploy pods via helm-charts is added. This tool also extracts all the deployed + pods and corresponding service information. + * Deployment of different CNIs (userspace, sriov, calico, cilium, multus, and danm) are supported. + * Custom DPPD-Prox and T-Rex containers are added - source files. + * l2fwd/testpmd container is included - source files. + +* Additional Features + + * Run ViNePerf as pod in Kubernetes. Results-only on-screen output mode is added for this use case. + * Dedicated 'k8s' mode is included for Kubernetes data plane testing. + +* Miscellaneous + + * More changes made to be consistent with the name change from VSwitchPerf to ViNePerf. + * K8S Dataplane Benchmarking work is accepted to be published in IEEE Globecom 2021. + + Anuket Kali Release =================== diff --git a/docs/testing/user/configguide/trafficgen.rst b/docs/testing/user/configguide/trafficgen.rst index b018d37d..ae75352f 100644 --- a/docs/testing/user/configguide/trafficgen.rst +++ b/docs/testing/user/configguide/trafficgen.rst @@ -927,6 +927,65 @@ statistics is driven by configuration option ``TRAFFICGEN_TREX_LATENCY_PPS`` as TRAFFICGEN_TREX_LATENCY_PPS = 1000 + +DPPD-PROX +--------- + +Installation +~~~~~~~~~~~~ + +The library to interact with DPPD-Prox traffic generator is installed using the following commands: + + +.. code-block:: console + + cd systems/pythonlibs + ./add_prox.sh + +Configuration +~~~~~~~~~~~~~ + +The configuration starts with setting the TRAFFICGEN parameter to 'Prox'. +Prox specific configurations can be categorized as below. + +The configuration of cpu-cores to run the processes is very important in prox. +Following three parameters constitutes cpu-cores configuration. +Restrict the latency cores to just 1. + +.. code-block:: console + + TRAFFICGEN_PROX_MASTER_CORES = "10" + TRAFFICGEN_PROX_GENERATOR_CORES = "11,12,13" + TRAFFICGEN_PROX_LATENCY_CORES = "14" + +There are 3 files that are used as part of configuration to interact with Prox. +The generator-config file is the file that was used to run Prox. +The environment file (.env) defines role-specifc configuration for Prox instances. +A role could be a generator, swap, sink, etc. +The .test file defines test-specific configurations. + +.. code-block:: console + + TRAFFICGEN_PROX_GENERATOR_CONFIG_FILENAME = "vineperf-baremetal.cfg" + TRAFFICGEN_PROX_ENV_FILE = "rapid-vineperf-baremetal.env" + TRAFFICGEN_PROX_TEST_FILE = "tst009.test" + +These configurations enables to connect to running Prox traffic generator. + +.. code-block:: console + + TRAFFICGEN_PROX_GENERATOR_USER = "root" + TRAFFICGEN_PROX_GENERATOR_KEYFILE = "node4priv.pem" + +Finally, some minimal traffic-specific configurations that are self-explanatory. + +.. code-block:: console + + TRAFFICGEN_PROX_PKTSIZES = "[64]" + TRAFFICGEN_PROX_LATENCY_BUCKETS = "20" + TRAFFICGEN_PROX_RUNTIME='10' + + SR-IOV and Multistream layer 2 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ T-Rex by default only accepts packets on the receive side if the destination mac matches the |