diff --git a/docs/deployments.md b/docs/deployments.md index 2e7106ad..bb1807cf 100644 --- a/docs/deployments.md +++ b/docs/deployments.md @@ -25,7 +25,7 @@ All these services are available as docker image on [ixiacom repository](https:/ -> Once the services are deployed, [snappi-tests](https://github.com/open-traffic-generator/snappi-tests/tree/1b683ba), a collection of [snappi](https://pypi.org/project/snappi/) test scripts and configurations, can be setup to run against Ixia-c. +> Once the services are deployed, [snappi-tests](https://github.com/open-traffic-generator/snappi-tests/tree/8ec04a9), a collection of [snappi](https://pypi.org/project/snappi/) test scripts and configurations, can be setup to run against Ixia-c. ### Bootstrap diff --git a/docs/faq.md b/docs/faq.md index cbc7454d..9f0b7313 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -69,7 +69,7 @@ What version of the Open Traffic Generator spec does Ixia-c implement?
-Ixia-c implements version **[v0.6.13](https://github.com/open-traffic-generator/models/releases/tag/v0.6.13)** of the Open Traffic Generator Data Model. You can view the model [here](https://redocly.github.io/redoc/?url=https://github.com/open-traffic-generator/models/releases/download/v0.6.13/openapi.yaml). +Ixia-c implements version **[v0.7.2](https://github.com/open-traffic-generator/models/releases/tag/v0.7.2)** of the Open Traffic Generator Data Model. You can view the model [here](https://redocly.github.io/redoc/?url=https://github.com/open-traffic-generator/models/releases/download/v0.7.2/openapi.yaml). diff --git a/docs/hello-snappi.md b/docs/hello-snappi.md index fd35eeb4..4728b5f6 100644 --- a/docs/hello-snappi.md +++ b/docs/hello-snappi.md @@ -27,7 +27,7 @@ In this tutorial, we will walk through some key elements required to write a **s * Send 1000 UDP packets back and forth between interfaces eth1 & eth2 at a rate of 1000 packets per second. * Ensure that indeed correct number of valid UDP packets are received on both ends using port capture and port metrics. -The script [hello_snappi.py](https://github.com/open-traffic-generator/snappi-tests/tree/1b683ba/scripts/hello_snappi.py) covers this extensively. +The script [hello_snappi.py](https://github.com/open-traffic-generator/snappi-tests/tree/8ec04a9/scripts/hello_snappi.py) covers this extensively.
@@ -47,7 +47,7 @@ And installing python packages: * [dpkt](https://pypi.org/project/dpkt/) - for processing `.pcap` files. ```sh -python -m pip install --upgrade snappi==0.6.21 dpkt +python -m pip install --upgrade snappi==0.7.3 dpkt ``` ### Create API Handle @@ -108,9 +108,9 @@ The objects and methods (for API calls) in snappi are auto-generated from an [Op The snappi API documentation linked above will always point to API version **v0.6.7**. To use a different API version instead: -* Identify API version by opening this link in a browser and replacing **v0.6.21** in URL with intended snappi version. +* Identify API version by opening this link in a browser and replacing **v0.7.3** in URL with intended snappi version. -* Open this link in a browser after replacing **v0.6.13** in URL with intended API version. +* Open this link in a browser after replacing **v0.7.2** in URL with intended API version. @@ -406,6 +406,6 @@ with open('cap.pcap', 'wb') as p: ### Putting It All Together -`snappi` provides a fair level of abstraction and ease-of-use while constructing traffic configuration compared to doing the [equivalent in JSON](https://github.com/open-traffic-generator/snappi-tests/tree/1b683ba/configs/hello_snappi.json). More such comparisons can be found in [common snappi constructs](snappi-constructs.md). +`snappi` provides a fair level of abstraction and ease-of-use while constructing traffic configuration compared to doing the [equivalent in JSON](https://github.com/open-traffic-generator/snappi-tests/tree/8ec04a9/configs/hello_snappi.json). More such comparisons can be found in [common snappi constructs](snappi-constructs.md). -There's more to snappi than what we've presented here, e.g. per-flow metrics, latency measurements, custom payloads, etc. It will be worthwhile browsing through [snappi-tests](https://github.com/open-traffic-generator/snappi-tests/tree/1b683ba) for more such examples, pytest-based test scripts and utilities. +There's more to snappi than what we've presented here, e.g. per-flow metrics, latency measurements, custom payloads, etc. It will be worthwhile browsing through [snappi-tests](https://github.com/open-traffic-generator/snappi-tests/tree/8ec04a9) for more such examples, pytest-based test scripts and utilities. diff --git a/docs/news.md b/docs/news.md index b798ec9a..9a45b835 100644 --- a/docs/news.md +++ b/docs/news.md @@ -1,5 +1,9 @@ # News +* **16th December, 2021**: Ixia-c version 0.0.1 (build 2543) released. This conforms to **[v0.7.2](https://redocly.github.io/redoc/?url=https://github.com/open-traffic-generator/models/releases/download/v0.7.2/openapi.yaml)** of the Open Traffic Generator Models specification. + + * This build contains stability fixes. [Read more](releases.md) + * **2nd December, 2021**: Ixia-c version 0.0.1 (build 2446) released. This conforms to **[v0.6.13](https://redocly.github.io/redoc/?url=https://github.com/open-traffic-generator/models/releases/download/v0.6.13/openapi.yaml)** of the Open Traffic Generator Models specification. * This build introduces ability to return large `FramesTx/RX` values by `metric` APIs. [Read more](releases.md) diff --git a/docs/releases.md b/docs/releases.md index 8aa81f7b..6bdf79c4 100644 --- a/docs/releases.md +++ b/docs/releases.md @@ -1,6 +1,32 @@ # Ixia-c Release Notes and Version Compatibility -## Release v0.0.1-2446 (Latest) + +## Release v0.0.1-2543 (Latest) +> 16th December, 2021 + +#### About + +This build contains stability fixes. + +#### Build Details + +| Component | Version | +|-------------------------------|---------------| +| Open Traffic Generator API | [0.7.2](https://redocly.github.io/redoc/?url=https://github.com/open-traffic-generator/models/releases/download/v0.7.2/openapi.yaml) | +| snappi | [0.7.3](https://pypi.org/project/snappi/0.7.3) | +| gosnappi | [0.7.3](https://pkg.go.dev/github.com/open-traffic-generator/snappi/gosnappi@v0.7.3) | +| ixia-c-controller | [0.0.1-2543](https://hub.docker.com/r/ixiacom/ixia-c-controller/tags) | +| ixia-c-traffic-engine | [1.4.1.2](https://hub.docker.com/r/ixiacom/ixia-c-traffic-engine/tags) | +| ixia-c-app-usage-reporter | [0.0.1-37](https://hub.docker.com/r/ixiacom/ixia-c-app-usage-reporter/tags) | +| ixia-c-protocol-engine | 1.00.0.127 | +| ixia-c-operator | [0.0.70](https://hub.docker.com/r/ixiacom/ixia-c-operator/tags) | +| ixia-c-gnmi-server | [0.7.2](https://hub.docker.com/r/ixiacom/ixia-c-gnmi-server/tags) | +| ixia-c-grpc-server | [0.7.2](https://hub.docker.com/r/ixiacom/ixia-c-grpc-server/tags) | + +#### Known Issues + +* The metric `loss` in flow metrics is currently not supported. +## Release v0.0.1-2446 > 2nd December, 2021 #### About diff --git a/readme.md b/readme.md index ef9107cd..e0f385be 100644 --- a/readme.md +++ b/readme.md @@ -9,9 +9,9 @@

- Release v0.0.1-2446 - Open Traffic Generator v0.6.13 - snappi v0.6.21 + Release v0.0.1-2543 + Open Traffic Generator v0.7.2 + snappi v0.7.3 news news Slack Status @@ -75,7 +75,7 @@ Before proceeding, please ensure [system prerequisites](docs/prerequisites.md) a git clone --recurse-submodules https://github.com/open-traffic-generator/ixia-c && cd ixia-c # install snappi - python -m pip install --upgrade snappi==0.6.21 + python -m pip install --upgrade snappi==0.7.3 # run a standalone script to generate TCP traffic and fetch metrics python snappi-tests/scripts/quickstart_snappi.py ``` @@ -124,7 +124,7 @@ Before proceeding, please ensure [system prerequisites](docs/prerequisites.md) a * Optionally, Generate Traffic Using [curl](https://curl.se/) >We can also pass equivalent **JSON configuration** directly to ixia-c controller, without installing snappi, using **curl**. - >The detailed description of each node (and their attributes) in JSON configuration are well documented [here](https://redocly.github.io/redoc/?url=https://github.com/open-traffic-generator/models/releases/download/v0.6.13/openapi.yaml). + >The detailed description of each node (and their attributes) in JSON configuration are well documented [here](https://redocly.github.io/redoc/?url=https://github.com/open-traffic-generator/models/releases/download/v0.7.2/openapi.yaml). ```bash # push the contents of config file snappi-tests/configs/quickstart_snappi.json diff --git a/snappi-tests b/snappi-tests index 1b683bad..8ec04a93 160000 --- a/snappi-tests +++ b/snappi-tests @@ -1 +1 @@ -Subproject commit 1b683bad8fa338d9907eb8b2ad34cd940d06ac29 +Subproject commit 8ec04a9364187b9619782ecc88f2acf2b3255ba9