Separate files needing GPL license

[csit.git] / README.md

diff --git a/README.md b/README.md
index f878980..299011d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -69,19 +69,12 @@ A brief bottom-up description is provided here:
      - Suite setup, suite teardown;
      - Test setup, test teardown;
 1. Tests - Robot
      - Suite setup, suite teardown;
      - Test setup, test teardown;
 1. Tests - Robot

-   - Test suites with test cases;
-   - Functional tests using VIRL environment:
+   - Device tests using containerized environment with SR-IOV access to a NIC;

      - VPP;
      - VPP;

-     - Honeycomb;
-     - NSH_SFC;
-     - DMM;
-     - TLDK;

    - Performance tests using physical testbed environment:
      - VPP;
      - DPDK-Testpmd;
      - DPDK-L3Fwd;
    - Performance tests using physical testbed environment:
      - VPP;
      - DPDK-Testpmd;
      - DPDK-L3Fwd;

-     - Honeycomb;
-     - VPP Container K8s orchestrated topologies;

    - Tools:
      - Documentation generator;
      - Report generator;
    - Tools:
      - Documentation generator;
      - Report generator;


@@ -95,26 +88,11 @@ A brief bottom-up description is provided here:
 ```
 .
 └── tests
 ```
 .
 └── tests

-    ├── dmm
-    │   └── func                    # DMM functional VIRL tests

     ├── dpdk
     │   ├── dpdk_scripts            # DPDK helper scripts
     │   └── perf                    # DPDK performance tests
     ├── dpdk
     │   ├── dpdk_scripts            # DPDK helper scripts
     │   └── perf                    # DPDK performance tests

-    ├── honeycomb
-    │   ├── func                    # Honeycomb functional VIRL tests
-    │   └── perf                    # Honeycomb functional performance tests
-    ├── kubernetes
-    │   └── perf                    # VPP K8S orchestration performance tests
-    ├── nsh_sfc
-    │   ├── func                    # NSH_SFC functional tests
-    │   └── sfc_scripts             # NSH_SFC helper scripts
-    ├── tldk
-    │   ├── func                    # TLDK functional VIRL tests
-    │   ├── tldk_scripts            # TLDK helper scripts
-    │   └── tldk_testconfig         # TLDK test configuration

     └── vpp
         ├── device                  # VPP device tests
     └── vpp
         ├── device                  # VPP device tests

-        ├── func                    # VPP functional VIRL tests

         └── perf                    # VPP performance tests
 ```
 
         └── perf                    # VPP performance tests
 ```
 


@@ -124,12 +102,11 @@ A brief bottom-up description is provided here:
 .
 resources
 └── libraries
 .
 resources
 └── libraries

-    ├── bash
-    │   ├── config
+    ├── bash                        # Contains a dependency of KubernetesUtils
+    │   ├── config                  # Config for KubernetesUtils dependency

     │   ├── entry                   # Main bootstrap entry directory
     │   ├── function                # Bootstrap function library
     │   ├── entry                   # Main bootstrap entry directory
     │   ├── function                # Bootstrap function library

-    │   ├── qemu_patches            # Custom QEMU patches (see KVM methodology)
-    │   └── shell                   # Various functions
+    │   └── shell                   # Various functions for KubernetesUtils

     ├── python                      # Python L1 KWs
     └── robot                       # Robot Framework L2 KWs
 ```
     ├── python                      # Python L1 KWs
     └── robot                       # Robot Framework L2 KWs
 ```


@@ -155,7 +132,6 @@ resources
 │   │   ├── topology                # Helper scripts for topology manipulation
 │   │   ├── trex                    # TRex driver
 │   │   ├── vagrant                 # VPP device vagrant environment
 │   │   ├── topology                # Helper scripts for topology manipulation
 │   │   ├── trex                    # TRex driver
 │   │   ├── vagrant                 # VPP device vagrant environment

-│   │   ├── virl                    # VIRL helper scripts

 │   │   └── wrk                     # WRK driver
 │   ├── topology_schemas
 │   ├── traffic_profiles            # Performance tests traffic profiles
 │   │   └── wrk                     # WRK driver
 │   ├── topology_schemas
 │   ├── traffic_profiles            # Performance tests traffic profiles


@@ -163,7 +139,6 @@ resources
 │   │   └── wrk
 │   └── traffic_scripts             # Functional tests traffic profiles
 │       ├── dhcp
 │   │   └── wrk
 │   └── traffic_scripts             # Functional tests traffic profiles
 │       ├── dhcp

-│       ├── honeycomb

 │       └── lisp
 └── topologies                      # Linux Foundation topology files
     ├── available
 │       └── lisp
 └── topologies                      # Linux Foundation topology files
     ├── available


@@ -179,7 +154,7 @@ describing local VPP Device functional testing.
 
 ### Physical Testbed
 
 
 ### Physical Testbed
 

-[Physical testbed preparation](resources/tools/testbed-setup/README.md)
+[Physical testbed preparation](resources/tools/testbed-setup/README.rst)

 documentation is describing PXE and Ansible setup process. All the software
 requirements for running Performance Teste are part of Ansible playbooks.
 
 documentation is describing PXE and Ansible setup process. All the software
 requirements for running Performance Teste are part of Ansible playbooks.