docs/index.rst

   1 .. fdio-firstcut 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 FD.io VPP
   8 #########
   9
  10 This is beta VPP Documentation it is not meant to be complete or accurate yet!!!!
  11
  12 FD.io Vector Packet Processing (VPP) is a fast, scalable and multi-platform network stack.
  13
  14 FD.io VPP is, at it's core, a scalable layer 2-4 network stack.
  15 It supports integration into both Open Stack and Kubernetes environments.
  16 It supports network management features including configuration, counters and sampling.
  17 It supports extending with plugins, tracing and debugging.
  18 It supports use cases such as vSwitch, vRouter, Gateways, Firewalls and Load Balancers, to name but a few.
  19 Finally it is useful both a software development kit or an appliance out of the box.
  20
  21 .. toctree::
  22    :maxdepth: 2
  23
  24    overview/index
  25    gettingstarted/index
  26    usecases/index
  27    troubleshooting/index
  28    guides/index
  29    events/index
  30    reference/index