summaryrefslogtreecommitdiffstats
path: root/docs/testing/user/userguide/07-Config_files.rst
blob: 9061ee577a1f779b61452131b1bc02c5bdfbc506 (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
.. This work is licensed under a Creative Commons Attribution 4.0 International
.. License.
.. http://creativecommons.org/licenses/by/4.0
.. (c) OPNFV, Intel Corporation and others.

SampleVNF - Config files
========================

The configuration files are created based on the DUT test scenarios.
The example reference files are provided as part of the VNFs in the
config folder.

Following parameters will define the config files.

1. Load balancing type: Hardware or Software
2. Traffic type: IPv4 or IPv6
3. Number of Port Pairs: Single or Multi

Following are the example configuration files for sampleVNFs.

vCGNAPT Config files
--------------------




vFW Config files
----------------

The reference configuration files explained here are for Software and Hardware
loadbalancing with IPv4 traffic type and single port pair.
For other configurations liek IPv6 and Multi-port, refer to example config
files provided as part of the source code in config(VNFs/vFW/config) folder
of the VNFs.

1. SWLB, IPv4, Single Port Pair, 4WT:

  ::

    [PIPELINE0]
    type = MASTER
    core = 0

    [PIPELINE1]
    type =  ARPICMP
    core = 0

    pktq_in  = SWQ2
    pktq_out = TXQ0.0 TXQ1.0

    ; IPv4 ARP route table entries (dst_ip, mask, if_port, nh) hex values with no 0x
    ; arp_route_tbl = (ac102814,ff000000,1,ac102814) (ca106414,ff000000,0,ca106414)

    ; IPv6 ARP route table entries (dst_ip, mask, if_port, nh) hex values with no 0x
    ;nd_route_tbl =  (fec0::6a05:caff:fe30:21b0,64,0,fec0::6a05:caff:fe30:21b0)
    ;nd_route_tbl =  (2012::6a05:caff:fe30:2081,64,1,2012::6a05:caff:fe30:2081)

    ; egress (private interface) info
    pktq_in_prv =  RXQ0.0

    ;for pub port <-> prv port mapping (prv, pub)
    prv_to_pub_map = (0,1)
    prv_que_handler = (0)

    [PIPELINE2]
    type = TXRX
    core = 1
    pktq_in  = RXQ0.0 RXQ1.0
    pktq_out = SWQ0 SWQ1 SWQ2
    pipeline_txrx_type = RXRX

    [PIPELINE3]
    type = LOADB
    core = 2
    pktq_in  = SWQ0 SWQ1
    pktq_out = SWQ3 SWQ4 SWQ5 SWQ6 SWQ7 SWQ8 SWQ9 SWQ10
    outport_offset = 136
    n_vnf_threads = 4 ; Number of worker threads
    prv_que_handler = (0)
    n_lb_tuples = 5 ; tuple(src_ip,dst_ip, src_port, dst_port, protocol)
    ;loadb_debug = 0

    [PIPELINE4]
    type = VFW
    core = 3
    pktq_in  = SWQ3 SWQ4
    pktq_out = SWQ11 SWQ12;TXQ0.0 TXQ1.0

    n_rules = 4096 ; Max number of ACL rules
    ;n_flows gets round up to power of 2
    n_flows = 1048576 ; Max number of connections/flows per vFW WT
    traffic_type = 4 ; IPv4 Traffic
    ;traffic_type = 6 ; IPv6 Traffic
    ; tcp_time_wait controls timeout for closed connection, normally 120
    tcp_time_wait = 10	; TCP Connection WAIT timeout
    tcp_be_liberal = 0
    ;udp_unreplied and udp_replied controls udp "connection" timeouts, normally 30/180
    udp_unreplied = 180 ; UDP timeouts for unreplied traffic
    udp_replied = 180 ; UDP timeout for replied traffic

    [PIPELINE5]
    type = VFW
    core = 4
    pktq_in  = SWQ5 SWQ6
    pktq_out = SWQ13 SWQ14;TXQ0.0 TXQ1.0

    n_rules = 4096
    ;n_flows gets round up to power of 2
    n_flows = 1048576
    traffic_type = 4 ; IPv4 Traffic
    ;traffic_type = 6 ; IPv6 Traffic
    ; tcp_time_wait controls timeout for closed connection, normally 120
    tcp_time_wait = 10
    tcp_be_liberal = 0
    ;udp_unreplied and udp_replied controls udp "connection" timeouts, normally 30/180
    udp_unreplied = 180
    udp_replied = 180

    [PIPELINE6]
    type = VFW
    core = 5
    pktq_in  = SWQ7 SWQ8
    pktq_out = SWQ15 SWQ16

    n_rules = 4096
    ;n_flows gets round up to power of 2
    n_flows = 1048576
    traffic_type = 4 ; IPv4 Traffic
    ;traffic_type = 6 ; IPv6 Traffic
    ; tcp_time_wait controls timeout for closed connection, normally 120
    tcp_time_wait = 10
    tcp_be_liberal = 0
    ;udp_unreplied and udp_replied controls udp "connection" timeouts, normally 30/180
    udp_unreplied = 180
    udp_replied = 180

    [PIPELINE7]
    type = VFW
    core = 6
    pktq_in  = SWQ9 SWQ10
    pktq_out = SWQ17 SWQ18

    n_rules = 4096
    ;n_flows gets round up to power of 2
    n_flows = 1048576
    traffic_type = 4 ; IPv4 Traffic
    ;traffic_type = 6 ; IPv6 Traffic
    ; tcp_time_wait controls timeout for closed connection, normally 120
    tcp_time_wait = 10
    tcp_be_liberal = 0
    udp_unreplied = 180
    udp_replied = 180

    [PIPELINE8]
    type = TXRX
    core = 1h
    pktq_in  = SWQ11 SWQ12 SWQ13 SWQ14 SWQ15 SWQ16 SWQ17 SWQ18
    pktq_out = TXQ0.1 TXQ1.1 TXQ0.2 TXQ1.2 TXQ0.3 TXQ1.3 TXQ0.4 TXQ1.4
    pipeline_txrx_type = TXTX


2. HWLB, IPv4, Single Port Pair, 4 WT:

This configuration doesn't require LOADB and TXRX pipelines

  ::

    [PIPELINE0]
    type = MASTER
    core = 0

    [PIPELINE1]
    type =  ARPICMP
    core = 0
    pktq_in  = SWQ0 SWQ1 SWQ2 SWQ3
    pktq_out = TXQ0.0 TXQ1.0

    ; egress (private interface) info
    pktq_in_prv =  RXQ0.0

    ;for pub port <-> prv port mapping (prv, pub)
    prv_to_pub_map = (0,1)
    prv_que_handler = (0)

    [PIPELINE2]
    type = VFW
    core = 1
    pktq_in  = RXQ0.0 RXQ1.0
    pktq_out = TXQ0.1 TXQ1.1 SWQ0

    n_rules = 4096
    ;n_flows gets round up to power of 2
    n_flows = 1048576

    traffic_type = 4 ; IPv4 Traffic
    ;traffic_type = 6 ; IPv6 Traffic
    ; tcp_time_wait controls timeout for closed connection, normally 120
    tcp_time_wait = 10
    tcp_be_liberal = 0
    ;udp_unreplied and udp_replied controls udp "connection" timeouts, normally 30/180
    udp_unreplied = 180
    udp_replied = 180

    [PIPELINE3]
    type = VFW
    core = 2
    pktq_in  = RXQ0.1 RXQ1.1
    pktq_out = TXQ0.2 TXQ1.2 SWQ1

    n_rules = 4096
    ;n_flows gets round up to power of 2
    n_flows = 1048576

    traffic_type = 4 ; IPv4 Traffic
    ;traffic_type = 6 ; IPv6 Traffic
    ; tcp_time_wait controls timeout for closed connection, normally 120
    tcp_time_wait = 10
    tcp_be_liberal = 0
    ;udp_unreplied and udp_replied controls udp "connection" timeouts, normally 30/180
    udp_unreplied = 180
    udp_replied = 180

    [PIPELINE4]
    type = VFW
    core = 3
    pktq_in  = RXQ0.2 RXQ1.2
    pktq_out = TXQ0.3 TXQ1.3 SWQ2

    n_rules = 4096
    ;n_flows gets round up to power of 2
    n_flows = 1048576

    traffic_type = 4 ; IPv4 Traffic
    ;traffic_type = 6 ; IPv6 Traffic
    ; tcp_time_wait controls timeout for closed connection, normally 120
    tcp_time_wait = 10
    tcp_be_liberal = 0
    ;udp_unreplied and udp_replied controls udp "connection" timeouts, normally 30/180
    udp_unreplied = 180
    udp_replied = 180

    [PIPELINE5]
    type = VFW
    core = 4
    pktq_in  = RXQ0.3 RXQ1.3
    pktq_out = TXQ0.4 TXQ1.4 SWQ3

    n_rules = 4096
    ;n_flows gets round up to power of 2
    n_flows = 1048576

    traffic_type = 4 ; IPv4 Traffic
    ;traffic_type = 6 ; IPv6 Traffic
    ; tcp_time_wait controls timeout for closed connection, normally 120
    tcp_time_wait = 10
    tcp_be_liberal = 0
    ;udp_unreplied and udp_replied controls udp "connection" timeouts, normally 30/180
    udp_unreplied = 180
    udp_replied = 180


vACL Config files
----------------

The reference configuration files explained here are for Software and Hardware
loadbalancing with IPv4 traffic type and single port pair.
For other configurations liek IPv6 and Multi-port, refer to example config
files provided as part of the source code in config(VNFs/vACL/config) folder
of the VNFs.

1. SWLB, IPv4, Single Port Pair, 1 WT:

 ::

    [EAL]
    # add pci whitelist eg below
    w = 05:00.0  ; Network Ports binded to dpdk
    w = 05:00.1  ; Network Ports binded to dpdk

    [PIPELINE0]
    type = MASTER
    core = 0

    [PIPELINE1]
    type = ARPICMP
    core = 0
    pktq_in  = SWQ2
    pktq_out = SWQ7
    pktq_in_prv =  RXQ0.0
    prv_to_pub_map = (0,1)
    prv_que_handler = (0)

    [PIPELINE2]
    type = TXRX
    core = 1
    pktq_in  = RXQ0.0 RXQ1.0
    pktq_out = SWQ0 SWQ1 SWQ2
    pipeline_txrx_type = RXRX
    dest_if_offset = 176

    [PIPELINE3]
    type = LOADB
    core = 2
    pktq_in  = SWQ0 SWQ1
    pktq_out = SWQ3 SWQ4
    outport_offset = 136
    phyport_offset = 204
    n_vnf_threads = 1
    prv_que_handler = (0)

    [PIPELINE4]
    type = ACL
    core = 3
    pktq_in  = SWQ3 SWQ4
    pktq_out = SWQ5 SWQ6
    n_flows = 1000000
    pkt_type = ipv4
    traffic_type = 4

    [PIPELINE5]
    type = TXRX
    core = 1h
    pktq_in  = SWQ5 SWQ6 SWQ7
    pktq_out = TXQ0.0 TXQ1.0
    pipeline_txrx_type = TXTX


2. SWLB, IPv4, Single Port Pair, 1 WT:

 ::

    [EAL]
    # add pci whitelist eg below
    w = 05:00.0
    w = 05:00.1

    [PIPELINE0]
    type = MASTER
    core = 0

    [PIPELINE1]
    type = ARPICMP
    core = 0
    pktq_in  = SWQ0
    pktq_out = TXQ0.0 TXQ1.0
    pktq_in_prv =  RXQ0.0
    prv_to_pub_map = (0,1)
    prv_que_handler = (0)

    [PIPELINE2]
    type = ACL
    core = 1
    pktq_in  = RXQ0.0 RXQ1.0
    pktq_out = TXQ0.1 TXQ1.1 SWQ0
    n_flows = 1000000
    pkt_type = ipv4
    traffic_type = 4