aboutsummaryrefslogtreecommitdiffstats
path: root/docs/userguide/integration.rst
blob: e45f2dc101b0d90eb5cde59fb309d6da88ac4b7e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. (c) OPNFV, Intel Corporation, AT&T and others.

Integration tests
=================

VSPERF includes a set of integration tests defined in conf/integration.
These tests can be run by specifying --integration as a parameter to vsperf.
Current tests in conf/integration include switch functionality and Overlay
tests.

Tests in the conf/integration can be used to test scaling of different switch
configurations by adding steps into the test case.

For the overlay tests VSPERF supports VXLAN, GRE and GENEVE tunneling protocols.
Testing of these protocols is limited to unidirectional traffic and
P2P (Physical to Physical scenarios).

NOTE: The configuration for overlay tests provided in this guide is for
unidirectional traffic only.

Executing Integration Tests
---------------------------

To execute integration tests VSPERF is run with the integration parameter. To
view the current test list simply execute the following command:

.. code-block:: console

    ./vsperf --integration --list

The standard tests included are defined inside the
``conf/integration/01_testcases.conf`` file.

Test Steps
----------

Execution of integration tests are done on a step by step work flow starting
with step 0 as defined inside the test case. Each step of the test increments
the step number by one which is indicated in the log.

.. code-block:: console

    (testcases.integration) - Step 1 - 'vswitch add_switch ['int_br1']' ... OK

Each step in the test case is validated. If a step does not pass validation the
test will fail and terminate. The test will continue until a failure is detected
or all steps pass. A csv report file is generated after a test completes with an
OK or FAIL result.

Test Macros
-----------

Test profiles can include macros as part of the test step. Each step in the
profile may return a value such as a port name. Recall macros use #STEP to
indicate the recalled value inside the return structure. If the method the
test step calls returns a value it can be later recalled, for example:

.. code-block:: python

    {
        "Name": "vswitch_add_del_vport",
        "Deployment": "clean",
        "Description": "vSwitch - add and delete virtual port",
        "TestSteps": [
                ['vswitch', 'add_switch', 'int_br0'],               # STEP 0
                ['vswitch', 'add_vport', 'int_br0'],                # STEP 1
                ['vswitch', 'del_port', 'int_br0', '#STEP[1][0]'],  # STEP 2
                ['vswitch', 'del_switch', 'int_br0'],               # STEP 3
             ]
    }

This test profile uses the vswitch add_vport method which returns a string
value of the port added. This is later called by the del_port method using the
name from step 1.

Also commonly used steps can be created as a separate profile.

.. code-block:: python

    STEP_VSWITCH_PVP_INIT = [
        ['vswitch', 'add_switch', 'int_br0'],           # STEP 0
        ['vswitch', 'add_phy_port', 'int_br0'],         # STEP 1
        ['vswitch', 'add_phy_port', 'int_br0'],         # STEP 2
        ['vswitch', 'add_vport', 'int_br0'],            # STEP 3
        ['vswitch', 'add_vport', 'int_br0'],            # STEP 4
    ]

This profile can then be used inside other testcases

.. code-block:: python

    {
        "Name": "vswitch_pvp",
        "Deployment": "clean",
        "Description": "vSwitch - configure switch and one vnf",
        "TestSteps": STEP_VSWITCH_PVP_INIT +
                     [
                        ['vnf', 'start'],
                        ['vnf', 'stop'],
                     ] +
                     STEP_VSWITCH_PVP_FINIT
    }

HelloWorld and other basic Testcases
------------------------------------

The following examples are for demonstration purposes.
You can run them by copying and pasting into the
conf/integration/01_testcases.conf file.
A command-line instruction is shown at the end of each
example.

HelloWorld
^^^^^^^^^^

The first example is a HelloWorld testcase.
It simply creates a bridge with 2 physical ports, then sets up a flow to drop
incoming packets from the port that was instantiated at the STEP #1.
There's no interaction with the traffic generator.
Then the flow, the 2 ports and the bridge are deleted.
'add_phy_port' method creates a 'dpdk' type interface that will manage the
physical port. The string value returned is the port name that will be referred
by 'del_port' later on.

