diff options
| author |   Vladimir Lavor <vlavor@cisco.com> | 2020-12-11 10:28:49 +0100 |
|---|---|---|
| committer |   Ole Tr�an <otroan@employees.org> | 2021-03-30 12:30:36 +0000 |
| commit | f632ab5e3ba1882106975814597a8e39507d8873 (patch) | |
| tree | 519e2f070006c1d0b2dcadfcc087f78d1fe26a1b /extras/vpptop/README.md | |
| parent | eafb5db63f20975076de8e35932f1ed306a2743e (diff) | |
misc: vpptop makefile target
Type: feature
Added make target to install VPPTop - real-time
viewer of VPP metrics.
New targets in /extras/vpptop/Makefile:
* make start - starts the installed VPPTop binary
* make install - does the installation using the local VPP API
* make cleanup - removes the VPPTop local directory
* make help - prints the VPPTop help info
Signed-off-by: Vladimir Lavor <vlavor@cisco.com>
Change-Id: I1b93eaf67214e1fe0567d43409763882caea6416
Diffstat (limited to 'extras/vpptop/README.md')
| -rw-r--r-- | extras/vpptop/README.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/extras/vpptop/README.md b/extras/vpptop/README.md new file mode 100644 index 00000000000..215f7df29b2 --- /dev/null +++ b/extras/vpptop/README.md @@ -0,0 +1,27 @@ +## VPPTop installer + +[VPPTop]((https://github.com/PANTHEONtech/vpptop)) is a real-time data viewer for VPP interfaces and metrics displayed in dynamic terminal user interface, written in GO. + +Following make targets are available: + +**install** downloads and installs VPPTop including all external dependencies, binary API generator and latest version of GO. Running `make install-dep` (from the VPP top-level Makefile) +is recommended. + +**cleanup** removes VPPTop repository from the target directory (/build-root/vpptop) + +**start** runs the VPPTop if installed + +**help** shows information about available commands + +The VPPTop is installed to be compatible with the given VPP version and may not work with other versions with different API. In that case, the VPPTop has to be re-installed. + +### GO variables management + +The installer depends on Golang environment variables GOROOT (for the GO installation) and GOPATH (for other binaries). Those variables are read from the environment and set to following values if not found: + +GOROOT=/root/.go/ +GOPATH=/root/go/ + +If you have the GO already installed and have to run the installer with `sudo`, use the `-E` switch to provide those variables to the installer. + + |