Update README.md

Data added for minimum resource requirements.
open-traffic-generator · Sep 5, 2023 · 2751906 · 2751906
1 parent 7c4f10f
commit 2751906
Showing 1 changed file with 88 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -95,6 +95,94 @@ status:
   state: DEPLOYED
 ```
 
+## Minimum resource requirement
+
+The minimum memory and cpu requirements for each ixia-c components are captured in the following table. Kubernetes metrics server has been used to collect resource usage data. The memory represents the minimum working set memory required, and for protocol and traffic engines, varies depending on the number of colocated ports. The figures are in Mi or MB.
+
+                | --------------- | ------- | ------- | ------- | ------- | ------- |
+                | Component       | 1 Port  | 2 Port  | 4 Port  | 6 Port  | 8 Port  |
+                |                 | Default |         |         |         |         |
+                | --------------- | ------- | ------- | ------- | ------- | ------- |
+                | Protocol Engine |   350   |   420   |   440   |   460   |   480   |
+                | --------------- | ------- | ------- | ------- | ------- | ------- |
+                | Traffic Engine  |    60   |    70   |    90   |   110   |   130   |
+                | --------------- | ------- | ------- | ------- | ------- | ------- |
+                | Controller      |    25   |         |         |         |         |
+                | --------------- | ------- | ------- | ------- | ------- | ------- |
+                | gNMI            |    15   |         |         |         |         |
+                | --------------- | ------- | ------- | ------- | ------- | ------- |
+                
+The cpu resource figures are in millicores.
+
+                | ---------- | -------- | ------- | ---------- | ----- |
+                |            | Protocol | Traffic | Controller | gNMI  |
+                |            | Engine   | Engine  |            |       |
+                | ---------- | -------- | ------- | ---------- | ----- |
+                | Min CPU    |   200    |   200   |     10     |   10  |
+                | ---------- | -------- | ------- | ---------- | ----- |
+
+The operator sets the minimum memory requirement for each ixia-c component depending on the port configuration. The minimum cpu requirement is set to a default value for each component.
+
+### Minimum resource usage based on various test configurations
+
+Depending on the nature of test run, the memory and cpu resource requirements may vary across all ixia-c components. The following tables capture the memory usage for lag scenarios with varying numbers of member ports. The minimum value represents initial memory on topology deployment and maximum value indicates the peak memory usage during the test run. Figures are in Mi or MB.
+
+                | ---------- | ------- | ------ | ------ | ------ | ------ | ------ |
+                | Component  | Min/Max | 1 Port | 2 Port | 4 Port | 6 Port | 8 Port |
+                | ---------- | ------- | ------ | ------ | ------ | ------ | ------ |
+                |            | Max     |   348  |   423  |   455  |   464  |   492  |
+                | Protocol   | ------- | ------ | ------ | ------ | ------ | ------ |
+                | Engine     | Min     |   323  |   360  |   360  |   360  |   360  |
+                | ---------- | ------- | ------ | ------ | ------ | ------ | ------ |
+                |            | Max     |    58  |    68  |    90  |   111  |   134  |
+                | Traffic    | ------- | ------ | ------ | ------ | ------ | ------ |
+                | Engine     | Min     |    47  |    49  |    49  |    49  |    49  |
+                | ---------- | ------- | ------ | ------ | ------ | ------ | ------ |
+                |            | Max     |    21  |    21  |    23  |    24  |    25  |
+                | Controller | ------- | ------ | ------ | ------ | ------ | ------ |
+                |            | Min     |    13  |    13  |    13  |    13  |    13  |
+                | ---------- | ------- | ------ | ------ | ------ | ------ | ------ |
+                |            | Max     |    14  |    14  |    14  |    14  |    14  |
+                | gNMI       | ------- | ------ | ------ | ------ | ------ | ------ |
+                |            | Min     |     7  |     7  |     7  |     7  |     7  |
+                | ---------- | ------- | ------ | ------ | ------ | ------ | ------ |
+
+Following is the memory usage variation with scaling in control plane. The variation is on the number of BGP sessions (1K, 5K and 10K), in a back to back setup. Figures are in Mi or MB.
+
+                | ---------- | ------- | ------ | ------ | ------ |
+                | Component  | Min/Max |   1K   |   5K   |  10K   |
+                | ---------- | ------- | ------ | ------ | ------ |
+                |            | Max     |   516  |   906  |  1367  |
+                | Protocol   | ------- | ------ | ------ | ------ |
+                | Engine     | Min     |   323  |   323  |   323  |
+                | ---------- | ------- | ------ | ------ | ------ |
+                |            | Max     |    53  |   149  |   259  |
+                | Controller | ------- | ------ | ------ | ------ |
+                |            | Min     |    12  |    12  |    12  |
+                | ---------- | ------- | ------ | ------ | ------ |
+                |            | Max     |     7  |     7  |     7  |
+                | gNMI       | ------- | ------ | ------ | ------ |
+                |            | Min     |     7  |     7  |     7  |
+                | ---------- | ------- | ------ | ------ | ------ |
+
+Following is the memory usage variation with scaling in data plane. The variation is on the number of MPLS flows (10, 1K and 4K), in a back to back setup with labels provided by RSVP-TE control plane. Figures are in Mi or MB.
+
+                | ---------- | ------- | ------ | ------ | ------ |
+                | Component  | Min/Max |   10   |   1K   |   4K   |
+                | ---------- | ------- | ------ | ------ | ------ |
+                |            | Max     |    58  |    59  |    95  |
+                | Traffic    | ------- | ------ | ------ | ------ |
+                | Engine     | Min     |    47  |    47  |    47  |
+                | ---------- | ------- | ------ | ------ | ------ |
+                |            | Max     |    18  |    46  |   120  |
+                | Controller | ------- | ------ | ------ | ------ |
+                |            | Min     |    12  |    12  |    12  |
+                | ---------- | ------- | ------ | ------ | ------ |
+                |            | Max     |    10  |    17  |    28  |
+                | gNMI       | ------- | ------ | ------ | ------ |
+                |            | Min     |     7  |     7  |     7  |
+                | ---------- | ------- | ------ | ------ | ------ |
+
 ## Deployment
 
 Please make sure that the setup meets [Deployment Prerequisites](#deployment-prerequisites).