aboutsummaryrefslogtreecommitdiffstats
path: root/docs/k8s/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/k8s/index.rst')
-rw-r--r--docs/k8s/index.rst33
1 files changed, 25 insertions, 8 deletions
diff --git a/docs/k8s/index.rst b/docs/k8s/index.rst
index 872a3280..22d459da 100644
--- a/docs/k8s/index.rst
+++ b/docs/k8s/index.rst
@@ -1,25 +1,36 @@
.. 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.
+.. (c) Anuket, Spirent, AT&T, Ixia and others.
-.. OPNFV VSPERF Documentation master file.
+.. Anuket ViNePerf 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.
+============================================================
+Anuket ViNePerf Kubernetes Container Networking Benchmarking
+============================================================
+ViNePerf 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.
+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.
+
+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
+
+
************************
Important Configurations
************************
@@ -37,4 +48,10 @@ VSPERF has introduced a new configuration parameters, as listed below, for kuber
*********
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
+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 Kali release, two testscases were added:
+
+1. pcp_evs_tput: Single-Pod throughput test, where virtual switch is externally deployed and managed.
+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.