Initial commit of Sphinx docs
[vpp.git] / docs / gettingstarted / users / configutil / commandtwo.rst
1 .. _config-command-two:
2
3 *******
4 Dry Run
5 *******
6
7 With the config utility dry run option the important configuration files are created
8 so that the user can examine them and then if they look reasonable apply them with
9 option 3. The files for **Ubuntu** can be found in the root directory /usr/local/vpp/vpp-config/dryrun
10 and for **Centos** in /usr/vpp/vpp-config/dryrun.
11
12 The important configuration files are **/etc/vpp/startup.conf**, **/etc/sysctl.d/80-vpp.conf**,
13 and **/etc/default/grub** 
14
15 Startup.conf
16 ============
17
18 FD.io VPP startup parameters are configured in the file **/etc/vpp/startup.conf**. The
19 utility creates this file under the vpp-config root directory in vpp/startup.conf.
20 the values in this file come from the questions asked about the devices, cores, rx queues,
21 and tcp parameters.
22
23 80-vpp.conf
24 ===========
25
26 The huge page configuration comes by setting values in the file **/etc/sysctl.d/80-vpp.conf**.
27 The utility creates the file under the root directory in sysctl.d/80-vpp.conf. When asked the
28 question about huge pages the correct values are put in the dryrin file.
29
30 grub
31 ====
32
33 CPUs can be isolated for use by VPP or other processes such as VMs using the grub configuration
34 file. This file is **/etc/default/grub**. This file must be modified with care. It is possible to
35 make your system unusable if this file is modified incorrectly. The dry run file is located under
36 the vpp-config root directory and then default.
37
38 *********************
39 Executing the Dry Run
40 *********************
41
42 The following is an example of how to execute a dry run. Defaults should be picked first and then
43 the values increased accordingly.
44
45 .. code-block:: console
46
47     1) Show basic system information
48     2) Dry Run (Will save the configuration files in /usr/local/vpp/vpp-config/dryrun for inspection)
49     3) Full configuration (WARNING: This will change the system configuration)
50     4) List/Install/Uninstall VPP.
51     q) Quit
52     
53     Command: 2
54     
55     These devices have kernel interfaces, but appear to be safe to use with VPP.
56     
57     PCI ID          Kernel Interface(s)       Description
58     ------------------------------------------------------------------------------------------
59     0000:8f:00.0    enp143s0                  VIC Ethernet NIC
60     0000:84:00.0    enp132s0f0,enp132s0f0d1   Ethernet Controller XL710 for 40GbE QSFP+
61     0000:84:00.1    enp132s0f1,enp132s0f1d1   Ethernet Controller XL710 for 40GbE QSFP+
62     0000:08:00.1    enp8s0f1                  I350 Gigabit Network Connection
63     0000:02:00.0    enp2s0f0                  82599ES 10-Gigabit SFI/SFP+ Network Connection
64     0000:02:00.1    enp2s0f1                  82599ES 10-Gigabit SFI/SFP+ Network Connection
65     0000:86:00.0    enp134s0f0                82599ES 10-Gigabit SFI/SFP+ Network Connection
66     0000:86:00.1    enp134s0f1                82599ES 10-Gigabit SFI/SFP+ Network Connection
67     
68     Would you like to use any of these device(s) for VPP [y/N]? y
69     Would you like to use device 0000:8f:00.0 for VPP [y/N]?
70     Would you like to use device 0000:84:00.0 for VPP [y/N]?
71     Would you like to use device 0000:84:00.1 for VPP [y/N]?
72     Would you like to use device 0000:08:00.1 for VPP [y/N]?
73     Would you like to use device 0000:02:00.0 for VPP [y/N]?
74     Would you like to use device 0000:02:00.1 for VPP [y/N]?
75     Would you like to use device 0000:86:00.0 for VPP [y/N]? y
76     Would you like to use device 0000:86:00.1 for VPP [y/N]? y
77     
78     These device(s) will be used by VPP.
79     
80     PCI ID          Description
81     ----------------------------------------------------------------
82     0000:86:00.0    82599ES 10-Gigabit SFI/SFP+ Network Connection
83     0000:86:00.1    82599ES 10-Gigabit SFI/SFP+ Network Connection
84     0000:90:00.0    VIC Ethernet NIC
85     
86     Would you like to remove any of these device(s) [y/N]? y
87     Would you like to remove 0000:86:00.0 [y/N]?
88     Would you like to remove 0000:86:00.1 [y/N]?
89     Would you like to remove 0000:90:00.0 [y/N]? y
90     
91     These device(s) will be used by VPP, please rerun this option if this is incorrect.
92     
93     PCI ID          Description
94     ----------------------------------------------------------------
95     0000:86:00.0    82599ES 10-Gigabit SFI/SFP+ Network Connection
96     0000:86:00.1    82599ES 10-Gigabit SFI/SFP+ Network Connection
97     
98     Your system has 32 core(s) and 2 Numa Nodes.
99     To begin, we suggest not reserving any cores for VPP or other processes.
100     Then to improve performance start reserving cores and adding queues as needed.
101     
102     How many core(s) shall we reserve for VPP [0-4][0]? 2
103     How many core(s) do you want to reserve for processes other than VPP? [0-15][0]?
104     Should we reserve 1 core for the VPP Main thread? [y/N]? y
105     How many RX queues per port shall we use for VPP [1-4][1]? 2
106     
107     How many active-open / tcp client sessions are expected [0-10000000][0]?
108     How many passive-open / tcp server sessions are expected [0-10000000][0]?
109     
110     There currently 896 2048 kB huge pages free.
111     Do you want to reconfigure the number of huge pages [y/N]? y
112     
113     There currently a total of 1024 huge pages.
114     How many huge pages do you want [1024 - 15644][1024]? 8192
115     
116     What would you like to do?
117     
118     1) Show basic system information
119     2) Dry Run (Will save the configuration files in /usr/local/vpp/vpp-config/dryrun for inspection)
120     3) Full configuration (WARNING: This will change the system configuration)
121     4) List/Install/Uninstall VPP.
122     q) Quit
123     
124     Command: