extras/vpptop/README.rst

   1 .. _vpp_top_doc:
   2
   3 VPP Top Installation
   4 ====================
   5
   6 `VPPTop <(https://github.com/PANTHEONtech/vpptop)>`__ is a real-time
   7 data viewer for VPP interfaces and metrics displayed in dynamic terminal
   8 user interface, written in GO.
   9
  10 Following make targets are available:
  11
  12 * ``install`` downloads and installs VPPTop including all external dependencies, binary API generator
  13   and latest version of GO. Running ``make install-dep`` (from the VPP top-level Makefile) is recommended.
  14 * ``cleanup`` removes VPPTop repository from the target directory (``/build-root/vpptop``)
  15 * ``start`` runs the VPPTop if installed
  16 * ``help`` shows information about available commands
  17
  18 The VPPTop is installed to be compatible with the given VPP version and
  19 may not work with other versions with different API. In that case, the
  20 VPPTop has to be re-installed.
  21
  22 GO variables management
  23 -----------------------
  24
  25 The installer depends on Golang environment variables GOROOT (for the GO
  26 installation) and GOPATH (for other binaries). Those variables are read
  27 from the environment and set to following values if not found:
  28
  29 ::
  30
  31     GOROOT=/root/.go/ GOPATH=/root/go/
  32
  33
  34 If you have the GO already installed and have to run the installer with
  35 ``sudo``, use the ``-E`` switch to provide those variables to the
  36 installer.