.. code-block:: python

    {
        "Name": "HelloWorld",
        "Description": "My first testcase",
        "Deployment": "clean",
        "TestSteps": [
            ['vswitch', 'add_switch', 'int_br0'],   # STEP 0
            ['vswitch', 'add_phy_port', 'int_br0'], # STEP 1
            ['vswitch', 'add_phy_port', 'int_br0'], # STEP 2
            ['vswitch', 'add_flow', 'int_br0', {'in_port': '#STEP[1][1]', \
                'actions': ['drop'], 'idle_timeout': '0'}],
            ['vswitch', 'del_flow', 'int_br0'],
            ['vswitch', 'del_port', 'int_br0', '#STEP[1][0]'],
            ['vswitch', 'del_port', 'int_br0', '#STEP[2][0]'],
            ['vswitch', 'del_switch', 'int_br0'],
        ]

    }

To run HelloWorld test:

  .. code-block:: console

    ./vsperf --conf-file user_settings.py --integration HelloWorld

Specify a Flow by the IP address
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The next example shows how to explicitly set up a flow by specifying a
destination IP address.
All packets received from the port created at STEP #1 that have a destination
IP address = 90.90.90.90 will be forwarded to the port created at the STEP #2.

.. code-block:: python

    {
        "Name": "p2p_rule_l3da",
        "Description": "Phy2Phy with rule on L3 Dest Addr",
        "Deployment": "clean",
        "biDirectional": "False",
        "TestSteps": [
            ['vswitch', 'add_switch', 'int_br0'],   # STEP 0
            ['vswitch', 'add_phy_port', 'int_br0'], # STEP 1
            ['vswitch', 'add_phy_port', 'int_br0'], # STEP 2
            ['vswitch', 'add_flow', 'int_br0', {'in_port': '#STEP[1][1]', \
                'dl_type': '0x0800', 'nw_dst': '90.90.90.90', \
                'actions': ['output:#STEP[2][1]'], 'idle_timeout': '0'}],
            ['trafficgen', 'send_traffic', {'traffic_type' : 'continuous'}],
            ['vswitch', 'dump_flows', 'int_br0'],   # STEP 5
            ['vswitch', 'del_flow', 'int_br0'],     # STEP 7 == del-flows
            ['vswitch', 'del_port', 'int_br0', '#STEP[1][0]'],
            ['vswitch', 'del_port', 'int_br0', '#STEP[2][0]'],
            ['vswitch', 'del_switch', 'int_br0'],
        ]
    },

To run the test:

  .. code-block:: console

    ./vsperf --conf-file user_settings.py --integration p2p_rule_l3da

Multistream feature
^^^^^^^^^^^^^^^^^^^

The next testcase uses the multistream feature.
The traffic generator will send packets with different UDP ports.
That is accomplished by using "Stream Type" and "MultiStream" keywords.
4 different flows are set to forward all incoming packets.

.. code-block:: python

    {
        "Name": "multistream_l4",
        "Description": "Multistream on UDP ports",
        "Deployment": "clean",
        "Stream Type": "L4",
        "MultiStream": 4,
        "TestSteps": [
            ['vswitch', 'add_switch', 'int_br0'],   # STEP 0
            ['vswitch', 'add_phy_port', 'int_br0'], # STEP 1
            ['vswitch', 'add_phy_port', 'int_br0'], # STEP 2
            # Setup Flows
            ['vswitch', 'add_flow', 'int_br0', {'in_port': '#STEP[1][1]', \
                'dl_type': '0x0800', 'nw_proto': '17', 'udp_dst': '0', \
                'actions': ['output:#STEP[2][1]'], 'idle_timeout': '0'}],
            ['vswitch', 'add_flow', 'int_br0', {'in_port': '#STEP[1][1]', \
                'dl_type': '0x0800', 'nw_proto': '17', 'udp_dst': '1', \
                'actions': ['output:#STEP[2][1]'], 'idle_timeout': '0'}],
            ['vswitch', 'add_flow', 'int_br0', {'in_port': '#STEP[1][1]', \
                'dl_type': '0x0800', 'nw_proto': '17', 'udp_dst': '2', \
                'actions': ['output:#STEP[2][1]'], 'idle_timeout': '0'}],
            ['vswitch', 'add_flow', 'int_br0', {'in_port': '#STEP[1][1]', \
                'dl_type': '0x0800', 'nw_proto': '17', 'udp_dst': '3', \
                'actions': ['output:#STEP[2][1]'], 'idle_timeout': '0'}],
            # Send mono-dir traffic
            ['trafficgen', 'send_traffic', {'traffic_type' : 'continuous', \
                'bidir' : 'False'}],
            # Clean up
            ['vswitch', 'del_flow', 'int_br0'],
            ['vswitch', 'del_port', 'int_br0', '#STEP[1][0]'],
            ['vswitch', 'del_port', 'int_br0', '#STEP[2][0]'],
            ['vswitch', 'del_switch', 'int_br0'],
         ]
    },

