summaryrefslogtreecommitdiffstats
path: root/docs/k8s/index.rst
blob: 872a32803915ce14fd03b0f07362c2aacb3b7eef (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. (c) OPNFV, Spirent, AT&T, Ixia  and others.

.. OPNFV VSPERF Documentation master file.

=========================================================
OPNFV VSPERF Kubernetes Container Networking Benchmarking
=========================================================
VSPERF supports testing and benchmarking of kubernetes container networking solution, referred as kubernetes Container Networking Benchmarking (CNB). The process can be broadly classified into following four operations.

1. Setting up of Kubernetes Cluster.
2. Deploying container networking solution.
3. Deploying pod(s).
4. Running tests.

First step is achieved through the tool present in *tools/k8s/cluster-deployment* folder. Please refer to the documentation present in that folder for automated kubernetes cluster setup. To perform the remaining steps, the user has to run the following command.

.. code-block:: console
    
    vsperf --k8s --conf-file k8s.conf pcp_tput

************************
Important Configurations
************************

VSPERF has introduced a new configuration parameters, as listed below, for kubernetes CNB. The file *12_k8s.conf*, present in conf folder provides sample values. User has to modify these parameters to suit their environment before running the above command.

1. K8S_CONFIG_FILEPATH - location of the kubernetes-cluster access file. This will be used to connect to the cluster.
2. PLUGIN - The plugin to use. Allowed values are OvsDPDK, VPP, and SRIOV.
3. NETWORK_ATTACHMENT_FILEPATH - location of the network attachment definition file.
4. CONFIGMAP_FILEPATH - location of the config-map file. This will be used only for SRIOV plugin.
5. POD_MANIFEST_FILEPATH - location of the POD definition file.
6. APP_NAME - Application to run in the pod. Options - l2fwd, testpmd, and l3fwd.


*********
Testcases
*********
Kubernetes CNB will be done through new testcases. For Jerma release, only pcp_tput will be supported. This testcase, will be similar to pvp_tput, where VNF is replaced with a pod/container. The pcp_tput testcase, will still use phy2phy as deployment. In future releases, a new deployment model will be added to support more testcases for kubernetes