user guide is ready

open-traffic-generator · Nov 14, 2023 · 0470b77 · 0470b77
1 parent 52f77fd
commit 0470b77
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 18 deletions.
diff --git a/docs/integrated-environments.md b/docs/integrated-environments.md
@@ -1,18 +1,6 @@
-# Integrated environments
+## Network Topology Emulation
 
-To successfully use an OTG-based Traffic Generator, you need to be able to execute the following tasks over the OTG API:
-
-* Prepare a Configuration and apply it to a Traffic Generator
-* Control states of the configured objects like Protocols or Traffic Flows
-* Collect and analyze Metrics reported by the Traffic Generator
-
-It is a job of an OTG Client to perform these tasks by communicating with a Traffic Generator via the OTG API. There are different types of such clients, and the choice between them depends on how and where you want to use a Traffic Generator.
-
-[OTG examples](https://github.com/open-traffic-generator/otg-examples) repository is a great way to get started with [Open Traffic Generator API](https://otg.dev/). It features a collection of software-only network labs ranging from very simple to more complex. To setup the network labs in software, use the containerized or virtualized NOS images.
-
-## Infrastructure
-
-To manage the deployment of the example labs, use one of the following tools:
+Ixia-c supports the following modern network emulation software:
 
 * [Containerlab:](deployments-containerlab.md) Simple yet powerful specialized tool for orchestrating and managing container-based networking labs.
 * [OpenConfig KNE:](deployments-kne.md) Kubernetes Network Emulation, which is a Google initiative to develop tooling for quickly setting up topologies of containers running various device OSes.
diff --git a/docs/user-guide-introduction.md b/docs/user-guide-introduction.md
@@ -21,11 +21,15 @@ The main components of KENG are:
 | [UHD400T](tests-uhd400.md)            | Composable test ports based on line-rate white-box switch hardware traffic generator and Ixia-c protocol emulation software. |
 | [IxOS Hardware](tests-chassis-app.md) | Keysight Novus or AresONE high-performance network test hardware running IxOS.  |
 
-## Ixia-c Community Edition
+## Clients
 
-Ixia-c Community Edition is a free-to-use version of the Ixia-c container-based traffic generator. The Community Edition supports up to 4 test ports and stateless layer 2-3 traffic flows.
+To successfully use an OTG-based Traffic Generator, you need to be able to execute the following tasks over the OTG API:
 
-## Clients
+* Prepare a Configuration and apply it to a Traffic Generator
+* Control states of the configured objects like Protocols or Traffic Flows
+* Collect and analyze Metrics reported by the Traffic Generator
+
+It is a job of an OTG Client to perform these tasks by communicating with a Traffic Generator via the OTG API. There are different types of such clients, and the choice between them depends on how and where you want to use a Traffic Generator.
 
 There are multiple ways to communicate with KENG through the OTG API:
 
@@ -35,3 +39,9 @@ There are multiple ways to communicate with KENG through the OTG API:
 | snappi  | A library that makes it easy create test programs in Python or Go  |
 | direct REST or gRPC calls  | An alternative to using snappi  |
 | custom OTG client  | Custom OTG client applications  |
+
+
+## OTG Examples
+
+[OTG examples](https://github.com/open-traffic-generator/otg-examples) repository is a great way to get started with [Open Traffic Generator API](https://otg.dev/). It features a collection of software-only network labs ranging from very simple to more complex. To setup the network labs in software, use the containerized or virtualized NOS images.
+
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -66,7 +66,7 @@ nav:
       - UHD400T: tests-uhd400.md # This is UHD400 intro. Not deployment, not scripts. Need to align with HW
       - IxOS Hardware: tests-chassis-app.md # This this HW deployment, there is no scripts (and likely should not be)
 #    - Use cases: usecases.md # Remove for now, rethink what is this later
-    - Integrated environments: integrated-environments.md # A strange mix of otg-examples and clab/kne. Move Clab/KNE deployments here
+    - Integrations: integrated-environments.md # A strange mix of otg-examples and clab/kne. Move Clab/KNE deployments here
     - Limitations: limitations.md # Align with the DS, clarify if this is for Ixia-c/UHD/HW
     - Troubleshooting: troubleshooting.md # Move how to see logs from Deployment here
     - Licensing: licensing.md # Update from otg-examples