To run the test:

  .. code-block:: console

    ./vsperf --conf-file user_settings.py --integration multistream_l4

PVP with a VM Replacement
^^^^^^^^^^^^^^^^^^^^^^^^^

This example launches a 1st VM in a PVP topology, then the VM is replaced
by another VM.
When VNF setup parameter in ./conf/04_vnf.conf is "QemuDpdkVhostUser"
'add_vport' method creates a 'dpdkvhostuser' type port to connect a VM.

.. code-block:: python

    {
        "Name": "ex_replace_vm",
        "Description": "PVP with VM replacement",
        "Deployment": "clean",
        "TestSteps": [
            ['vswitch', 'add_switch', 'int_br0'],       # STEP 0
            ['vswitch', 'add_phy_port', 'int_br0'],     # STEP 1
            ['vswitch', 'add_phy_port', 'int_br0'],     # STEP 2
            ['vswitch', 'add_vport', 'int_br0'],        # STEP 3    vm1
            ['vswitch', 'add_vport', 'int_br0'],        # STEP 4

            # Setup Flows
            ['vswitch', 'add_flow', 'int_br0', {'in_port': '#STEP[1][1]', \
                'actions': ['output:#STEP[3][1]'], 'idle_timeout': '0'}],
            ['vswitch', 'add_flow', 'int_br0', {'in_port': '#STEP[4][1]', \
                'actions': ['output:#STEP[2][1]'], 'idle_timeout': '0'}],
            ['vswitch', 'add_flow', 'int_br0', {'in_port': '#STEP[2][1]', \
                'actions': ['output:#STEP[4][1]'], 'idle_timeout': '0'}],
            ['vswitch', 'add_flow', 'int_br0', {'in_port': '#STEP[3][1]', \
                'actions': ['output:#STEP[1][1]'], 'idle_timeout': '0'}],

            # Start VM 1
            ['vnf1', 'start'],
            # Now we want to replace VM 1 with another VM
            ['vnf1', 'stop'],

            ['vswitch', 'add_vport', 'int_br0'],        # STEP 11    vm2
            ['vswitch', 'add_vport', 'int_br0'],        # STEP 12
            ['vswitch', 'del_flow', 'int_br0'],
            ['vswitch', 'add_flow', 'int_br0', {'in_port': '#STEP[1][1]', \
                'actions': ['output:#STEP[11][1]'], 'idle_timeout': '0'}],
            ['vswitch', 'add_flow', 'int_br0', {'in_port': '#STEP[12][1]', \
                'actions': ['output:#STEP[2][1]'], 'idle_timeout': '0'}],

            # Start VM 2
            ['vnf2', 'start'],
            ['vnf2', 'stop'],
            ['vswitch', 'dump_flows', 'int_br0'],

            # Clean up
            ['vswitch', 'del_flow', 'int_br0'],
            ['vswitch', 'del_port', 'int_br0', '#STEP[1][0]'],
            ['vswitch', 'del_port', 'int_br0', '#STEP[2][0]'],
            ['vswitch', 'del_port', 'int_br0', '#STEP[3][0]'],    # vm1
            ['vswitch', 'del_port', 'int_br0', '#STEP[4][0]'],
            ['vswitch', 'del_port', 'int_br0', '#STEP[11][0]'],   # vm2
            ['vswitch', 'del_port', 'int_br0', '#STEP[12][0]'],
            ['vswitch', 'del_switch', 'int_br0'],
        ]
    },

