summaryrefslogtreecommitdiffstats
path: root/docs/vCGNAPT/INSTALL.rst
blob: 85873109e1a63d4635f82e2e358bf6679cee0c9a (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
.. This work is licensed under a Creative Commons Attribution 4.0 International
.. License.
.. http://creativecommons.org/licenses/by/4.0
.. (c) OPNFV, National Center of Scientific Research "Demokritos" and others.

============================
vCGNAPT - Installation Guide
============================


vCGNAPT Compilation
===================

After downloading (or doing a git clone) in a directory (samplevnf)

Dependencies
-------------

- DPDK supported versions ($DPDK_RTE_VER = 16.04, 16.11, 17.02 or 17.05) Downloaded and installed via vnf_build.sh or manually from [here] (http://fast.dpdk.org/rel/)
- libpcap-dev
- libzmq
- libcurl

Environment variables
---------------------

Apply all the additional patches in 'patches/dpdk_custom_patch/' and build dpdk
required only for DPDK version 16.04.

::

  export RTE_SDK=<dpdk directory>
  export RTE_TARGET=x86_64-native-linuxapp-gcc

This is done by vnf_build.sh script.

Auto Build:
===========
$ ./tools/vnf_build.sh in samplevnf root folder

Follow the steps in the screen from option [1] --> [9] and select option [8]
to build the vnfs.
It will automatically download selected DPDK version and any required patches
and will setup everything and build vCGNAPT VNFs.

Following are the options for setup:

::

        ----------------------------------------------------------
         Step 1: Environment setup.
        ----------------------------------------------------------
        [1] Check OS and network connection
        [2] Select DPDK RTE version

        ----------------------------------------------------------
         Step 2: Download and Install
        ----------------------------------------------------------
        [3] Agree to download
        [4] Download packages
        [5] Download DPDK zip
        [6] Build and Install DPDK
        [7] Setup hugepages

        ----------------------------------------------------------
         Step 3: Build VNFs
        ----------------------------------------------------------
        [8] Build all VNFs (vACL, vCGNAPT, vFW, UDP_Replay)

        [9] Exit Script

An vCGNAPT executable will be created at the following location
samplevnf/VNFs/vCGNAPT/build/vCGNAPT


Manual Build:
=============
1. Download DPDK supported version from dpdk.org

   - http://dpdk.org/browse/dpdk/snapshot/dpdk-$DPDK_RTE_VER.zip
2. unzip  dpdk-$DPDK_RTE_VER.zip and apply dpdk patches only in case of 16.04
   (Not required for other DPDK versions)

   - cd dpdk

         - patch -p1 < VNF_CORE/patches/dpdk_custom_patch/i40e-fix-link-management.patch
         - patch -p1 < VNF_CORE/patches/dpdk_custom_patch/i40e-fix-Rx-hang-when-disable-LLDP.patch
         - patch -p1 < VNF_CORE/patches/dpdk_custom_patch/i40e-fix-link-status-change-interrupt.patch
         - patch -p1 < VNF_CORE/patches/dpdk_custom_patch/i40e-fix-VF-bonded-device-link-down.patch
         - patch -p1 < $VNF_CORE/patches/dpdk_custom_patch/disable-acl-debug-logs.patch
         - patch -p1 < $VNF_CORE/patches/dpdk_custom_patch/set-log-level-to-info.patch

   - build dpdk

        - make config T=x86_64-native-linuxapp-gcc O=x86_64-native-linuxapp-gcc
        - cd x86_64-native-linuxapp-gcc
        - make

   - Setup huge pages

        - For 1G/2M hugepage sizes, for example 1G pages, the size must be specified
          explicitly and can also be optionally set as the default hugepage size for
          the system. For example, to reserve 8G of hugepage memory in the form of
          eight 1G pages, the following options should be passed to the kernel:
          * default_hugepagesz=1G hugepagesz=1G hugepages=8  hugepagesz=2M hugepages=2048
        - Add this to Go to /etc/default/grub configuration file.
        - Append "default_hugepagesz=1G hugepagesz=1G hugepages=8 hugepagesz=2M hugepages=2048"
            to the GRUB_CMDLINE_LINUX entry.

3. Setup Environment Variable

   - export RTE_SDK=<samplevnf>/dpdk
   - export RTE_TARGET=x86_64-native-linuxapp-gcc
   - export VNF_CORE=<samplevnf>
     or using ./tools/setenv.sh

4. Build vCGNAPT VNFs

   - cd <samplevnf>/VNFs/vCGNAPT
   - make clean
   - make

5. An vCGNAPT executable will be created at the following location

   - <samplevnf>/VNFs/vCGNAPT/build/vCGNAPT

Run
====

Setup Port to run VNF
----------------------

::

  For DPDK versions 16.04
  1. cd <samplevnf>/dpdk
  2. ./tools/dpdk_nic_bind.py --status <--- List the network device
  3. ./tools/dpdk_nic_bind.py -b igb_uio <PCI Port 0> <PCI Port 1>
  .. _More details: http://dpdk.org/doc/guides-16.04/linux_gsg/build_dpdk.html#binding-and-unbinding-network-ports-to-from-the-kernel-modules

  For DPDK versions 16.11
  1. cd <samplevnf>/dpdk
  2. ./tools/dpdk-devbind.py --status <--- List the network device
  3. ./tools/dpdk-devbind.py -b igb_uio <PCI Port 0> <PCI Port 1>
  .. _More details: http://dpdk.org/doc/guides-16.11/linux_gsg/build_dpdk.html#binding-and-unbinding-network-ports-to-from-the-kernel-modules

  For DPDK versions 17.xx
  1. cd <samplevnf>/dpdk
  2. ./usertools/dpdk-devbind.py --status <--- List the network device
  3. ./usertools/dpdk-devbind.py -b igb_uio <PCI Port 0> <PCI Port 1>
  .. _More details: http://dpdk.org/doc/guides-17.05/linux_gsg/build_dpdk.html#binding-and-unbinding-network-ports-to-from-the-kernel-modules

  Make the necessary changes to the config files to run the vCGNAPT VNF
  eg: ports_mac_list = 00:00:00:30:21:F0 00:00:00:30:21:F1

Dynamic CGNAPT
--------------
Update the configuration according to system configuration.

::

  ./vCGNAPT -p <port mask> -f <config> -s <script> - SW_LoadB
  ./vCGNAPT -p <port mask> -f <config> -s <script> -hwlb <num_WT> - HW_LoadB

Static CGNAPT
-------------
Update the script file and add Static NAT Entry

::

  e.g,
  ;p <pipeline id> entry addm <prv_ipv4/6> prvport> <pub_ip> <pub_port> <phy_port> <ttl> <no_of_entries> <end_prv_port> <end_pub_port>
  ;p 3 entry addm 152.16.100.20 1234 152.16.40.10 1 0 500 65535 1234 65535

Run IPv4
----------

::

  Software LoadB:

  cd <samplevnf>/VNFs/vCGNAPT/build
  ./vCGNAPT -p 0x3 -f ./config/arp_txrx-2P-1T.cfg  -s ./config/arp_txrx_ScriptFile_2P.cfg


  Hardware LoadB:

  cd <samplevnf>/VNFs/vCGNAPT/build
  ./vCGNAPT -p 0x3 -f ./config/arp_hwlb-2P-1T.cfg  -s ./config/arp_hwlb_scriptfile_2P.cfg --hwlb 1

Run IPv6
---------

::

  Software LoadB:

  cd <samplevnf>/VNFs/vCGNAPT/build
  ./vCGNAPT -p 0x3 -f ./config/arp_txrx-2P-1T-ipv6.cfg  -s ./config/arp_txrx_ScriptFile_2P.cfg


  Hardware LoadB:

  cd <samplevnf>/VNFs/vCGNAPT/build
  ./vCGNAPT -p 0x3 -f ./config/arp_hwlb-2P-1T-ipv6.cfg  -s ./config/arp_hwlb_scriptfile_2P.cfg --hwlb 1

vCGNAPT execution on BM & SRIOV
--------------------------------

::

  To run the VNF, execute the following:
  samplevnf/VNFs/vCGNAPT# ./build/vCGNAPT -p 0x3 -f ./config/arp_txrx-2P-1T.cfg -s ./config/arp_txrx_ScriptFile_2P.cfg
  Command Line Params:
  -p PORTMASK: Hexadecimal bitmask of ports to configure
  -f CONFIG FILE: vCGNAPT configuration file
  -s SCRIPT FILE: vCGNAPT script file

vCGNAPT execution on OVS
-------------------------
To run the VNF, execute the following:

::

  samplevnf/VNFs/vCGNAPT# ./build/vCGNAPT -p 0x3 ./config/arp_txrx-2P-1T.cfg -s ./config/arp_txrx_ScriptFile_2P.cfg --disable-hw-csum
  Command Line Params:
  -p PORTMASK: Hexadecimal bitmask of ports to configure
  -f CONFIG FILE: vCGNAPT configuration file
  -s SCRIPT FILE: vCGNAPT script file
  --disable-hw-csum :Disable TCP/UDP hw checksum