blob: 8694a83341f2bfa61dc32cdff7d7d10910e35861 [file] [log] [blame]
John DeNisco06dcd452018-07-26 12:45:10 -04001.. _usingvppconfig.rst:
2
3*******
4Running
5*******
6
7The vpp-config utility provides the user with several different menus. This allows the
8user to configure ports, some performance characteristics, the number of huge pages
9and install/uninstall the released FD.io packages.
10
John DeNiscoc64ba6d2018-08-02 15:03:15 -040011It is recommended that the menu command options, noted below as *"x)"*, are run in
12this order (command option 4 first, then options 1,2,3):
John DeNisco06dcd452018-07-26 12:45:10 -040013
14#. :ref:`4) List/Install/Uninstall VPP <config-command-four>`
15#. :ref:`1) Show basic system information <config-command-one>`
16#. :ref:`2) Dry Run <config-command-two>`
17#. :ref:`3) Full Configuration <config-command-three>`
18
John DeNiscoc64ba6d2018-08-02 15:03:15 -040019Once vpp-config is installed as a root user, then run the following code:
John DeNisco06dcd452018-07-26 12:45:10 -040020
21.. code-block:: console
22
23 $ sudo -H bash
24 # vpp-config
25
26 Welcome to the VPP system configuration utility
27
28 These are the files we will modify:
29 /etc/vpp/startup.conf
30 /etc/sysctl.d/80-vpp.conf
31 /etc/default/grub
32
33 Before we change them, we'll create working copies in /usr/local/vpp/vpp-config/dryrun
34 Please inspect them carefully before applying the actual configuration (option 3)!
35
36 What would you like to do?
37
38 1) Show basic system information
39 2) Dry Run (Will save the configuration files in /usr/local/vpp/vpp-config/dryrun for inspection)
40 4) List/Install/Uninstall VPP.
41 q) Quit
42
43 Command:
44
45Default Values
46==============
47
John DeNiscoc64ba6d2018-08-02 15:03:15 -040048If you do not choose to modify the default for any of the questions prompted by vpp-config, then
49you may press the **ENTER** key to select the default options:
John DeNisco06dcd452018-07-26 12:45:10 -040050
51* Questions that ask [Y/n], the capital letter Y is the default answer.
52* Numbers have their default within brackets, such as in [1024], the 1024 is the default.