docs/gettingstarted/users/running/index.rst

   1 .. _running:
   2
   3 Running VPP
   4 ===========
   5
   6 .. toctree::
   7
   8 'vpp' Usergroup
   9 ---------------
  10
  11 When VPP is installed, a new usergroup *'vpp'* is created. To avoid running the
  12 VPP CLI (vppctl) as root, add any existing users to the new group that need to
  13 interact with VPP:
  14
  15 .. code-block:: console
  16
  17     $ sudo usermod -a -G vpp user1
  18
  19 Update your current session for the group change to take effect:
  20
  21 .. code-block:: console
  22
  23     $ newgrp vpp
  24
  25
  26 VPP Systemd File - 'vpp.service'
  27 --------------------------------
  28
  29 When the VPP is installed, a systemd service files is also installed. This
  30 file, vpp.service (Ubuntu: /lib/systemd/system/vpp.service and CentOS:
  31 /usr/lib/systemd/system/vpp.service), controls how VPP is run as a service. For
  32 example, whether or not to restart on failure and if so, with how much delay.
  33 Also, which UIO driver should be loaded and location of the *'startup.conf'*
  34 file.
  35
  36 .. code-block:: console
  37
  38     $ cat /usr/lib/systemd/system/vpp.service
  39     [Unit]
  40     Description=Vector Packet Processing Process
  41     After=syslog.target network.target auditd.service
  42
  43     [Service]
  44     ExecStartPre=-/bin/rm -f /dev/shm/db /dev/shm/global_vm /dev/shm/vpe-api
  45     ExecStartPre=-/sbin/modprobe uio_pci_generic
  46     ExecStart=/usr/bin/vpp -c /etc/vpp/startup.conf
  47     Type=simple
  48     Restart=on-failure
  49     RestartSec=5s
  50
  51     [Install]
  52     WantedBy=multi-user.target
  53
  54 .. note::
  55
  56     Some older versions of the *'uio_pci_generic'* driver don't bind all
  57     the supported NICs properly, so the *'igb_uio'* driver built from DPDK
  58     needs to be installed. This file controls which driver is loaded at boot.
  59     *'startup.conf'* file controls which driver is used.