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