3 The purpose of the VPP configuration utility is to allow the user to configure
\r
4 VPP in a simple and safe manner. The utility takes input from the user and
\r
5 then modifies the key configuration files. The user can then examine these files
\r
6 to be sure they are correct and then actually apply the configuration. The user
\r
7 can also install a released and stable version of VPP. This is currently
\r
8 released with release 17.07.
\r
12 The installation and executing of the VPP configuration utility is simple. First
\r
13 install the python pip module. Using pip install, then pip install vpp-config.
\r
14 Then simply type Òvpp-configÓ and answer the questions. If you are not sure what
\r
15 to answer choose the default. For yes or no questions the capital letter
\r
16 designates the default. For example, for a question that shows [Y/n] Y is the
\r
17 default. For numbers the default is within the brackets for example for a
\r
18 question that shows [1024]. 1024 is the default.
\r
20 The flow of the utility is to inspect the system, if VPP is not install it,
\r
21 create dry run configurations, inspect the files created during the dry run,
\r
22 apply the configuration and then inspect the system again and then repeat.
\r
26 - Only supports Ubuntu, centos7 is coming shortly.
\r
27 - When Inspecting the system, you may see a Huge page error, inspect the system a
\r
28 few more times, if the error persists it is real.
\r
32 Modifying the code is reasonable simple. The process would be edit and debug the
\r
33 code from the root directory. In order to do this, we need a script that will copy
\r
34 or data files to the proper place. This is where they end up with pip install. For
\r
35 Ubuntu, this is /usr/local/vpp/vpp-config. I have provided a script that will copy
\r
36 the relevant files correctly. I have also provided a script that will clean the
\r
37 environment so you can start from scratch. These are the steps to run the utility
\r
38 in this environment. The scripts are meant to be run from the root directory.
\r
41 ./scripts/cp-data.sh
\r
44 When the utility is installed with pip the wrapper scripts/vpp-config is written to
\r
45 /usr/local/bin. However, the starting point when debugging this script locally is
\r
46 ./vpp_config.py. Run the utility by executing ./vpp_config.py from the root directory.
\r
48 The start point in the code is in vpp_config.py. However, most of the work is done in
\r
49 the files in ./vpplib
\r
53 To upload this utility to PpPi simple do the following. Currently, I have my own account
\r
54 when we want everyone to contribute we will need to change that.
\r
58 python setup.py sdist bdist_wheel
\r
63 # pip install vpp-config
\r
66 Welcome to the VPP system configuration utility
\r
68 These are the files we will modify:
\r
69 /etc/vpp/startup.conf
\r
70 /etc/sysctl.d/80-vpp.conf
\r
73 Before we change them, we'll create working copies in /usr/local/vpp/vpp-config/dryrun
\r
74 Please inspect them carefully before applying the actual configuration (option 3)!
\r
76 What would you like to do?
\r
78 1) Show basic system information
\r
79 2) Dry Run (Will save the configuration files in /usr/local/vpp/vpp-config/dryrun for inspection)
\r
80 and user input in /usr/local/vpp/vpp-config/configs/auto-config.yaml
\r
81 3) Full configuration (WARNING: This will change the system configuration)
\r
82 4) Install/Uninstall VPP.
\r
83 5) Dry Run from /usr/local/vpp/vpp-config/auto-config.yaml (will not ask questions).
\r
84 6) Install QEMU patch (Needed when running openstack).
\r
89 ==============================
\r
93 Model name: Intel(R) Xeon(R) CPU E5-2667 v3 @ 3.20GHz
\r
95 Thread(s) per core: 2
\r
96 Core(s) per socket: 8
\r
98 NUMA node0 CPU(s): 0-7,16-23
\r
99 NUMA node1 CPU(s): 8-15,24-31
\r
100 CPU max MHz: 3600.0000
\r
101 CPU min MHz: 1200.0000
\r
104 VPP Threads: (Name: Cpu Number)
\r
107 Current: BOOT_IMAGE=/boot/vmlinuz-4.4.0-96-generic root=UUID=d760b82f-f37b-47e2-9815-db8d479a3557 ro
\r
108 Configured: GRUB_CMDLINE_LINUX_DEFAULT=""
\r
111 Total System Memory : 65863484 kB
\r
112 Total Free Memory : 41325924 kB
\r
113 Actual Huge Page Total : 8192
\r
114 Configured Huge Page Total : 1024
\r
115 Huge Pages Free : 8192
\r
116 Huge Page Size : 2048 kB
\r
123 ==============================
\r
125 What would you like to do?
\r
127 1) Show basic system information
\r
128 2) Dry Run (Will save the configuration files in /usr/local/vpp/vpp-config/dryrun for inspection)
\r
129 and user input in /usr/local/vpp/vpp-config/configs/auto-config.yaml
\r
130 3) Full configuration (WARNING: This will change the system configuration)
\r
131 4) Install/Uninstall VPP.
\r
132 5) Dry Run from /usr/local/vpp/vpp-config/auto-config.yaml (will not ask questions).
\r
133 6) Install QEMU patch (Needed when running openstack).
\r
138 There are no VPP packages on node localhost.
\r
139 Do you want to install VPP [Y/n]?
\r
140 INFO:root: Local Command: ls /etc/apt/sources.list.d/99fd.io.list.orig
\r
141 INFO:root: /etc/apt/sources.list.d/99fd.io.list.orig
\r
144 What would you like to do?
\r
146 1) Show basic system information
\r
147 2) Dry Run (Will save the configuration files in /usr/local/vpp/vpp-config/dryrun for inspection)
\r
148 and user input in /usr/local/vpp/vpp-config/configs/auto-config.yaml
\r
149 3) Full configuration (WARNING: This will change the system configuration)
\r
150 4) Install/Uninstall VPP.
\r
151 5) Dry Run from /usr/local/vpp/vpp-config/auto-config.yaml (will not ask questions).
\r
152 6) Install QEMU patch (Needed when running openstack).
\r
157 ==============================
\r
161 Model name: Intel(R) Xeon(R) CPU E5-2667 v3 @ 3.20GHz
\r
163 Thread(s) per core: 2
\r
164 Core(s) per socket: 8
\r
166 NUMA node0 CPU(s): 0-7,16-23
\r
167 NUMA node1 CPU(s): 8-15,24-31
\r
168 CPU max MHz: 3600.0000
\r
169 CPU min MHz: 1200.0000
\r
172 VPP Threads: (Name: Cpu Number)
\r
177 Current: BOOT_IMAGE=/boot/vmlinuz-4.4.0-96-generic root=UUID=d760b82f-f37b-47e2-9815-db8d479a3557 ro
\r
178 Configured: GRUB_CMDLINE_LINUX_DEFAULT=""
\r
181 Total System Memory : 65863484 kB
\r
182 Total Free Memory : 55877364 kB
\r
183 Actual Huge Page Total : 1024
\r
184 Configured Huge Page Total : 1024
\r
185 Huge Pages Free : 1024
\r
186 Huge Page Size : 2048 kB
\r
189 Name Socket RXQs RXDescs TXQs TXDescs
\r
194 ==============================
\r
196 What would you like to do?
\r
198 1) Show basic system information
\r
199 2) Dry Run (Will save the configuration files in /usr/local/vpp/vpp-config/dryrun for inspection)
\r
200 and user input in /usr/local/vpp/vpp-config/configs/auto-config.yaml
\r
201 3) Full configuration (WARNING: This will change the system configuration)
\r
202 4) Install/Uninstall VPP.
\r
203 5) Dry Run from /usr/local/vpp/vpp-config/auto-config.yaml (will not ask questions).
\r
204 6) Install QEMU patch (Needed when running openstack).
\r
209 These device(s) are currently NOT being used by VPP or the OS.
\r
211 PCI ID Description
\r
212 ----------------------------------------------------------------
\r
213 0000:02:00.0 82599ES 10-Gigabit SFI/SFP+ Network Connection
\r
214 0000:02:00.1 82599ES 10-Gigabit SFI/SFP+ Network Connection
\r
216 Would you like to give any of these devices back to the OS [y/N]? y
\r
217 Would you like to use device 0000:02:00.0 for the OS [y/N]? y
\r
218 Would you like to use device 0000:02:00.1 for the OS [y/N]? y
\r
220 These devices have kernel interfaces, but appear to be safe to use with VPP.
\r
222 PCI ID Kernel Interface(s) Description
\r
223 ------------------------------------------------------------------------------------------
\r
224 0000:90:00.0 enp144s0 VIC Ethernet NIC
\r
225 0000:8f:00.0 enp143s0 VIC Ethernet NIC
\r
226 0000:84:00.0 enp132s0f0,enp132s0f0d1 Ethernet Controller XL710 for 40GbE QSFP+
\r
227 0000:84:00.1 enp132s0f1,enp132s0f1d1 Ethernet Controller XL710 for 40GbE QSFP+
\r
228 0000:08:00.1 enp8s0f1 I350 Gigabit Network Connection
\r
229 0000:02:00.0 enp2s0f0 82599ES 10-Gigabit SFI/SFP+ Network Connection
\r
230 0000:02:00.1 enp2s0f1 82599ES 10-Gigabit SFI/SFP+ Network Connection
\r
231 0000:86:00.0 enp134s0f0 82599ES 10-Gigabit SFI/SFP+ Network Connection
\r
232 0000:86:00.1 enp134s0f1 82599ES 10-Gigabit SFI/SFP+ Network Connection
\r
234 Would you like to use any of these device(s) for VPP [y/N]? y
\r
235 Would you like to use device 0000:90:00.0 for VPP [y/N]?
\r
236 Would you like to use device 0000:8f:00.0 for VPP [y/N]?
\r
237 Would you like to use device 0000:84:00.0 for VPP [y/N]?
\r
238 Would you like to use device 0000:84:00.1 for VPP [y/N]?
\r
239 Would you like to use device 0000:08:00.1 for VPP [y/N]?
\r
240 Would you like to use device 0000:02:00.0 for VPP [y/N]? y
\r
241 Would you like to use device 0000:02:00.1 for VPP [y/N]? y
\r
242 Would you like to use device 0000:86:00.0 for VPP [y/N]? y
\r
243 Would you like to use device 0000:86:00.1 for VPP [y/N]? y
\r
245 These device(s) will be used by VPP.
\r
247 PCI ID Description
\r
248 ----------------------------------------------------------------
\r
249 0000:86:00.0 82599ES 10-Gigabit SFI/SFP+ Network Connection
\r
250 0000:86:00.1 82599ES 10-Gigabit SFI/SFP+ Network Connection
\r
251 0000:02:00.0 82599ES 10-Gigabit SFI/SFP+ Network Connection
\r
252 0000:02:00.1 82599ES 10-Gigabit SFI/SFP+ Network Connection
\r
254 Would you like to remove any of these device(s) [y/N]?
\r
256 These device(s) will be used by VPP, please rerun this option if this is incorrect.
\r
258 PCI ID Description
\r
259 ----------------------------------------------------------------
\r
260 0000:86:00.0 82599ES 10-Gigabit SFI/SFP+ Network Connection
\r
261 0000:86:00.1 82599ES 10-Gigabit SFI/SFP+ Network Connection
\r
262 0000:02:00.0 82599ES 10-Gigabit SFI/SFP+ Network Connection
\r
263 0000:02:00.1 82599ES 10-Gigabit SFI/SFP+ Network Connection
\r
265 Your system has 32 core(s) and 2 Numa Nodes.
\r
266 To begin, we suggest not reserving any cores for VPP or other processes.
\r
267 Then to improve performance try reserving cores as needed.
\r
269 How many core(s) do you want to reserve for processes other than VPP? [0-16][0]? 4
\r
270 How many core(s) shall we reserve for VPP workers[0-4][0]? 2
\r
271 Should we reserve 1 core for the VPP Main thread? [Y/n]?
\r
273 There currently 1024 2048 kB huge pages free.
\r
274 Do you want to reconfigure the number of huge pages [y/N]? y
\r
276 There currently a total of 1024 huge pages.
\r
277 How many huge pages do you want [1024 - 22511][1024]? 8192
\r
279 What would you like to do?
\r
281 1) Show basic system information
\r
282 2) Dry Run (Will save the configuration files in /usr/local/vpp/vpp-config/dryrun for inspection)
\r
283 and user input in /usr/local/vpp/vpp-config/configs/auto-config.yaml
\r
284 3) Full configuration (WARNING: This will change the system configuration)
\r
285 4) Install/Uninstall VPP.
\r
286 5) Dry Run from /usr/local/vpp/vpp-config/auto-config.yaml (will not ask questions).
\r
287 6) Install QEMU patch (Needed when running openstack).
\r
292 We are now going to configure your system(s).
\r
294 Are you sure you want to do this [Y/n]?
\r
295 These are the changes we will apply to
\r
296 the huge page file (/etc/sysctl.d/80-vpp.conf).
\r
299 < # Number of 2MB hugepages desired
\r
300 < vm.nr_hugepages=1024
\r
302 < # Must be greater than or equal to (2 * vm.nr_hugepages).
\r
303 < vm.max_map_count=3096
\r
305 < # All groups allowed to access hugepages
\r
307 > vm.nr_hugepages=8192
\r
308 > vm.max_map_count=17408
\r
310 > kernel.shmmax=17179869184
\r
312 < # Shared Memory Max must be greator or equal to the total size of hugepages.
\r
313 < # For 2MB pages, TotalHugepageSize = vm.nr_hugepages * 2 * 1024 * 1024
\r
314 < # If the existing kernel.shmmax setting (cat /sys/proc/kernel/shmmax)
\r
315 < # is greater than the calculated TotalHugepageSize then set this parameter
\r
316 < # to current shmmax value.
\r
317 < kernel.shmmax=2147483648
\r
320 Are you sure you want to apply these changes [Y/n]?
\r
321 These are the changes we will apply to
\r
322 the VPP startup file (/etc/vpp/startup.conf).
\r
329 > cli-listen /run/vpp/cli.sock
\r
331 < ## In the VPP there is one main thread and optionally the user can create worker(s)
\r
335 > corelist-workers 9-10,5-6
\r
337 > scheduler-policy fifo
\r
338 > scheduler-priority 50
\r
340 > ## In the VPP there is one main thread and optionally the user can create worker(s)
\r
343 < ## Change default settings for all intefaces
\r
347 > dev 0000:86:00.0 {
\r
350 > dev 0000:86:00.1 {
\r
353 > dev 0000:02:00.0 {
\r
356 > dev 0000:02:00.1 {
\r
361 > ## Change default settings for all intefaces
\r
363 > ## Specify bonded interface and its slaves via PCI addresses
\r
365 > ## Bonded interface in XOR load balance mode (mode 2) with L3 and L4 headers
\r
366 > # vdev eth_bond0,mode=2,slave=0000:02:00.0,slave=0000:03:00.0,xmit_policy=l34
\r
367 > # vdev eth_bond1,mode=2,slave=0000:02:00.1,slave=0000:03:00.1,xmit_policy=l34
\r
369 > ## Bonded interface in Active-Back up mode (mode 1)
\r
370 > # vdev eth_bond0,mode=1,slave=0000:02:00.0,slave=0000:03:00.0
\r
371 > # vdev eth_bond1,mode=1,slave=0000:02:00.1,slave=0000:03:00.1
\r
381 Are you sure you want to apply these changes [Y/n]?
\r
383 The configured grub cmdline looks like this:
\r
384 GRUB_CMDLINE_LINUX_DEFAULT="intel_pstate=disable isolcpus=1-4,8,9-10,5-6 nohz_full=1-4,8,9-10,5-6 rcu_nocbs=1-4,8,9-10,5-6"
\r
386 The current boot cmdline looks like this:
\r
387 BOOT_IMAGE=/boot/vmlinuz-4.4.0-96-generic root=UUID=d760b82f-f37b-47e2-9815-db8d479a3557 ro
\r
389 Do you want to keep the current boot cmdline [Y/n]?
\r
391 What would you like to do?
\r
393 1) Show basic system information
\r
394 2) Dry Run (Will save the configuration files in /usr/local/vpp/vpp-config/dryrun for inspection)
\r
395 and user input in /usr/local/vpp/vpp-config/configs/auto-config.yaml
\r
396 3) Full configuration (WARNING: This will change the system configuration)
\r
397 4) Install/Uninstall VPP.
\r
398 5) Dry Run from /usr/local/vpp/vpp-config/auto-config.yaml (will not ask questions).
\r
399 6) Install QEMU patch (Needed when running openstack).
\r
404 ==============================
\r
408 Model name: Intel(R) Xeon(R) CPU E5-2667 v3 @ 3.20GHz
\r
410 Thread(s) per core: 2
\r
411 Core(s) per socket: 8
\r
413 NUMA node0 CPU(s): 0-7,16-23
\r
414 NUMA node1 CPU(s): 8-15,24-31
\r
415 CPU max MHz: 3600.0000
\r
416 CPU min MHz: 1200.0000
\r
419 VPP Threads: (Name: Cpu Number)
\r
422 Current: BOOT_IMAGE=/boot/vmlinuz-4.4.0-96-generic root=UUID=d760b82f-f37b-47e2-9815-db8d479a3557 ro
\r
423 Configured: GRUB_CMDLINE_LINUX_DEFAULT="intel_pstate=disable isolcpus=1-4,8,9-10,5-6 nohz_full=1-4,8,9-10,5-6 rcu_nocbs=1-4,8,9-10,5-6"
\r
426 Total System Memory : 65863484 kB
\r
427 Total Free Memory : 41163916 kB
\r
428 Actual Huge Page Total : 8192
\r
429 Configured Huge Page Total : 8192
\r
430 Huge Pages Free : 3108
\r
431 Huge Page Size : 2048 kB
\r
434 Total Number of Buffers: 71680
\r
438 Sep 27 12:49:59 tf-ucs-3 vpp[13671]: EAL: No free hugepages reported in hugepages-1048576kB
\r
440 ==============================
\r
442 What would you like to do?
\r
444 1) Show basic system information
\r
445 2) Dry Run (Will save the configuration files in /usr/local/vpp/vpp-config/dryrun for inspection)
\r
446 and user input in /usr/local/vpp/vpp-config/configs/auto-config.yaml
\r
447 3) Full configuration (WARNING: This will change the system configuration)
\r
448 4) Install/Uninstall VPP.
\r
449 5) Dry Run from /usr/local/vpp/vpp-config/auto-config.yaml (will not ask questions).
\r
450 6) Install QEMU patch (Needed when running openstack).
\r
455 ==============================
\r
459 Model name: Intel(R) Xeon(R) CPU E5-2667 v3 @ 3.20GHz
\r
461 Thread(s) per core: 2
\r
462 Core(s) per socket: 8
\r
464 NUMA node0 CPU(s): 0-7,16-23
\r
465 NUMA node1 CPU(s): 8-15,24-31
\r
466 CPU max MHz: 3600.0000
\r
467 CPU min MHz: 1200.0000
\r
470 VPP Threads: (Name: Cpu Number)
\r
479 Current: BOOT_IMAGE=/boot/vmlinuz-4.4.0-96-generic root=UUID=d760b82f-f37b-47e2-9815-db8d479a3557 ro
\r
480 Configured: GRUB_CMDLINE_LINUX_DEFAULT="intel_pstate=disable isolcpus=1-4,8,9-10,5-6 nohz_full=1-4,8,9-10,5-6 rcu_nocbs=1-4,8,9-10,5-6"
\r
483 Total System Memory : 65863484 kB
\r
484 Total Free Memory : 41170684 kB
\r
485 Actual Huge Page Total : 8192
\r
486 Configured Huge Page Total : 8192
\r
487 Huge Pages Free : 7936
\r
488 Huge Page Size : 2048 kB
\r
491 Total Number of Buffers: 71680
\r
492 Name Socket RXQs RXDescs TXQs TXDescs
\r
493 TenGigabitEthernet2/0/0 0 2 1024 5 1024
\r
494 TenGigabitEthernet2/0/1 0 2 1024 5 1024
\r
495 TenGigabitEthernet86/0/0 1 2 1024 5 1024
\r
496 TenGigabitEthernet86/0/1 1 2 1024 5 1024
\r
501 ==============================
\r
503 What would you like to do?
\r
505 1) Show basic system information
\r
506 2) Dry Run (Will save the configuration files in /usr/local/vpp/vpp-config/dryrun for inspection)
\r
507 and user input in /usr/local/vpp/vpp-config/configs/auto-config.yaml
\r
508 3) Full configuration (WARNING: This will change the system configuration)
\r
509 4) Install/Uninstall VPP.
\r
510 5) Dry Run from /usr/local/vpp/vpp-config/auto-config.yaml (will not ask questions).
\r
511 6) Install QEMU patch (Needed when running openstack).
\r