Revision as of 18:58, 1 November 2017

Summary

The purpose of the VPP configuration utility is to allow the user to configure VPP in a simple and safe manner. The utility takes input from the user and then modifies the key configuration files. The user can then examine these files to be sure they are correct and then actually apply the configuration. The utility also includes an installation utility and some basic tests. This utility is currently released with release 17.10.

Use

The installation and executing of the VPP configuration utility is simple. First install the python pip module. Using pip install, then pip install vpp-config. Then simply type vpp-config and answer the questions. If you are not sure what to answer choose the default. For yes or no questions the capital letter designates the default. For example, for a question that shows [Y/n] Y is the default. For numbers the default is within the brackets for example for a question that shows [1024]. 1024 is the default.

Ubuntu Example:

$ sudo -H bash
# apt-get install python-pip
Reading package lists... Done
Building dependency tree       
Reading state information... Done
python-pip is already the newest version (8.1.1-2ubuntu0.4).

# pip install vpp-config
Collecting vpp-config
  Downloading vpp_config-17.10.5-py2.py3-none-any.whl (52kB)
Requirement already satisfied: pyyaml in /usr/local/lib/python2.7/dist-packages (from vpp-config)
Requirement already satisfied: netaddr in /usr/local/lib/python2.7/dist-packages (from vpp-config)
Installing collected packages: vpp-config
Successfully installed vpp-config-17.10.5

# vpp-config

Welcome to the VPP system configuration utility

These are the files we will modify:
    /etc/vpp/startup.conf
    /etc/sysctl.d/80-vpp.conf
    /etc/default/grub

Before we change them, we'll create working copies in /usr/local/vpp/vpp-config/dryrun
Please inspect them carefully before applying the actual configuration (option 3)!

What would you like to do?

1) Show basic system information
2) Dry Run (Will save the configuration files in /usr/local/vpp/vpp-config/dryrun for inspection)
       and user input in /usr/local/vpp/vpp-config/configs/auto-config.yaml
3) Full configuration (WARNING: This will change the system configuration)
4) List/Install/Uninstall VPP.
5) Execute some basic tests.
9 or q) Quit

Command: 

Caveats

This utility has been verified and supports Ubuntu16.04, centos7, RHEL7.

For Developers

Modifying the code is reasonable simple. The process would be edit and debug the code from the root directory. In order to do this, we need a script that will copy or data files to the proper place. This is where they end up with pip install. For Ubuntu, this is /usr/local/vpp/vpp-config. I have provided a script that will copy the relevant files correctly. I have also provided a script that will clean the environment so you can start from scratch. These are the steps to run the utility in this environment. The scripts are meant to be run from the root directory.

 ./scripts/clean.sh
 ./scripts/cp-data.sh 
 ./vpp_config.py 

When the utility is installed with pip the wrapper scripts/vpp-config is written to /usr/local/bin. However, the starting point when debugging this script locally is ./vpp_config.py. Run the utility by executing ./vpp_config.py from the root directory.

The start point in the code is in vpp_config.py. However, most of the work is done in the files in ./vpplib