Skip to content

Commit

Permalink
Merge pull request #155 from open-traffic-generator/dev-14th-sep
Browse files Browse the repository at this point in the history 
Release v0.0.1-4478
  • Loading branch information
@apratimmukherjee
apratimmukherjee authored Sep 14, 2023
2 parents 57d65b6 + f7fd3aa commit 51bfabc
Show file tree
Hide file tree
Showing 9 changed files with 53 additions and 23 deletions.
2 changes: 1 addition & 1 deletion conformance
Submodule conformance updated 9 files
+6 −6 deployments/ixia-c-config.yaml
+1 −1 do.sh
+8 −0 feature/b2b/bgp/ebgp_route_prefix_test.go
+299 −0 feature/b2b/bgp/ibgp_route_prefix_test.go
+7 −7 go.mod
+229 −12 go.sum
+29 −1 helpers/otg/states.go
+1 −1 requirements.txt
+5 −5 versions.yaml
8 changes: 4 additions & 4 deletions deployments/k8s/components/images/kustomization.yaml
View file
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-4435
# Release: https://github.com/open-traffic-generator/ixia-c/releases/tag/v0.0.1-4478
images:
- name: ixia-c-controller
newName: ghcr.io/open-traffic-generator/ixia-c-controller
newTag: "0.0.1-4435"
newTag: "0.0.1-4478"
- name: ixia-c-gnmi-server
newName: ghcr.io/open-traffic-generator/ixia-c-gnmi-server
newTag: "1.12.4"
newTag: "1.12.5"
- name: ixia-c-traffic-engine
newName: ghcr.io/open-traffic-generator/ixia-c-traffic-engine
newTag: "1.6.0.35"
newTag: "1.6.0.45"
2 changes: 1 addition & 1 deletion docs/deployments.md
View file
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/1813f4a), 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/59de74b), a collection of [snappi](https://pypi.org/project/snappi/) test scripts and configurations, can be setup to run against Ixia-c.
### Bootstrap

Expand Down
2 changes: 1 addition & 1 deletion docs/faq.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ What version of the Open Traffic Generator spec does Ixia-c implement?
</summary>
<br>

Ixia-c implements version **[v0.12.2](https://github.com/open-traffic-generator/models/releases/tag/v0.12.2)** of the Open Traffic Generator Data Model. You can view the model [here](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/open-traffic-generator/models/v0.12.2/artifacts/openapi.yaml).
Ixia-c implements version **[v0.12.3](https://github.com/open-traffic-generator/models/releases/tag/v0.12.3)** of the Open Traffic Generator Data Model. You can view the model [here](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/open-traffic-generator/models/v0.12.3/artifacts/openapi.yaml).

</details>

Expand Down
18 changes: 9 additions & 9 deletions docs/hello-snappi.md
View file
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/1813f4a/scripts/hello_snappi.py) covers this extensively.
The script [hello_snappi.py](https://github.com/open-traffic-generator/snappi-tests/tree/59de74b/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.12.2 dpkt
python -m pip install --upgrade snappi==0.12.3 dpkt
```

### Create API Handle
Expand Down Expand Up @@ -107,17 +107,17 @@ We now need to construct traffic configuration to be sent to controller. We'll n
> By default, API requests in snappi are made over HTTPS with payloads as a JSON string. Since each object in snappi inherits `SnappiObject` or `SnappiIter`, they all share a common method called `.serialize()` and `deserialize()`, used internally during API requests, for valid conversion to / from a JSON string. We'll discuss about more such conveniences offered by snappi along the way.
<details>
<summary><b>Expand</b> this section for details on how to effectively navigate through <a href="https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/open-traffic-generator/models/v0.12.2/artifacts/openapi.yaml">snappi API documentation</a>.</summary><br/>
<summary><b>Expand</b> this section for details on how to effectively navigate through <a href="https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/open-traffic-generator/models/v0.12.3/artifacts/openapi.yaml">snappi API documentation</a>.</summary><br/>

The objects and methods (for API calls) in snappi are auto-generated from an [Open API Generator YAML file](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/open-traffic-generator/models/v0.12.2/artifacts/openapi.yaml). This file adheres to [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification), which can (by design) also be rendered as an interactive API documentation.
The objects and methods (for API calls) in snappi are auto-generated from an [Open API Generator YAML file](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/open-traffic-generator/models/v0.12.3/artifacts/openapi.yaml). This file adheres to [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification), which can (by design) also be rendered as an interactive API documentation.

[ReDoc](https://redocly.github.io/redoc/) is an open-source tool that does this. It accepts a link to valid OpenAPI YAML file and generates a document where all the methods (for API calls) are mentioned in the left navigation bar and for each selected method, there's a request / response body description in the center of the page. These descriptions lay out the entire object tree documenting each node in details.

The snappi API documentation linked above will always point to API version **v0.12.2**. To use a different API version instead:
The snappi API documentation linked above will always point to API version **v0.12.3**. To use a different API version instead:

* Identify API version by opening <a href="https://github.com/open-traffic-generator/snappi/releases/download/v0.12.2/models-release">this link</a> in a browser and replacing **v0.12.2** in URL with intended snappi version.
* Identify API version by opening <a href="https://github.com/open-traffic-generator/snappi/releases/download/v0.12.3/models-release">this link</a> in a browser and replacing **v0.12.3** in URL with intended snappi version.

* Open <a href="https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/open-traffic-generator/models/v0.12.2/artifacts/openapi.yaml">this link</a> in a browser after replacing **v0.12.2** in URL with intended API version.
* Open <a href="https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/open-traffic-generator/models/v0.12.3/artifacts/openapi.yaml">this link</a> in a browser after replacing **v0.12.3** in URL with intended API version.

</details>

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/1813f4a/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/59de74b/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/1813f4a) 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/59de74b) for more such examples, pytest-based test scripts and utilities.
5 changes: 5 additions & 0 deletions docs/news.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# News

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

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


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

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

## Release v0.0.1-4435 (Latest)
## Release v0.0.1-4478 (Latest)
> 1st September, 2023
#### About

This build includes stability fixes.

#### Build Details

| Component | Version |
|-------------------------------|---------------|
| Open Traffic Generator API | [0.12.3](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/open-traffic-generator/models/v0.12.3/artifacts/openapi.yaml) |
| snappi | [0.12.3](https://pypi.org/project/snappi/0.12.3) |
| gosnappi | [0.12.3](https://pkg.go.dev/github.com/open-traffic-generator/snappi/[email protected]) |
| ixia-c-controller | [0.0.1-4478](https://github.com/orgs/open-traffic-generator/packages/container/package/ixia-c-controller) |
| ixia-c-traffic-engine | [1.6.0.45](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.326](https://github.com/orgs/open-traffic-generator/packages/container/package/licensed%2Fixia-c-protocol-engine) |
| ixia-c-ixhw-server | [0.12.3-2](https://github.com/orgs/open-traffic-generator/packages/container/package/ixia-c-ixhw-server) |
| ixia-c-operator | [0.3.6](https://github.com/orgs/open-traffic-generator/packages/container/package/ixia-c-operator) |
| ixia-c-gnmi-server | [1.12.5](https://github.com/orgs/open-traffic-generator/packages/container/package/ixia-c-gnmi-server) |
| ixia-c-one | [0.0.1-4478](https://github.com/orgs/open-traffic-generator/packages/container/package/ixia-c-one/) |
`


## Release v0.0.1-4435
> 1st September, 2023
#### About
Expand Down
10 changes: 5 additions & 5 deletions readme.md
View file
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-4435" src="https://img.shields.io/badge/release-v0.0.1--4435-brightgreen"></a>
<a href="https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/open-traffic-generator/models/v0.12.2rtifacts/openapi.yaml"><img alt="Open Traffic Generator v0.12.2" src="https://img.shields.io/badge/open--traffic--generator-v0.12.2-brightgreen"></a>
<a href="https://pypi.org/project/snappi/0.12.2"><img alt="snappi v0.12.2" src="https://img.shields.io/badge/snappi-v0.12.2-brightgreen"></a>
<a href="https://github.com/orgs/open-traffic-generator/packages/container/package/ixia-c-controller"><img alt="Release v0.0.1-4478" src="https://img.shields.io/badge/release-v0.0.1--4478-brightgreen"></a>
<a href="https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/open-traffic-generator/models/v0.12.3rtifacts/openapi.yaml"><img alt="Open Traffic Generator v0.12.3" src="https://img.shields.io/badge/open--traffic--generator-v0.12.3-brightgreen"></a>
<a href="https://pypi.org/project/snappi/0.12.3"><img alt="snappi v0.12.3" src="https://img.shields.io/badge/snappi-v0.12.3-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.12.2
python -m pip install --upgrade snappi==0.12.3
# run a standalone script to generate TCP traffic and fetch metrics
python snappi-tests/scripts/quickstart_snappi.py
```
Expand Down Expand Up @@ -127,7 +127,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://raw.githubusercontent.com/open-traffic-generator/models/v0.12.2/artifacts/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://raw.githubusercontent.com/open-traffic-generator/models/v0.12.3/artifacts/openapi.yaml).
```bash
# push the contents of config file snappi-tests/configs/quickstart_snappi.json
Expand Down
2 changes: 1 addition & 1 deletion snappi-tests
Submodule snappi-tests updated 1 files
+1 −1 readme.md

0 comments on commit 51bfabc

Please sign in to comment.