From a07ce64ab4529abfc34bee502180af3ea2de9eda Mon Sep 17 00:00:00 2001 From: Ashutosh Kumar Date: Fri, 20 Oct 2023 19:50:38 +0000 Subject: [PATCH] fixed formatting --- .github/workflows/ci.yml | 6 +++--- readme.md | 8 +++++--- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 22abbdab..2e39ca16 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -19,11 +19,11 @@ jobs: uses: docker-practice/actions-setup-docker@master - name: Deploy Ixia-C run: | - sed -n '57,61p' readme.md > deploy.sh + sed -n '58,61p' readme.md > deploy.sh sh deploy.sh - name: Setup and run tests run: | - sed -n '90,95p' readme.md > test.sh + sed -n '90,97p' readme.md > test.sh sh test.sh - name: Get container logs if: always() @@ -48,7 +48,7 @@ jobs: uses: docker-practice/actions-setup-docker@master - name: Deploy Ixia-C run: | - sed -n '57,61p' readme.md > deploy.sh + sed -n '58,61p' readme.md > deploy.sh sh deploy.sh - name: Setup Python uses: actions/setup-python@v4 diff --git a/readme.md b/readme.md index f29bd6b7..fe6bd36e 100644 --- a/readme.md +++ b/readme.md @@ -29,11 +29,11 @@ ### What is Ixia-C ? -Ixia-C is a modern, powerful and API-driven traffic generator designed to cater to the needs of hyper-scalers, network hardware vendors and hobbyists alike. +- A modern, powerful and **API-driven** traffic generator designed to cater to the needs of hyper-scalers, network hardware vendors and hobbyists alike. -It is **free for basic use-cases** and distributed / deployed as a multi-container application consisting primarily of a [controller](https://github.com/orgs/open-traffic-generator/packages/container/package/keng-controller), a [traffic-engine](https://github.com/orgs/open-traffic-generator/packages/container/package/ixia-c-traffic-engine) and a [protocol-engine](https://github.com/orgs/open-traffic-generator/packages/container/package/ixia-c-protocol-engine). +- **Free for basic use-cases** and distributed / deployed as a multi-container application consisting primarily of a [controller](https://github.com/orgs/open-traffic-generator/packages/container/package/keng-controller), a [traffic-engine](https://github.com/orgs/open-traffic-generator/packages/container/package/ixia-c-traffic-engine) and a [protocol-engine](https://github.com/orgs/open-traffic-generator/packages/container/package/ixia-c-protocol-engine). -As a reference implementation of [Open Traffic Generator API](https://github.com/open-traffic-generator/models), Ixia-C supports client SDKs in various languages, most prevalent being [snappi](https://pypi.org/project/snappi/) (Python SDK). +- As a reference implementation of [Open Traffic Generator API](https://github.com/open-traffic-generator/models), supports client SDKs in various languages, most prevalent being [snappi](https://github.com/open-traffic-generator/snappi) (Python SDK) and [gosnappi](https://github.com/open-traffic-generator/snappi/tree/main/gosnappi).

Ixia-C deployment for two-arm test with DUT @@ -89,8 +89,10 @@ The description of each node in the configuration is detailed in self-updating ```bash # push traffic configuration curl -skL https://localhost:8443/config -H "Content-Type: application/json" -d @conformance/examples/quickstart_config.json + # start transmitting configured flows curl -skL https://localhost:8443/control/state -H "Content-Type: application/json" -d @conformance/examples/quickstart_control.json + # fetch flow metrics curl -skL https://localhost:8443/monitor/metrics -H "Content-Type: application/json" -d @conformance/examples/quickstart_metrics.json ```