Merge "DOCS: Add Lakelse related documentation."

3 files changed, 68 insertions, 5 deletions

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|