To run the test:

  .. code-block:: console

     ./vsperf --conf-file user_settings.py --integration ex_replace_vm

VM with a Linux bridge
^^^^^^^^^^^^^^^^^^^^^^

In this example a command-line parameter allows to set up a Linux bridge into
the guest VM.
That's one of the available ways to specify the guest application.
Packets matching the flow will be forwarded to the VM.

.. code-block:: python

    {
        "Name": "ex_pvp_rule_l3da",
        "Description": "PVP with flow on L3 Dest Addr",
        "Deployment": "clean",
        "TestSteps": [
            ['vswitch', 'add_switch', 'int_br0'],       # STEP 0
            ['vswitch', 'add_phy_port', 'int_br0'],     # STEP 1
            ['vswitch', 'add_phy_port', 'int_br0'],     # STEP 2
            ['vswitch', 'add_vport', 'int_br0'],        # STEP 3    vm1
            ['vswitch', 'add_vport', 'int_br0'],        # STEP 4
            # Setup Flows
            ['vswitch', 'add_flow', 'int_br0', {'in_port': '#STEP[1][1]', \
                'dl_type': '0x0800', 'nw_dst': '90.90.90.90', \
                'actions': ['output:#STEP[3][1]'], 'idle_timeout': '0'}],
            # Each pkt from the VM is forwarded to the 2nd dpdk port
            ['vswitch', 'add_flow', 'int_br0', {'in_port': '#STEP[4][1]', \
                'actions': ['output:#STEP[2][1]'], 'idle_timeout': '0'}],
            # Start VMs
            ['vnf1', 'start'],
            ['trafficgen', 'send_traffic', {'traffic_type' : 'continuous', \
                'bidir' : 'False'}],
            ['vnf1', 'stop'],
            # Clean up
            ['vswitch', 'dump_flows', 'int_br0'],       # STEP 10
            ['vswitch', 'del_flow', 'int_br0'],         # STEP 11
            ['vswitch', 'del_port', 'int_br0', '#STEP[1][0]'],
            ['vswitch', 'del_port', 'int_br0', '#STEP[2][0]'],
            ['vswitch', 'del_port', 'int_br0', '#STEP[3][0]'],  # vm1 ports
            ['vswitch', 'del_port', 'int_br0', '#STEP[4][0]'],
            ['vswitch', 'del_switch', 'int_br0'],
        ]
    },

To run the test:

  .. code-block:: console

    ./vsperf --conf-file user_settings.py --test-params
            "guest_loopback=linux_bridge" --integration ex_pvp_rule_l3da

Forward packets based on UDP port
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

This examples launches 2 VMs connected in parallel.
Incoming packets will be forwarded to one specific VM depending on the
destination UDP port.

