Deployment

Overview

Ixia-c is distributed and deployed as a multi-container application that consists of the following services:

controller: Serves API request from the clients and manages workflow across one or more traffic engines.
traffic-engine: Generates, captures, and processes traffic from one or more network interfaces (on linux-based OS).
app-usage-reporter: (Optional) Collects anonymous usage report from the controller and uploads it to the Keysight Cloud, with minimal impact on the host resources.

All these services are available as docker images on the GitHub Open-Traffic-Generator repository. To use specific versions of these images, see Ixia-c Releases .

ixia-c-aur

Once the services are deployed, conformance (a collection of snappi & gosnappi test scripts and configurations) can be setup to run against Ixia-c.

Bootstrap

The Ixia-c services can either all be deployed on the same host or each on separate hosts (as long as they are mutually reachable over the network). There is no boot-time dependency between them, which allows horizontal scalability without interrupting the existing services.

You can establish a connectivity between the services in two ways. The options are as follows:

controller & traffic-engine: The client pushes a traffic configuration to the controller, containing the location of the traffic engine.
controller & app-usage-reporter: The Controller periodically tries to establish connectivity with the app-usage-reporter on a location, which can be overridden by using the controller's deployment parameters.

The location (network address) of the traffic-engine and the app-usage-reporter must be reachable from the controller, even if they are not reachable from the client scripts.

Deployment types

Diagnostics

Check and download controller logs:

docker exec <container-id> cat logs/controller.log
# follow logs
docker exec <container-id> tail -f logs/controller.log
# check stdout output
docker logs <container-id>
# download logs
docker cp <container-id>:$(docker exec <container-id> readlink -f logs/controller.log) ./

Check and download traffic-engine logs:

docker exec <container-id> cat /var/log/usstream/usstream.log
# follow logs
docker exec <container-id> tail -f /var/log/usstream/usstream.log
# check stdout output
docker logs <container-id>
# download logs
docker cp <container-id>:/var/log/usstream/usstream.log ./

Test Suite

One-arm Scenario

TODO: diagram

Automated

docker-compose -f deployments/raw-one-arm.yml up -d # community users
# optionally stop and remove services deployed
docker-compose -f deployments/raw-one-arm.yml down # community users

Manual

# start controller and app usage reporter

# community users
docker run --net=host -d ghcr.io/open-traffic-generator/keng-controller --accept-eula
# commercial users
docker run --net=host -d ghcr.io/open-traffic-generator/keng-controller --accept-eula --license-servers="ip/hostname of license server"
docker run --net=host -d ghcr.io/open-traffic-generator/keng-app-usage-reporter

# start traffic engine on network interface eth1, TCP port 5555 and cpu cores 0, 1, 2
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

Two-arm Scenario

TODO: diagram

Automated

docker-compose -f deployments/raw-two-arm.yml up -d # community users
# optionally stop and remove services deployed
docker-compose -f deployments/raw-two-arm.yml down # community users

Manual

# start controller and app usage reporter
# community users
docker run --net=host -d ghcr.io/open-traffic-generator/keng-controller --accept-eula
# commercial users
docker run --net=host -d ghcr.io/open-traffic-generator/keng-controller --accept-eula --license-servers="ip/hostname of license server"
docker run --net=host -d ghcr.io/open-traffic-generator/keng-app-usage-reporter

# start traffic engine on network interface eth1, TCP port 5555 and cpu cores 0, 1, 2
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

# start traffic engine on network interface eth2, TCP port 5556 and cpu cores 0, 3, 4
docker run --net=host --privileged -d         \
  -e OPT_LISTEN_PORT="5556"                   \
  -e ARG_IFACE_LIST="virtual@af_packet,eth2"  \
  -e OPT_NO_HUGEPAGES="Yes"                   \
  --cpuset-cpus="0,3,4"                       \
  ghcr.io/open-traffic-generator/ixia-c-traffic-engine

Three-arm Mesh Scenario

This scenario binds traffic engine to the management network interface, that belongs to the container which in turn is a part of the docker0 network.

TODO: diagram

Automated

docker-compose -f deployments/raw-three-arm-mesh.yml up -d # community users
# optionally stop and remove services deployed
docker-compose -f deployments/raw-three-arm-mesh.yml down # community users

Manual

# start controller and app usage reporter
# community users
docker run --net=host -d ghcr.io/open-traffic-generator/keng-controller --accept-eula
# commercial users
docker run --net=host -d ghcr.io/open-traffic-generator/keng-controller --accept-eula --license-servers="ip/hostname of license server"
docker run --net=host -d ghcr.io/open-traffic-generator/keng-app-usage-reporter

# start traffic engine on network interface eth0, TCP port 5555 and cpu cores 0, 1, 2
docker run --privileged -d                    \
  -e OPT_LISTEN_PORT="5555"                   \
  -e ARG_IFACE_LIST="virtual@af_packet,eth0"  \
  -e OPT_NO_HUGEPAGES="Yes"                   \
  -p 5555:5555                                \
  --cpuset-cpus="0,1,2"                       \
  ghcr.io/open-traffic-generator/ixia-c-traffic-engine

# start traffic engine on network interface eth0, TCP port 5556 and cpu cores 0, 3, 4
docker run --privileged -d                    \
  -e OPT_LISTEN_PORT="5555"                   \
  -e ARG_IFACE_LIST="virtual@af_packet,eth0"  \
  -e OPT_NO_HUGEPAGES="Yes"                   \
  -p 5556:5555                                \
  --cpuset-cpus="0,3,4"                       \
  ghcr.io/open-traffic-generator/ixia-c-traffic-engine

# start traffic engine on network interface eth0, TCP port 5557 and cpu cores 0, 5, 6
docker run --privileged -d                    \
  -e OPT_LISTEN_PORT="5555"                   \
  -e ARG_IFACE_LIST="virtual@af_packet,eth0"  \
  -e OPT_NO_HUGEPAGES="Yes"                   \
  -p 5557:5555                                \
  --cpuset-cpus="0,5,6"                       \
  ghcr.io/open-traffic-generator/ixia-c-traffic-engine

TODO: Multi-port per TE container

Tests

Please follow readme to run sample go/python tests.