docs/index.rst

   1 .. fdio-vpp documentation master file, created by
   2    sphinx-quickstart on Thu Apr 12 11:02:31 2018.
   3    You can adapt this file completely to your liking, but it should at least
   4    contain the root `toctree` directive.
   5
   6 #########################################
   7 What is the Vector Packet Processor (VPP)
   8 #########################################
   9
  10 FD.io's Vector Packet Processor (VPP) is a fast, scalable layer 2-4
  11 multi-platform network stack. It runs in `Linux Userspace <https://en.wikipedia.org/wiki/User_space>`_
  12 on multiple architectures including x86, ARM, and Power architectures.
  13 VPP is built using the `Dataplane Development Kit (DPDK) <https://en.wikipedia.org/wiki/Data_Plane_Development_Kit>`_.
  14
  15 VPP benefits include high performance, proven technology, modularity,
  16 and a rich feature set.
  17
  18 VPP supports integration with OpenStack and Kubernetes. Network
  19 management features include configuration, counters, sampling and
  20 more. For developers, VPP includes plugin extensibility,
  21 high-performance event-logging, and multiple kinds of packet
  22 tracing. Development debug images include complete symbol tables, and
  23 extensive consistency checking.
  24
  25 Some VPP Use-cases include vSwitches, vRouters, Gateways, Firewalls
  26 and Load Balancers, to name a few. Out of the box, VPP can work as a
  27 software development kit or an appliance.
  28
  29 For more details click on the links below or press next.
  30
  31 .. toctree::
  32    :maxdepth: 2
  33
  34    whatisvpp/index.rst
  35    gettingstarted/index
  36    links/index
  37    usecases/index
  38    featuresbyrelease/index
  39    troubleshooting/index
  40    events/index
  41    reference/index
  42    relatedprojects/index
  43    archive/index
  44    about.rst