.. code-block:: python

    {
        "Name": "ex_2pvp_rule_l4dp",
        "Description": "2 PVP with flows on L4 Dest Port",
        "Deployment": "clean",
        "Stream Type": "L4",    # loop UDP ports
        "MultiStream": 2,
        "TestSteps": [
            ['vswitch', 'add_switch', 'int_br0'],       # STEP 0
            ['vswitch', 'add_phy_port', 'int_br0'],     # STEP 1
            ['vswitch', 'add_phy_port', 'int_br0'],     # STEP 2
            ['vswitch', 'add_vport', 'int_br0'],        # STEP 3    vm1
            ['vswitch', 'add_vport', 'int_br0'],        # STEP 4
            ['vswitch', 'add_vport', 'int_br0'],        # STEP 5    vm2
            ['vswitch', 'add_vport', 'int_br0'],        # STEP 6
            # Setup Flows to reply ICMPv6 and similar packets, so to
            # avoid flooding internal port with their re-transmissions
            ['vswitch', 'add_flow', 'int_br0', \
                {'priority': '1', 'dl_src': '00:00:00:00:00:01', \
                'actions': ['output:#STEP[3][1]'], 'idle_timeout': '0'}],
            ['vswitch', 'add_flow', 'int_br0', \
                {'priority': '1', 'dl_src': '00:00:00:00:00:02', \
                'actions': ['output:#STEP[4][1]'], 'idle_timeout': '0'}],
            ['vswitch', 'add_flow', 'int_br0', \
                {'priority': '1', 'dl_src': '00:00:00:00:00:03', \
                'actions': ['output:#STEP[5][1]'], 'idle_timeout': '0'}],
            ['vswitch', 'add_flow', 'int_br0', \
                {'priority': '1', 'dl_src': '00:00:00:00:00:04', \
                'actions': ['output:#STEP[6][1]'], 'idle_timeout': '0'}],
            # Forward UDP packets depending on dest port
            ['vswitch', 'add_flow', 'int_br0', {'in_port': '#STEP[1][1]', \
                'dl_type': '0x0800', 'nw_proto': '17', 'udp_dst': '0', \
                'actions': ['output:#STEP[3][1]'], 'idle_timeout': '0'}],
            ['vswitch', 'add_flow', 'int_br0', {'in_port': '#STEP[1][1]', \
                'dl_type': '0x0800', 'nw_proto': '17', 'udp_dst': '1', \
                'actions': ['output:#STEP[5][1]'], 'idle_timeout': '0'}],
            # Send VM output to phy port #2
            ['vswitch', 'add_flow', 'int_br0', {'in_port': '#STEP[4][1]', \
                'actions': ['output:#STEP[2][1]'], 'idle_timeout': '0'}],
            ['vswitch', 'add_flow', 'int_br0', {'in_port': '#STEP[6][1]', \
                'actions': ['output:#STEP[2][1]'], 'idle_timeout': '0'}],
            # Start VMs
            ['vnf1', 'start'],                          # STEP 16
            ['vnf2', 'start'],                          # STEP 17
            ['trafficgen', 'send_traffic', {'traffic_type' : 'continuous', \
                'bidir' : 'False'}],
            ['vnf1', 'stop'],
            ['vnf2', 'stop'],
            ['vswitch', 'dump_flows', 'int_br0'],
            # Clean up
            ['vswitch', 'del_flow', 'int_br0'],
            ['vswitch', 'del_port', 'int_br0', '#STEP[1][0]'],
            ['vswitch', 'del_port', 'int_br0', '#STEP[2][0]'],
            ['vswitch', 'del_port', 'int_br0', '#STEP[3][0]'],  # vm1 ports
            ['vswitch', 'del_port', 'int_br0', '#STEP[4][0]'],
            ['vswitch', 'del_port', 'int_br0', '#STEP[5][0]'],  # vm2 ports
            ['vswitch', 'del_port', 'int_br0', '#STEP[6][0]'],
            ['vswitch', 'del_switch', 'int_br0'],
        ]
    },

To run the test:

  .. code-block:: console

    ./vsperf --conf-file user_settings.py --integration ex_2pvp_rule_l4dp

Executing Tunnel encapsulation tests
------------------------------------

The VXLAN OVS DPDK encapsulation tests requires IPs, MAC addresses,
bridge names and WHITELIST_NICS for DPDK.

Default values are already provided. To customize for your environment, override
the following variables in you user_settings.py file:

  .. code-block:: python

    # Variables defined in conf/integration/02_vswitch.conf
    # Tunnel endpoint for Overlay P2P deployment scenario
    # used for br0
    VTEP_IP1 = '192.168.0.1/24'

    # Used as remote_ip in adding OVS tunnel port and
    # to set ARP entry in OVS (e.g. tnl/arp/set br-ext 192.168.240.10 02:00:00:00:00:02
    VTEP_IP2 = '192.168.240.10'

    # Network to use when adding a route for inner frame data
    VTEP_IP2_SUBNET = '192.168.240.0/24'

    # Bridge names
    TUNNEL_INTEGRATION_BRIDGE = 'br0'
    TUNNEL_EXTERNAL_BRIDGE = 'br-ext'

    # IP of br-ext
    TUNNEL_EXTERNAL_BRIDGE_IP = '192.168.240.1/24'

    # vxlan|gre|geneve
    TUNNEL_TYPE = 'vxlan'

    # Variables defined conf/integration/03_traffic.conf
    # For OP2P deployment scenario
    TRAFFICGEN_PORT1_MAC = '02:00:00:00:00:01'
    TRAFFICGEN_PORT2_MAC = '02:00:00:00:00:02'
    TRAFFICGEN_PORT1_IP = '1.1.1.1'
    TRAFFICGEN_PORT2_IP = '192.168.240.10'

