feat(pxe): Add ALT
[csit.git] / README.md
index 6e9f32f..cae0f41 100644 (file)
--- a/README.md
+++ b/README.md
@@ -69,12 +69,12 @@ A brief bottom-up description is provided here:
      - Suite setup, suite teardown;
      - Test setup, test teardown;
 1. Tests - Robot
-   - Test suites with test cases;
+   - Device tests using containerized environment with SR-IOV access to a NIC;
+     - VPP;
    - Performance tests using physical testbed environment:
      - VPP;
      - DPDK-Testpmd;
      - DPDK-L3Fwd;
-     - VPP Container K8s orchestrated topologies;
    - Tools:
      - Documentation generator;
      - Report generator;
@@ -89,11 +89,9 @@ A brief bottom-up description is provided here:
 .
 └── tests
     ├── dpdk
-    │   ├── dpdk_scripts            # DPDK helper scripts
     │   └── perf                    # DPDK performance tests
     └── vpp
         ├── device                  # VPP device tests
-        ├── func                    # VPP functional VIRL tests
         └── perf                    # VPP performance tests
 ```
 
@@ -103,11 +101,11 @@ A brief bottom-up description is provided here:
 .
 resources
 └── libraries
-    ├── bash
-    │   ├── config
+    ├── bash                        # Contains a dependency of KubernetesUtils
+    │   ├── config                  # Config for KubernetesUtils dependency
     │   ├── entry                   # Main bootstrap entry directory
     │   ├── function                # Bootstrap function library
-    │   └── shell                   # Various functions
+    │   └── shell                   # Various functions for KubernetesUtils
     ├── python                      # Python L1 KWs
     └── robot                       # Robot Framework L2 KWs
 ```
@@ -117,30 +115,29 @@ resources
 ```
 .
 ├── docs                            # Main documentaion
+│── csit.infra.vagrant              # VPP device vagrant environment
+|── fdio.infra.ansible              # Infrastructure provisioning
+|── fdio.infra.pxe                  # Preboot eXecution Environment
+|── fdio.infra.terraform            # Virtual infrastructure deployment
+|── GPL                             # Files licensed under GPL
+│   ├── traffic_profiles            # Performance tests traffic profiles
+│   │   └── trex
+│   └── traffic_scripts             # Functional tests traffic profiles
 ├── PyPI                            # PyPI packages provided by CSIT
 │   ├── jumpavg
 │   └── MLRsearch
 ├── resources
+│   ├── api                         # API coverage
 │   ├── templates                   # Templates (vpp_api_test, kubernetes, ...)
 │   ├── test_data                   # Robot Test configuration
 │   ├── tools
-│   │   ├── disk-image-builder      # Utilities for building (DCR, VM) images
 │   │   ├── doc_gen                 # Code documentation generator
 │   │   ├── papi                    # PAPI driver
 │   │   ├── presentation            # Report generator
 │   │   ├── scripts                 # Various tools
-│   │   ├── testbed-setup           # Physical testbed setup scripts
 │   │   ├── topology                # Helper scripts for topology manipulation
 │   │   ├── trex                    # TRex driver
-│   │   ├── vagrant                 # VPP device vagrant environment
-│   │   └── wrk                     # WRK driver
 │   ├── topology_schemas
-│   ├── traffic_profiles            # Performance tests traffic profiles
-│   │   ├── trex
-│   │   └── wrk
-│   └── traffic_scripts             # Functional tests traffic profiles
-│       ├── dhcp
-│       └── lisp
 └── topologies                      # Linux Foundation topology files
     ├── available
     └── enabled
@@ -153,23 +150,17 @@ resources
 [Vagrant environment preparation](docs/testing_in_vagrant.rst) documentaion is
 describing local VPP Device functional testing.
 
-### Physical Testbed
-
-[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.
-
 ## Report
 
-[CSIT Report](https://docs.fd.io/csit/master/report/).
+[CSIT Report](https://s3-docs.fd.io/csit/master/report/).
 
 ## Trending
 
-[CSIT Trending](https://docs.fd.io/csit/master/trending/).
+[CSIT Trending](https://s3-docs.fd.io/csit/master/trending/).
 
 ## Code Documentation
 
-[CSIT Code Documentation](https://docs.fd.io/csit/master/doc/).
+[CSIT Code Documentation](https://s3-docs.fd.io/csit/master/docs/).
 
 ## Coding Guidelines