Skip to content

Commit

Permalink
Merge pull request #89 from open-traffic-generator/dev-4th-August
Browse files Browse the repository at this point in the history
Release v0.0.1-3027
  • Loading branch information
biplamal authored Aug 4, 2022
2 parents 1050a95 + 6b35603 commit 6dc62f0
Show file tree
Hide file tree
Showing 6 changed files with 53 additions and 14 deletions.
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.8.5](https://github.com/open-traffic-generator/models/releases/tag/v0.8.5)** 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.8.5/artifacts/openapi.yaml).
Ixia-c implements version **[v0.8.6](https://github.com/open-traffic-generator/models/releases/tag/v0.8.6)** 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.8.6/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.8.5 dpkt
python -m pip install --upgrade snappi==0.8.8 dpkt
```

### Create API Handle
Expand Down Expand Up @@ -100,17 +100,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.8.5/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.8.6/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.8.5/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.8.6/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.8.5**. To use a different API version instead:
The snappi API documentation linked above will always point to API version **v0.8.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.8.5/models-release">this link</a> in a browser and replacing **v0.8.5** in URL with intended snappi version.
* Identify API version by opening <a href="https://github.com/open-traffic-generator/snappi/releases/download/v0.8.8/models-release">this link</a> in a browser and replacing **v0.8.8** in URL with intended snappi version.

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

</details>

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

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

* Support added for static `MPLS` packet header in flows. [Read more](releases.md)


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

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

## Release v0.0.1-3002 (Latest)
## Release v0.0.1-3027 (Latest)
> 4th August, 2022
#### About

Support added for static `MPLS` packet header in flows.

#### Build Details

| Component | Version |
|-------------------------------|---------------|
| Open Traffic Generator API | [0.8.6](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/open-traffic-generator/models/v0.8.6/artifacts/openapi.yaml) |
| snappi | [0.8.8](https://pypi.org/project/snappi/0.8.8) |
| gosnappi | [0.8.8](8https://pkg.go.dev/github.com/open-traffic-generator/snappi/[email protected]) |
| ixia-c-controller | [0.0.1-3027](https://hub.docker.com/r/ixiacom/ixia-c-controller/tags) |
| ixia-c-traffic-engine | [1.4.1.29](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.209 |
| ixia-c-operator | [0.1.94](https://hub.docker.com/r/ixiacom/ixia-c-operator/tags) |
| ixia-c-gnmi-server | [1.8.10](https://hub.docker.com/r/ixiacom/ixia-c-gnmi-server/tags) |
| ixia-c-grpc-server | [0.8.8](https://hub.docker.com/r/ixiacom/ixia-c-grpc-server/tags) |
| ixia-c-one | [0.0.1-3027](https://github.com/orgs/open-traffic-generator/packages/container/package/ixia-c-one/) |

#### Release Features(s)

* Support added for static `MPLS` packet header in flows.
- Fixed value is supported for all fields.
- Dynamic `MPLS` is not supported yet.
- `label` field's default choice is `value` if it is selected as `auto`.

#### Known Issues

* The metric `loss` in flow metrics is currently not supported.

## Release v0.0.1-3002
> 27th July, 2022
#### 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://hub.docker.com/r/ixiacom/ixia-c-controller/tags"><img alt="Release v0.0.1-3002" src="https://img.shields.io/badge/release-v0.0.1--3002-brightgreen"></a>
<a href="https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/open-traffic-generator/models/v0.8.5/artifacts/openapi.yaml"><img alt="Open Traffic Generator v0.8.5" src="https://img.shields.io/badge/open--traffic--generator-v0.8.5-brightgreen"></a>
<a href="https://pypi.org/project/snappi/0.8.5"><img alt="snappi v0.8.5" src="https://img.shields.io/badge/snappi-v0.8.5-brightgreen"></a>
<a href="https://hub.docker.com/r/ixiacom/ixia-c-controller/tags"><img alt="Release v0.0.1-3027" src="https://img.shields.io/badge/release-v0.0.1--3027-brightgreen"></a>
<a href="https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/open-traffic-generator/models/v0.8.6/artifacts/openapi.yaml"><img alt="Open Traffic Generator v0.8.6" src="https://img.shields.io/badge/open--traffic--generator-v0.8.6-brightgreen"></a>
<a href="https://pypi.org/project/snappi/0.8.8"><img alt="snappi v0.8.8" src="https://img.shields.io/badge/snappi-v0.8.8-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.8.5
python -m pip install --upgrade snappi==0.8.8
# run a standalone script to generate TCP traffic and fetch metrics
python snappi-tests/scripts/quickstart_snappi.py
```
Expand Down Expand Up @@ -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://raw.githubusercontent.com/open-traffic-generator/models/v0.8.5/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.8.6/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 6dc62f0

Please sign in to comment.