To run VXLAN encapsulation tests:

  .. code-block:: console

    ./vsperf --conf-file user_settings.py --integration
             --test-params 'tunnel_type=vxlan' overlay_p2p_tput

To run GRE encapsulation tests:

  .. code-block:: console

    ./vsperf --conf-file user_settings.py --integration
             --test-params 'tunnel_type=gre' overlay_p2p_tput

To run GENEVE encapsulation tests:

  .. code-block:: console

    ./vsperf --conf-file user_settings.py --integration
             --test-params 'tunnel_type=geneve' overlay_p2p_tput

To run OVS NATIVE tunnel tests (VXLAN/GRE/GENEVE):

1. Install the OVS kernel modules

  .. code:: console

    cd src/ovs/ovs
    sudo -E make modules_install

2. Set the following variables:

  .. code-block:: python

    VSWITCH = 'OvsVanilla'
    # Specify vport_* kernel module to test.
    VSWITCH_VANILLA_KERNEL_MODULES = ['vport_vxlan',
                                      'vport_gre',
                                      'vport_geneve',
                                      os.path.join(OVS_DIR_VANILLA,
                                      'datapath/linux/openvswitch.ko')]

3. Run tests:

  .. code-block:: console

    ./vsperf --conf-file user_settings.py --integration
             --test-params 'tunnel_type=vxlan' overlay_p2p_tput


Executing VXLAN decapsulation tests
------------------------------------

To run VXLAN decapsulation tests:

1. Set the variables used in "Executing Tunnel encapsulation tests"

2. Set dstmac of DUT_NIC2_MAC to the MAC adddress of the 2nd NIC of your DUT

  .. code-block:: python

    DUT_NIC2_MAC = '<DUT NIC2 MAC>'

3. Run test:

  .. code-block:: console

    ./vsperf --conf-file user_settings.py --integration overlay_p2p_decap_cont

If you want to use different values for your VXLAN frame, you may set:

  .. code-block:: python

    VXLAN_FRAME_L3 = {'proto': 'udp',
                      'packetsize': 64,
                      'srcip': TRAFFICGEN_PORT1_IP,
                      'dstip': '192.168.240.1',
                     }
    VXLAN_FRAME_L4 = {'srcport': 4789,
                      'dstport': 4789,
                      'vni': VXLAN_VNI,
                      'inner_srcmac': '01:02:03:04:05:06',
                      'inner_dstmac': '06:05:04:03:02:01',
                      'inner_srcip': '192.168.0.10',
                      'inner_dstip': '192.168.240.9',
                      'inner_proto': 'udp',
                      'inner_srcport': 3000,
                      'inner_dstport': 3001,
                     }


Executing GRE decapsulation tests
---------------------------------

To run GRE decapsulation tests:

1. Set the variables used in "Executing Tunnel encapsulation tests"

2. Set dstmac of DUT_NIC2_MAC to the MAC adddress of the 2nd NIC of your DUT

  .. code-block:: python

    DUT_NIC2_MAC = '<DUT NIC2 MAC>'

3. Run test:

  .. code-block:: console

    ./vsperf --conf-file user_settings.py --test-params 'tunnel_type=gre'
             --integration overlay_p2p_decap_cont


If you want to use different values for your GRE frame, you may set:

  .. code-block:: python

    GRE_FRAME_L3 = {'proto': 'gre',
                    'packetsize': 64,
                    'srcip': TRAFFICGEN_PORT1_IP,
                    'dstip': '192.168.240.1',
                   }

    GRE_FRAME_L4 = {'srcport': 0,
                    'dstport': 0
                    'inner_srcmac': '01:02:03:04:05:06',
                    'inner_dstmac': '06:05:04:03:02:01',
                    'inner_srcip': '192.168.0.10',
                    'inner_dstip': '192.168.240.9',
                    'inner_proto': 'udp',
                    'inner_srcport': 3000,
                    'inner_dstport': 3001,
                   }


