Skip to content

Commit

Permalink
Merge pull request #100 from open-traffic-generator/dev-29th-sept
Browse files Browse the repository at this point in the history
draft for ixia-c release v0.0.1-3423
  • Loading branch information
biplamal authored Sep 29, 2022
2 parents 684a3c5 + 70b7798 commit d9b1938
Show file tree
Hide file tree
Showing 6 changed files with 52 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/deployments.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ All these services are available as docker images on [GitHub Open-Traffic-Genera
<img src="res/ixia-c-aur.drawio.svg"></img>
</div>

> Once the services are deployed, [snappi-tests](https://github.com/open-traffic-generator/snappi-tests/tree/743a37a), 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/227a2af), a collection of [snappi](https://pypi.org/project/snappi/) test scripts and configurations, can be setup to run against Ixia-c.
### Bootstrap

Expand Down
6 changes: 3 additions & 3 deletions docs/hello-snappi.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/743a37a/scripts/hello_snappi.py) covers this extensively.
The script [hello_snappi.py](https://github.com/open-traffic-generator/snappi-tests/tree/227a2af/scripts/hello_snappi.py) covers this extensively.
<div align="center">
<img src="res/ixia-c.drawio.svg"></img>
</div>
Expand Down Expand Up @@ -413,6 +413,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/743a37a/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/227a2af/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/743a37a) 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/227a2af) for more such examples, pytest-based test scripts and utilities.
8 changes: 8 additions & 0 deletions docs/news.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# News

* **29th September, 2022**: Ixia-c version 0.0.1 (build 3423) released. This conforms to **[v0.9.1](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/open-traffic-generator/models/v0.9.1/artifacts/openapi.yaml)** of the Open Traffic Generator Models specification.

**Announcement**

`ixia-c` container images is hosted on [GitHub Container Registry](https://github.com/orgs/open-traffic-generator/packages). However we will continue publishing `ixia-c` container images to [DockerHub](https://hub.docker.com/r/ixiacom) until 18th November, 2022.

* This build includes stability fixes. [Read more](releases.md)

* **16th September, 2022**: Ixia-c version 0.0.1 (build 3383) released. This conforms to **[v0.9.1](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/open-traffic-generator/models/v0.9.1/artifacts/openapi.yaml)** of the Open Traffic Generator Models specification.

**Announcement**
Expand Down
38 changes: 38 additions & 0 deletions docs/releases.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,43 @@
# Ixia-c Release Notes and Version Compatibility

## Release v0.0.1-3423
> 29th September, 2022
#### Announcement

`ixia-c` container images is hosted on [GitHub Container Registry](https://github.com/orgs/open-traffic-generator/packages). However we will continue publishing `ixia-c` container images to [DockerHub](https://hub.docker.com/r/ixiacom) until 18th November, 2022.

#### About

This build contains stability fixes.

#### Build Details

| Component | Version |
|-------------------------------|---------------|
| Open Traffic Generator API | [0.9.1](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/open-traffic-generator/models/v0.9.1/artifacts/openapi.yaml) |
| snappi | [0.9.4](https://pypi.org/project/snappi/0.9.4) |
| gosnappi | [0.9.4](https://pkg.go.dev/github.com/open-traffic-generator/snappi/[email protected]) |
| ixia-c-controller | [0.0.1-3423](https://github.com/orgs/open-traffic-generator/packages/container/package/ixia-c-controller) |
| ixia-c-traffic-engine | [1.6.0.19](https://github.com/orgs/open-traffic-generator/packages/container/package/ixia-c-traffic-engine) |
| ixia-c-app-usage-reporter | [0.0.1-37](https://github.com/orgs/open-traffic-generator/packages/container/package/ixia-c-app-usage-reporter) |
| ixia-c-protocol-engine | [1.00.0.232](https://github.com/orgs/open-traffic-generator/packages/container/package/licensed%2Fixia-c-protocol-engine) |
| ixia-c-operator | [0.2.2](https://github.com/orgs/open-traffic-generator/packages/container/package/ixia-c-operator) |
| ixia-c-gnmi-server | [1.9.5](https://github.com/orgs/open-traffic-generator/packages/container/package/ixia-c-gnmi-server) |
| ixia-c-one | [0.0.1-3423](https://github.com/orgs/open-traffic-generator/packages/container/package/ixia-c-one/) |

#### Known Issues

* The metric `loss` in flow metrics is currently not supported.
* When flow transmit is started, transmission will be restarted on any existing flows already transmitting packets.

#### Known Limitations

* Supported value for `flows[i].metrics.latency.mode` is `cut_through`.

* The metric `loss` in flow metrics is currently not supported.
* When flow transmit is started, transmission will be restarted on any existing flows already transmitting packets.

## Release v0.0.1-3383
> 16th September, 2022
Expand Down
2 changes: 1 addition & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
</h4>

<p align="center">
<a href="https://github.com/orgs/open-traffic-generator/packages/container/package/ixia-c-controller"><img alt="Release v0.0.1-3383" src="https://img.shields.io/badge/release-v0.0.1--3383-brightgreen"></a>
<a href="https://github.com/orgs/open-traffic-generator/packages/container/package/ixia-c-controller"><img alt="Release v0.0.1-3423" src="https://img.shields.io/badge/release-v0.0.1--3423-brightgreen"></a>
<a href="https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/open-traffic-generator/models/v0.9.1/artifacts/openapi.yaml"><img alt="Open Traffic Generator v0.9.1" src="https://img.shields.io/badge/open--traffic--generator-v0.9.1-brightgreen"></a>
<a href="https://pypi.org/project/snappi/0.9.4"><img alt="snappi v0.9.4" src="https://img.shields.io/badge/snappi-v0.9.4-brightgreen"></a>
<a href="docs/news.md"><img alt="news" src="https://img.shields.io/badge/-news-blue?logo=github"></a>
Expand Down
2 changes: 1 addition & 1 deletion snappi-tests

0 comments on commit d9b1938

Please sign in to comment.