Launch of mkdocs-based site with reduced number of pages

.github/workflows/publish.yml

@@ -0,0 +1,18 @@
+name: publish
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - run: pip install mkdocs-material
+      - run: mkdocs gh-deploy --force

.gitignore

@@ -2,3 +2,7 @@ scratch
 env
 *.pcap
 *.log
+venv
+site
+.DS_Store
+*.bkp

deployments/k8s/network-emulation/pods.yaml

@@ -133,4 +133,3 @@ spec:
         - "sleep"
         - "infinity"
   restartPolicy: Always
-

deployments/k8s/network-emulation/readme.md

@@ -70,7 +70,7 @@ To achieve this, we'll be using [Meshnet CNI](https://github.com/networkop/meshn
     docker pull ghcr.io/open-traffic-generator/keng-controller:0.1.0-53
     docker pull ghcr.io/open-traffic-generator/ixia-c-traffic-engine:1.6.0.85
     docker pull ghcr.io/open-traffic-generator/ixia-c-protocol-engine:1.00.0.337
-    
+
     # download DUT image
     docker pull ubuntu:22.04
 
@@ -133,7 +133,7 @@ To achieve this, we'll be using [Meshnet CNI](https://github.com/networkop/meshn
 
 7. Run IPv4 forwarding test using [snappi](https://github.com/open-traffic-generator/snappi/tree/main/gosnappi) which is an auto-generated SDK based on [Open Traffic Generator API](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/open-traffic-generator/models/master/artifacts/openapi.yaml&nocors)
 
-    The test parameters, e.g. location of Ixia-C controller, name of interfaces, etc. can be modified inside `testConst` map in `ipfwd.go`.
+    The test parameters, e.g. location of KENG controller, name of interfaces, etc. can be modified inside `testConst` map in `ipfwd.go`.
 
     Check the file for more details on the test.
 

deployments/k8s/readme.md

@@ -51,23 +51,23 @@ This section hosts [kustomize](https://kustomize.io/) manifests for deploying va
 
 ### Deploy Topology and Run Tests (Stateless traffic on eth0)
 
-1. Deploy topology consisting of two ixia-c port pods and one ixia-c controller pod
+1. Deploy topology consisting of two Ixia-c port pods and one KENG controller pod
 
     Topology manifests are kept inside `overlays/two-traffic-ports-eth0` which specifies `port1` and `port2`.
     * iptables rule is configured on both ports to drop UDP/TCP packets destined for ports 7000-8000
     * number of ports can be increased by adding new port dirs similar to `port1` and using it in rest of the files
 
     ```bash
-    # deploy ixia-c with two ports that only support stateless traffic over eth0
+    # deploy Ixia-c with two ports that only support stateless traffic over eth0
     kubectl apply -k overlays/two-traffic-ports-eth0
-    # ensure all ixia-c pods are ready
+    # ensure all Ixia-c pods are ready
     kubectl wait --for=condition=Ready pods --all -n ixia-c
     ```
 
 2. Generate test pre-requisites
 
     The sample test requires `conformance/test-config.yaml` which is auto-generated:
-    * ixia-c controller / port endpoints
+    * KENG controller / port endpoints
     * common port / flow properties
     * values like port pod IPs, gateway MAC on tx port, etc.
 

deployments/raw-one-arm.yml

@@ -16,6 +16,6 @@ services:
     - ARG_IFACE_LIST=virtual@af_packet,${IFC1}
     - OPT_NO_HUGEPAGES=Yes
   aur:
-    image: ghcr.io/open-traffic-generator/ixia-c-app-usage-reporter:${AUR_VERSION:-latest}
+    image: ghcr.io/open-traffic-generator/keng-app-usage-reporter:${AUR_VERSION:-latest}
     network_mode: "host"
     restart: always

deployments/raw-three-arm-mesh.yml

@@ -39,6 +39,6 @@ services:
     - ARG_IFACE_LIST=virtual@af_packet,eth0
     - OPT_NO_HUGEPAGES=Yes
   aur:
-    image: ghcr.io/open-traffic-generator/ixia-c-app-usage-reporter:${AUR_VERSION:-latest}
+    image: ghcr.io/open-traffic-generator/keng-app-usage-reporter:${AUR_VERSION:-latest}
     network_mode: "host"
     restart: always

deployments/raw-two-arm.yml

@@ -26,6 +26,6 @@ services:
     - ARG_IFACE_LIST=virtual@af_packet,${IFC2}
     - OPT_NO_HUGEPAGES=Yes
   aur:
-    image: ghcr.io/open-traffic-generator/ixia-c-app-usage-reporter:${AUR_VERSION:-latest}
+    image: ghcr.io/open-traffic-generator/keng-app-usage-reporter:${AUR_VERSION:-latest}
     network_mode: "host"
     restart: always

docs/CNAME

@@ -0,0 +1 @@
+ixia-c.dev

docs/deployments-containerlab.md

@@ -0,0 +1,42 @@
+
+# Deploy Ixia-c-one using containerlab
+
+Ixia-c-one is deployed as single-container application by using [containerlab](https://containerlab.dev/quickstart/) that consists of the following services:
+
+* **containerlab**: Containerlab provides a CLI for orchestrating and managing container-based networking labs. It starts the containers, builds a virtual wiring between them to create lab topologies depending on a user's choice, and manages the labs lifecycle.
+* **Ixia-c-one**: Keysight Ixia-c-one is a single-container distribution of Ixia-c, which in turn is Keysight's reference implementation of Open Traffic Generator API.
+
+  Meet the [keysight_ixia-c-one](https://containerlab.dev/manual/kinds/keysight_ixia-c-one) kind! It is available from containerlab [release 0.26](https://containerlab.dev/rn/0.26/#keysight-ixia-c).
+* **srl linux**: Nokia SR Linux is a truly open network operating system (NOS), that makes your data center switching infrastructure more scalable, more flexible, and simpler to operate.
+
+![ixia-c-one](res/ixia-c-one-aur.drawio.svg)
+
+## Install containerlab
+
+  ```sh
+  # download and install the latest release (may require sudo)
+  bash -c "$(curl -sL https://get.containerlab.dev)"
+  ```
+
+## Deploy the topology
+
+* You can find a sample topology definition in <https://containerlab.dev/lab-examples/ixiacone-srl/>, which consists of Nokia SR Linux and Ixia-c-one nodes that are connected to one-another.
+* This consists of a Keysight ixia-c-one node with 2 ports connected to 2 ports on an srl linux node via two point-to-point ethernet links. Both nodes are also connected with their management interfaces to the containerlab docker network.
+
+  ```sh
+  # After downloading the sample topology file 
+  containerlab deploy --topo ixiac01.clab.yml
+  ```
+
+- After deployment, you are now ready to run a test using the topology.
+
+## Run a test
+
+* Follow this [link](https://containerlab.dev/lab-examples/ixiacone-srl/#execution) to run a test.
+
+## Destroy/Remove the topology
+
+  ```sh
+  # delete a particular topology 
+  containerlab destroy --topo ixiac01.clab.yml
+  ```

docs/deployments-docker-compose.md

@@ -0,0 +1,77 @@
+# Deploy Ixia-c using docker-compose
+
+Deploying multiple services manually (along with the required parameters) is not always applicable in some scenarios. For convenience, the [deployments](../deployments) directory consists of the following `docker-compose` files:
+
+- `*.yml`: Describes the services for a given scenario and the deployment parameters that are required to start them.
+- `.env`: Holds the default parameters, that are used across all `*.yml` files. For example, the name of the interface, the version of docker images, and etc.
+
+If a concerned `.yml` file does not include certain variables from `.env`, those can then safely be ignored.  
+Follwoing is the example of a usual workflow, by using  `docker-compose`.
+
+```sh
+# change default parameters if needed; e.g. interface name, image version, etc.
+vi deployments/.env
+# deploy and start services for community users
+docker-compose -f deployments/<scenario>.yml up -d
+# stop and remove services deployed
+docker-compose -f deployments/<scenario>.yml down
+```
+
+On most of the systems, `docker-compose` needs to be installed separately even if the docker is already installed. For more information, see [docker prerequisites](prerequisites.md#docker) .
+
+>All the scenarios that are mentioned in the following sections, describe both manual and automated (requiring docker-compose) steps.
+
+## Deployment Parameters
+
+### Controller
+
+  | Controller Parameters       | Optional  | Default                 | Description                                                     |
+  |-----------------------------|-----------|-------------------------|-----------------------------------------------------------------|
+  | --debug                     |   Yes     | false                   | Enables high volume logs with debug info for better diagnostics.|
+  | --disable-app-usage-reporter|   Yes     | false                   | Disables sending of usage data to the app-usage-reporter.              |
+  | --http-port                 |   Yes     | 8443                     | TCP port for HTTP server.                                       |
+  | --aur-host                  |   Yes     | https://localhost:5600  | Overrides the location of the app-usage-reporter.                       |
+  | --accept-eula               |   No      | NA                      | Indicates that the user has accepted EULA, otherwise the controller will not boot up. |
+  | --license-servers           |   No      | NA                      | Indicates the ip address of license servers for commercial users. |
+
+  Docker Parameters:
+
+- `--net=host`: It is recommended to allow the use of the host network stack, in order to address the traffic-engine containers using `localhost` instead of `container-ip`, when deployed on the same host.
+- `-d`: This starts the container in background.
+
+  Example:
+
+  ```bash
+  # For community users
+  docker run --net=host -d ghcr.io/open-traffic-generator/keng-controller --accept-eula --debug --http-port 5050
+
+  # For commercial users
+  docker run --net=host -d ghcr.io/open-traffic-generator/keng-controller --accept-eula --debug --http-port 5050 --license-servers="ip/hostname of license server"
+  ```
+
+### Traffic Engine
+
+  | Environment Variables       | Optional  | Default                 | Description                                                     |
+  |-----------------------------|-----------|-------------------------|-----------------------------------------------------------------|
+  | ARG_IFACE_LIST              |   No      | NA                      | Name of the network interface to bind to. It must be visible to the traffic-engine's network namespace. For example, `virtual@af_packet,eth1` where `eth1` is the interface name and `virtual@af_packet` indicates that the interface is managed by the host kernel's network stack.|
+  | OPT_LISTEN_PORT             |   Yes     | "5555"                  | TCP port on which the controller can establish connection with the traffic-engine.|
+  | OPT_NO_HUGEPAGES            |   Yes     | "No"                    | If set to `Yes`, it disables hugepages in the OS. The hugepages needs to be disabled when the network interfaces are managed by the host kernel's stack.|
+
+  Docker Parameters:
+
+- `--net=host`: This is required if the traffic-engine needs to bind to a network interface that is visible in the host network stack but not inside the docker's network.
+- `--privileged`: This is required because the traffic-engine needs to exercise capabilities that require elevated privileges.
+- `--cpuset-cpus`: The traffic-engine usually requires 1 shared CPU core for management activities and 2 exclusive CPU cores, each for the transmit engine and receive engine. The shared CPU core can be shared across multiple traffic-engines. For example, `--cpuset-cpus="0,1,2"` which indicates that cpu0 is shared, cpu1 is used for transmit and cpu2 is used for receive. If CPU cores are not specified, any arbitrary CPU cores will be chosen.
+    > If enough CPU cores are not provided, the available CPU cores may be shared among management, transmit, and the receive engines, that can occasionally result in lower performance.
+- `-d`: This starts the container in background.
+
+  Example:
+
+  ```bash
+  docker run --net=host --privileged -d         \
+    -e OPT_LISTEN_PORT="5555"                   \
+    -e ARG_IFACE_LIST="virtual@af_packet,eth1"  \
+    -e OPT_NO_HUGEPAGES="Yes"                   \
+    --cpuset-cpus="0,1,2"                       \
+    ghcr.io/open-traffic-generator/ixia-c-traffic-engine
+  ```