Executing GENEVE decapsulation tests
------------------------------------

IxNet 7.3X does not have native support of GENEVE protocol. The
template, GeneveIxNetTemplate.xml_ClearText.xml, should be imported
into IxNET for this testcase to work.

To import the template do:

1. Run the IxNetwork TCL Server
2. Click on the Traffic menu
3. Click on the Traffic actions and click Edit Packet Templates
4. On the Template editor window, click Import. Select the template
   tools/pkt_gen/ixnet/GeneveIxNetTemplate.xml_ClearText.xml
   and click import.
5. Restart the TCL Server.

To run GENEVE decapsulation tests:

1. Set the variables used in "Executing Tunnel encapsulation tests"

2. Set dstmac of DUT_NIC2_MAC to the MAC adddress of the 2nd NIC of your DUT

  .. code-block:: python

    DUT_NIC2_MAC = '<DUT NIC2 MAC>'

3. Run test:

  .. code-block:: console

    ./vsperf --conf-file user_settings.py --test-params 'tunnel_type=geneve'
             --integration overlay_p2p_decap_cont


If you want to use different values for your GENEVE frame, you may set:

  .. code-block:: python

    GENEVE_FRAME_L3 = {'proto': 'udp',
                       'packetsize': 64,
                       'srcip': TRAFFICGEN_PORT1_IP,
                       'dstip': '192.168.240.1',
                      }

    GENEVE_FRAME_L4 = {'srcport': 6081,
                       'dstport': 6081,
                       'geneve_vni': 0,
                       'inner_srcmac': '01:02:03:04:05:06',
                       'inner_dstmac': '06:05:04:03:02:01',
                       'inner_srcip': '192.168.0.10',
                       'inner_dstip': '192.168.240.9',
                       'inner_proto': 'udp',
                       'inner_srcport': 3000,
                       'inner_dstport': 3001,
                      }


Executing Native/Vanilla OVS VXLAN decapsulation tests
------------------------------------------------------

To run VXLAN decapsulation tests:

1. Set the following variables in your user_settings.py file:

  .. code-block:: python

    VSWITCH_VANILLA_KERNEL_MODULES = ['vport_vxlan',
                                      os.path.join(OVS_DIR_VANILLA,
                                      'datapath/linux/openvswitch.ko')]

    DUT_NIC1_MAC = '<DUT NIC1 MAC ADDRESS>'

    TRAFFICGEN_PORT1_IP = '172.16.1.2'
    TRAFFICGEN_PORT2_IP = '192.168.1.11'

    VTEP_IP1 = '172.16.1.2/24'
    VTEP_IP2 = '192.168.1.1'
    VTEP_IP2_SUBNET = '192.168.1.0/24'
    TUNNEL_EXTERNAL_BRIDGE_IP = '172.16.1.1/24'
    TUNNEL_INT_BRIDGE_IP = '192.168.1.1'

    VXLAN_FRAME_L2 = {'srcmac':
                      '01:02:03:04:05:06',
                      'dstmac': DUT_NIC1_MAC
                     }

    VXLAN_FRAME_L3 = {'proto': 'udp',
                      'packetsize': 64,
                      'srcip': TRAFFICGEN_PORT1_IP,
                      'dstip': '172.16.1.1',
                     }

    VXLAN_FRAME_L4 = {
                      'srcport': 4789,
                      'dstport': 4789,
                      'protocolpad': 'true',
                      'vni': 99,
                      'inner_srcmac': '01:02:03:04:05:06',
                      'inner_dstmac': '06:05:04:03:02:01',
                      'inner_srcip': '192.168.1.2',
                      'inner_dstip': TRAFFICGEN_PORT2_IP,
                      'inner_proto': 'udp',
                      'inner_srcport': 3000,
                      'inner_dstport': 3001,
                     }

2. Run test:

  .. code-block:: console

    ./vsperf --conf-file user_settings.py --integration
             --test-params 'tunnel_type=vxlan' overlay_p2p_decap_cont

