X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=extras%2Fvpp_config%2FREADME.rst;h=8995edfce9f29868ba7c3ea8a97b469cbabdda4c;hb=5b82610cfa1f6d782ce53c2215fbbb2f6a5b755d;hp=748f66f7c0edec688e31d881747542568bd5f81b;hpb=68b0ee3a38e3a86f0389d8cc695915df190c3dfb;p=vpp.git diff --git a/extras/vpp_config/README.rst b/extras/vpp_config/README.rst index 748f66f7c0e..8995edfce9f 100644 --- a/extras/vpp_config/README.rst +++ b/extras/vpp_config/README.rst @@ -5,13 +5,13 @@ 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 user can also install a released and stable version of VPP. This is currently -released with release 17.07. +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 +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 @@ -23,9 +23,7 @@ apply the configuration and then inspect the system again and then repeat. Caveats: -- Only supports Ubuntu, centos7 is coming shortly. -- When Inspecting the system, you may see a Huge page error, inspect the system a -few more times, if the error persists it is real. +- Supports Ubuntu, centos7, RedHat is coming shortly. For Developers: @@ -38,14 +36,15 @@ environment so you can start from scratch. These are the steps to run the utilit in this environment. The scripts are meant to be run from the root directory. ./scripts/clean.sh - ./scripts/cp-data.sh - ./vpp_config.py + ./scripts/cp-data.sh + ./vpp-config 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. +vpp-config. Run the utility by executing vpp-config. -The start point in the code is in vpp_config.py. However, most of the work is done in +The start point in the code is in vpp_config.py. However, most of the work is +done in the files in ./vpplib Uploading to PyPi: @@ -53,7 +52,7 @@ Uploading to PyPi: To upload this utility to PpPi simple do the following. Currently, I have my own account when we want everyone to contribute we will need to change that. - sudo ÐH bash + sudo �H bash cd vpp_config python setup.py sdist bdist_wheel twine upload dist/* @@ -139,7 +138,7 @@ There are no VPP packages on node localhost. Do you want to install VPP [Y/n]? INFO:root: Local Command: ls /etc/apt/sources.list.d/99fd.io.list.orig INFO:root: /etc/apt/sources.list.d/99fd.io.list.orig -ÉÉ.. +��.. What would you like to do?