Skip to content

Commit 64cd404

Browse files
digger-yuhhaim
authored andcommitted
fix some typo under doc/
fix typo change htttp_eflow4 to http_eflow4
1 parent d69a490 commit 64cd404

11 files changed

+34
-34
lines changed

doc/analyticsBlog.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ endif::backend-xhtml11[]
2525

2626
= How do we track TRex performance Using ElasticSearch, Grafana and Pandas
2727
The ability to monitor TRex performance on many setups/configurations on a daily basis may have a large impact on our ability to identify TRex performance degradation.
28-
For a long time our monitoring method was based on hard coded boundaries, we have defined maximum and minimum values for each test/'s result and any exeception triggered a notification.
28+
For a long time our monitoring method was based on hard coded boundaries, we have defined maximum and minimum values for each test/'s result and any exception triggered a notification.
2929
This monitoring method had a lot of false positives which in turn increased the investigation time. Moreover this method introduced more complexity through the need to maintain the golden results for many test cases on various platforms.
3030

3131
A new method was required which would enable us to:
@@ -104,7 +104,7 @@ image:images/blog/figure5.jpg[title="figure5",align="left",width={p_width}, link
104104
[small]#Figure 5# +
105105

106106
https://github.com/cisco-system-traffic-generator/trex-core/blob/master/doc/AnalyticsConnect.py/[View this on GitHub] +
107-
More on: https://developers.google.com/analytics/devguides/reporting/core/v3/quickstart/service-py/[Google API on Documantation] [4]
107+
More on: https://developers.google.com/analytics/devguides/reporting/core/v3/quickstart/service-py/[Google API on Documentation] [4]
108108

109109
== Analysis using python pandas
110110
=== A word on Pandas

doc/packet_builder_yaml.asciidoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ The format should be *YAML*
113113
| uint64 | sub fields of this header | 64
114114
| other class type | name of other class. for example, "c-mac-addr"; take fields from there, optionally overload them later | The size taken from that class
115115
| Payload | xref:Payload[Payload] | total packet size - all header until now
116-
| vlen_t | in case of varible size header this include the size to the end of varible size header see example xref:IpvOption[Ipv4Option] |total size of the object
116+
| vlen_t | in case of variable size header this include the size to the end of variable size header see example xref:IpvOption[Ipv4Option] |total size of the object
117117
|=================
118118

119119

@@ -189,7 +189,7 @@ The format should be *YAML*
189189
| next_headers | string or type | a name of class that define the next or just an array | "none" | xref:Next_headers[Next_headers] |
190190
| fields | array | array of Field_Type | [] | | fields : [ ]
191191
| offset | integer/string | offset into the packet in bits, in case of auto add base of prev fields | "auto" | |
192-
| option | string | a java code that define a way to calculate varible size | "none" | | |
192+
| option | string | a java code that define a way to calculate variable size | "none" | | |
193193
|=================
194194

195195

@@ -318,7 +318,7 @@ root -> L2 ( Ethernet , 802.3 , LLC SNAP )
318318
* There would be a spare field in the Stream object so GUI could add more metadata for reconstructing the builder types
319319
for example in this example Ethernet/IP/TCP/IP/TCP you can't extrac from buffer alone that Payload is IP/TCP only the builder known that in build time.
320320
* Ip total length need to keep the total_pkt_size - this ip header . this should work for internal header too.
321-
* When GUI add header ("external") the total size of this header should be calculated ( varible size should be given a default - ipv4)
321+
* When GUI add header ("external") the total size of this header should be calculated ( variable size should be given a default - ipv4)
322322

323323

324324
=== Examples
@@ -385,7 +385,7 @@ other : Byte : Length ( +first) |option
385385
386386
----
387387

388-
* case of varible length field ip_option example
388+
* case of variable length field ip_option example
389389

390390

391391

@@ -401,7 +401,7 @@ other : Byte : Length ( +first) |option
401401
default : [0x00, 0x00, 0x01, 0x00, 0x00, 0x00]
402402
gui_representation:
403403
data_type : "mac-addr_t" # format ([0-9a-fA-F]{2}:){5}[0-9a-fA-F]{2}
404-
help : "Mac addrees"
404+
help : "Mac address"
405405
406406
407407
- class : "ethernet"
@@ -560,7 +560,7 @@ other : Byte : Length ( +first) |option
560560
- class : "root" # reserve
561561
gui_representation:
562562
help : "Root"
563-
next_headers : [ "ethrenet" ,"llc","_802-3"]
563+
next_headers : [ "ethernet" ,"llc","_802-3"]
564564
---------------------------
565565

566566

@@ -575,7 +575,7 @@ In this example parent class default value overrides default values of sub-field
575575
type : "uint8"
576576
array_size : 6
577577
gui_representation:
578-
help : "Mac addrees"
578+
help : "Mac address"
579579
data_type : "mac-addr_t" # format ([0-9a-fA-F]{2}:){5}[0-9a-fA-F]{2}
580580
default : [0x00,0x00,0x01,0x00,0x00,0x00]
581581

doc/release_notes_old.asciidoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -663,7 +663,7 @@ which was released on v2.16
663663
== Release 2.13 ==
664664

665665
* Significantly improve performance and scale for stateful case with high active flows (70%-300% better) see here link:trex_manual.html#_more_active_flows[More active flows]
666-
* Stateful with low active repeatable flows - an optimization was removed, for example `cap2/imix_fast_1g.yaml`. users that want to get this in high performance are adviced to move to Stateles mode. Removing this support improved the common case.
666+
* Stateful with low active repeatable flows - an optimization was removed, for example `cap2/imix_fast_1g.yaml`. users that want to get this in high performance are adviced to move to Stateless mode. Removing this support improved the common case.
667667
* Support NAT without IPv4.option and UDP flows- for ASA link:https://trex-tgn.cisco.com/youtrack/issue/trex-274[trex-274]
668668
* Scapy server is restart automatically - for future Stateless GUI link:https://trex-tgn.cisco.com/youtrack/issue/trex-291[trex-291]
669669
* Add minimum ipg for remote pcap link:https://trex-tgn.cisco.com/youtrack/issue/trex-281[trex-281]
@@ -691,7 +691,7 @@ which was released on v2.16
691691

692692
* Improve support for Mellanox ConnectX-4 cards (100/50/25GbE)
693693
** Only CentOs/RedHat 7.2 and up is supported due to OFED issues
694-
** Improve 64Byte Stateleess performance
694+
** Improve 64Byte Stateless performance
695695
* Cisco VIC is fully supported
696696
* Stateless L2/L3 configuration mode for ports - link:trex_stateless.html#_port_layer_mode_configuration[Port Layer Mode Configuration]
697697
* Stateless neighboring protocols infra and first protocols support/Python API - link:trex_stateless.html#_neighboring_protocols[Neighboring Protocols]
@@ -799,7 +799,7 @@ See link:trex_manual.html#_configuration_yaml_parameter_of_cfg_option[here] and
799799
* DPDK 16.07
800800
* ASYNC ZMQ is compressed by default. It improves response time see link:http://trex-tgn.cisco.com/youtrack/issue/trex-232[trex-232]
801801
** You will need to update the GUI
802-
* Support Ubuntu 16.01 - Stateful serverr is Python 3.0 and Python 3.5 for ZMQ library
802+
* Support Ubuntu 16.01 - Stateful server is Python 3.0 and Python 3.5 for ZMQ library
803803
* XL710/X710 low latency was improved - see link:http://trex-tgn.cisco.com/youtrack/issue/trex-214[trex-214]
804804
* Support graceful shutdown command
805805
* Console - support L1 BPS using `-m 10bpsl1` see link:http://trex-tgn.cisco.com/youtrack/issue/trex-230[trex-230]
@@ -906,7 +906,7 @@ For XL710/X710 there is a need to upgrade the firmware to 5.04 (or later)
906906
** Add tx/rx graphs
907907
* Python API: add an API for reading events as warning/errors
908908
* HLTAPI support for per stream stats
909-
* support VALN mode for per stream stats for 82599 using `--vlan` switch at server invocation
909+
* support VLAN mode for per stream stats for 82599 using `--vlan` switch at server invocation
910910
* A peek into TRex stateless GUI version for evaluation still without many features like packet builder, advance packet builder, per stream stats link:https://www.dropbox.com/s/vs9gojtdc5ewv05/setupCiscoTrex1.96-SNAPSHOT.exe?dl=0[TRex Stateless GUI Download]
911911
** Only pcap file packet builder is supported in this version
912912

@@ -1103,7 +1103,7 @@ optional arguments:
11031103
-s SPEEDUP, --speedup SPEEDUP
11041104
Factor to accelerate the injection. effectively means
11051105
IPG = IPG / SPEEDUP
1106-
--force Set if you want to stop active ports before appyling
1106+
--force Set if you want to stop active ports before applying
11071107
command.
11081108
TRex >push -f cap2/dns.pcap --port 0 -i 10
11091109
-------------------
@@ -1236,7 +1236,7 @@ TRex > start -f stl/profiles/udp_1pkt.py -a -m 1mbps
12361236
== Release 1.78 ==
12371237

12381238
* some clean up in tuple generator
1239-
* trex stateles console works with trex-mock
1239+
* trex stateless console works with trex-mock
12401240

12411241
=== Fixed issues: ===
12421242

doc/trex_appendix_asa_5585.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ TRex with ASA 5585
88

99
include::trex_ga.asciidoc[]
1010

11-
When running TRex aginst ASA 5585, you have to notice following things:
11+
When running TRex against ASA 5585, you have to notice following things:
1212

1313
* ASA can't forward ipv4 options, so there is a need to use --learn-mode 1 (or 3) in case of NAT. In this mode, bidirectional UDP flows are not supported.
1414
--learn-mode 1 support TCP sequence number randomization in both sides of the connection (client to server and server client). For this to work, TRex must learn

doc/trex_appendix_firmware_xl710.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ supports-priv-flags: yes
6666
<3> Unbind from DPDK using this command
6767
<4> Bind to linux to i40e driver
6868
<5> Show firmware version throw linux driver
69-
<6> Firmare version
69+
<6> Firmware version
7070
<7> More info
7171

7272

doc/trex_appendix_linux_vf_config.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The following diagram compares between vSwitch and SR-IOV.
1717

1818
image:images/sr_iov_vswitch.png[title="vSwitch_main",width=850]
1919

20-
One use case which shows the performance gain that can be acheived by using SR-IOV is when a user wants to create a pool of TRex VMs that tests a pool of virtual DUTs (e.g. ASAv,CSR etc.)
20+
One use case which shows the performance gain that can be achieved by using SR-IOV is when a user wants to create a pool of TRex VMs that tests a pool of virtual DUTs (e.g. ASAv,CSR etc.)
2121
When using newly supported SR-IOV, compute, storage and networking resources can be controlled dynamically (e.g by using OpenStack)
2222

2323
image:images/sr_iov_trex.png[title="vSwitch_main",width=850]

doc/trex_appendix_mellanox.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -547,7 +547,7 @@ or the new command
547547
<1> look for the PCI id
548548
<2> run the lspci -vv to find out the Part number
549549
<3> Part number should be MCX516A-CDAT(CX5)/MCX416A-CCAT (CX4) for 100Gb NICS
550-
<4> PCI LnkSta (status) should be x16 and *NOT* x8 in case it is not you should look for UCS PCIe configucation (raiser)
550+
<4> PCI LnkSta (status) should be x16 and *NOT* x8 in case it is not you should look for UCS PCIe configuration (raiser)
551551
<5> Check parent PCI speed to be find where is the problem--> in this case it is 0000:80:03.0
552552
<6> Look for the speed
553553

doc/trex_astf.asciidoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1280,7 +1280,7 @@ We might change the JSON format in the future as this is a first version
12801280

12811281
*Goal*:: Use the TRex ASTF advanced simulator.
12821282

1283-
It is like the simple simulator but simulates multiple templates and flows exacly like TRex server would do with one DP core.
1283+
It is like the simple simulator but simulates multiple templates and flows exactly like TRex server would do with one DP core.
12841284

12851285
[source,bash]
12861286
----
@@ -1552,7 +1552,7 @@ This example will delay the server response by 500 msec.
15521552
15531553
prog_s = ASTFProgram()
15541554
prog_s.recv(len(http_req))
1555-
prog_s.delay_rand(100000,500000); # delay random number betwean 100msec-500msec
1555+
prog_s.delay_rand(100000,500000); # delay random number between 100msec-500msec
15561556
prog_s.send(http_response)
15571557
15581558
----
@@ -1646,7 +1646,7 @@ Usually in case of very long flows there is need to cap the number of active flo
16461646

16471647
By default `send()` command waits for the ACK on the last byte. To make it non-blocking, especially in case big BDP (large window is required) it is possible to work in non-blocking mode, this way to achieve full pipeline.
16481648

1649-
Have a look at `astf/htttp_eflow2.py` example.
1649+
Have a look at `astf/http_eflow2.py` example.
16501650

16511651
.Non-blocking send
16521652
[source,python]
@@ -1691,9 +1691,9 @@ Have a look at `astf/htttp_eflow2.py` example.
16911691
See link:cp_astf_docs/api/profile_code.html#astfprogram-class[astf-program] for more info.
16921692

16931693
==== Tutorial: L7 emulation - Elephant flows with non-blocking send with tick var
1694-
Same as the previous example, only instead of using `loop count` we are using time as a measurement. In the prevous example we calculated the received bytes in advance and use the rcv command with the right bytes values. However, sending & receiving data according to time is tricky and errors/dtops might occur (see stats from runnnig example below).
1694+
Same as the previous example, only instead of using `loop count` we are using time as a measurement. In the prevous example we calculated the received bytes in advance and use the rcv command with the right bytes values. However, sending & receiving data according to time is tricky and errors/dtops might occur (see stats from running example below).
16951695

1696-
Have a look at `astf/htttp_eflow4.py` example.
1696+
Have a look at `astf/http_eflow4.py` example.
16971697

16981698
.Tick var
16991699
[source,python]

doc/trex_astf_vs_nginx.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -442,7 +442,7 @@ NGINX installed on a 2-socket setup with 8 cores/socket (total of 16 cores/32 th
442442
The total number of packets was approximately 600KPPS (Tx+Rx). The number of active flows was 12K.
443443

444444
TRex with one core could scale to about 25Gb/sec, 3MPPS of the same HTTP profile.
445-
The main issue with NGINX and Linux setup is the tunning. It is very hard to let the hardware utilizing the full server resource (half of the server was idel in this case and still experiance a lot of drop)
445+
The main issue with NGINX and Linux setup is the tunning. It is very hard to let the hardware utilizing the full server resource (half of the server was idel in this case and still experience a lot of drop)
446446
TRex is not perfect too, we couldn't reach 100% CPU utilization without a drop (CPU was 84%) need to look if we can improve this but at least we are in the right place for optimization.
447447

448448
Back to our question...

doc/trex_book.asciidoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1004,7 +1004,7 @@ TRex port 0 ( server VLAN1) <-> | DUT | <-> TRex port 1 ( client-VLAN1)
10041004
In this case, traffic on vlan0 is sent as before, while for traffic on vlan1, the order is reversed (client traffic sent on port1 and server traffic on port0).
10051005
TRex divides the flows evenly between the vlans. This results in an equal amount of traffic on each port.
10061006

1007-
*Router configuation:*::
1007+
*Router configuration:*::
10081008
[source,python]
10091009
----
10101010
!
@@ -1191,7 +1191,7 @@ asr1k(config)#ipv6 route 5000::/64 3001::2
11911191
<2> Add pbr
11921192
<3> Enable IPv6 routing
11931193
<4> MAC address setting. Should be TRex MAC.
1194-
<5> PBR configuraion
1194+
<5> PBR configuration
11951195

11961196

11971197
=== Client clustering configuration
@@ -1435,7 +1435,7 @@ For example, in this case 16.0.0.1->48.0.0.1 ICMP will be the flow for latency.
14351435
==== Clustering example
14361436

14371437
In this example we have one DUT with four 10gb interfaces and one TRex with two 40Gb/sec interfaces and we want to convert the traffic from 2 TRex interfaces to 4 DUT Interfaces.
1438-
The folowing figure shows the topology
1438+
The following figure shows the topology
14391439

14401440
.Cluster example
14411441
image:images/cluster_topo1.png[title="Loopback example"]
@@ -1532,14 +1532,14 @@ groups:
15321532
<1> *All* the IPs from client pools and default pool should be maped in this file, it is possible to have wider range in cluster file
15331533

15341534

1535-
The following diagram shows how new flow src_ip/dest_ip/next-hop/vlan is choosen with cluster file
1535+
The following diagram shows how new flow src_ip/dest_ip/next-hop/vlan is chosen with cluster file
15361536

15371537
.Cluster example
15381538
image:images/new_flow_generation.png[title="Loopback example"]
15391539

15401540
[NOTE]
15411541
=====================================================================
1542-
Latency stream will check only 12.1.1.1/4050 path (one DUT intertface) there is no way to check latency on all the ports in current version
1542+
Latency stream will check only 12.1.1.1/4050 path (one DUT interface) there is no way to check latency on all the ports in current version
15431543
=====================================================================
15441544

15451545
[NOTE]
@@ -1550,7 +1550,7 @@ DUT should have a static route to move packets from client to server and vice ve
15501550

15511551
An example of one flow generation
15521552

1553-
1. next hop resolotion. TRex resolve all the next hop option e.g. 11.10.0.1/4050 11.11.0.1/4051
1553+
1. next hop resolution. TRex resolve all the next hop option e.g. 11.10.0.1/4050 11.11.0.1/4051
15541554
2. Choose template by CPS, 50% probability for each. take template #1
15551555
3. SRC_IP=12.1.1.2, DEST_IP=13.1.1.2
15561556
4. Allocate src_port for 12.1.1.2 ==>src_port=1025 for the first flow of client=12.1.1.2
@@ -1688,7 +1688,7 @@ groups:
16881688
16891689
16901690
----
1691-
<1> We added more clusters beacuse more IPs will be generated (+mask)
1691+
<1> We added more clusters because more IPs will be generated (+mask)
16921692

16931693

16941694

@@ -1827,7 +1827,7 @@ to the command line options, where <sample> is the sample rate. The number of fl
18271827

18281828
[NOTE]
18291829
============
1830-
This feature changes the TTL of the sampled flows to 255 and expects to receive packets with TTL 254 or 255 (one routing hop). If you have more than one hop in your setup, use `--hops` to change it to a higher value. More than one hop is possible if there are number of routers betwean TRex client side and TRex server side.
1830+
This feature changes the TTL of the sampled flows to 255 and expects to receive packets with TTL 254 or 255 (one routing hop). If you have more than one hop in your setup, use `--hops` to change it to a higher value. More than one hop is possible if there are number of routers between TRex client side and TRex server side.
18311831
============
18321832

18331833
This feature ensures that:

0 commit comments

Comments
 (0)