Executing Native/Vanilla OVS GRE decapsulation tests
----------------------------------------------------

To run GRE decapsulation tests:

1. Set the following variables in your user_settings.py file:

  .. code-block:: python

    VSWITCH_VANILLA_KERNEL_MODULES = ['vport_gre',
                                      os.path.join(OVS_DIR_VANILLA,
                                      'datapath/linux/openvswitch.ko')]

    DUT_NIC1_MAC = '<DUT NIC1 MAC ADDRESS>'

    TRAFFICGEN_PORT1_IP = '172.16.1.2'
    TRAFFICGEN_PORT2_IP = '192.168.1.11'

    VTEP_IP1 = '172.16.1.2/24'
    VTEP_IP2 = '192.168.1.1'
    VTEP_IP2_SUBNET = '192.168.1.0/24'
    TUNNEL_EXTERNAL_BRIDGE_IP = '172.16.1.1/24'
    TUNNEL_INT_BRIDGE_IP = '192.168.1.1'

    GRE_FRAME_L2 = {'srcmac':
                    '01:02:03:04:05:06',
                    'dstmac': DUT_NIC1_MAC
                   }

    GRE_FRAME_L3 = {'proto': 'udp',
                    'packetsize': 64,
                    'srcip': TRAFFICGEN_PORT1_IP,
                    'dstip': '172.16.1.1',
                   }

    GRE_FRAME_L4 = {
                    'srcport': 4789,
                    'dstport': 4789,
                    'protocolpad': 'true',
                    'inner_srcmac': '01:02:03:04:05:06',
                    'inner_dstmac': '06:05:04:03:02:01',
                    'inner_srcip': '192.168.1.2',
                    'inner_dstip': TRAFFICGEN_PORT2_IP,
                    'inner_proto': 'udp',
                    'inner_srcport': 3000,
                    'inner_dstport': 3001,
                   }

2. Run test:

  .. code-block:: console

    ./vsperf --conf-file user_settings.py --integration
             --test-params 'tunnel_type=gre' overlay_p2p_decap_cont

Executing Native/Vanilla OVS GENEVE decapsulation tests
-------------------------------------------------------

To run GENEVE decapsulation tests:

1. Set the following variables in your user_settings.py file:

  .. code-block:: python

    VSWITCH_VANILLA_KERNEL_MODULES = ['vport_geneve',
                                      os.path.join(OVS_DIR_VANILLA,
                                      'datapath/linux/openvswitch.ko')]

    DUT_NIC1_MAC = '<DUT NIC1 MAC ADDRESS>'

    TRAFFICGEN_PORT1_IP = '172.16.1.2'
    TRAFFICGEN_PORT2_IP = '192.168.1.11'

    VTEP_IP1 = '172.16.1.2/24'
    VTEP_IP2 = '192.168.1.1'
    VTEP_IP2_SUBNET = '192.168.1.0/24'
    TUNNEL_EXTERNAL_BRIDGE_IP = '172.16.1.1/24'
    TUNNEL_INT_BRIDGE_IP = '192.168.1.1'

    GENEVE_FRAME_L2 = {'srcmac':
                       '01:02:03:04:05:06',
                       'dstmac': DUT_NIC1_MAC
                      }

    GENEVE_FRAME_L3 = {'proto': 'udp',
                       'packetsize': 64,
                       'srcip': TRAFFICGEN_PORT1_IP,
                       'dstip': '172.16.1.1',
                      }

    GENEVE_FRAME_L4 = {'srcport': 6081,
                       'dstport': 6081,
                       'protocolpad': 'true',
                       'geneve_vni': 0,
                       'inner_srcmac': '01:02:03:04:05:06',
                       'inner_dstmac': '06:05:04:03:02:01',
                       'inner_srcip': '192.168.1.2',
                       'inner_dstip': TRAFFICGEN_PORT2_IP,
                       'inner_proto': 'udp',
                       'inner_srcport': 3000,
                       'inner_dstport': 3001,
                      }

2. Run test:

  .. code-block:: console

    ./vsperf --conf-file user_settings.py --integration
             --test-params 'tunnel_type=geneve' overlay_p2p_decap_cont