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
  14 VPP's high performance network stack is quickly becoming the network stack of
  15 choice for applications around the world.
  16
  17 VPP is continually being enhanced through the extensive use of plugins. The
  18 `Data Plane Development Kit (DPDK) <https://en.wikipedia.org/wiki/Data_Plane_Development_Kit>`_
  19 is a great example of this. It provides some important features and drivers
  20 for VPP.
  21
  22 VPP supports integration with OpenStack and Kubernetes. Network
  23 management features include configuration, counters, sampling and
  24 more. For developers, VPP includes high-performance event-logging,
  25 and multiple kinds of packet tracing. Development debug images
  26 include complete symbol tables, and extensive consistency checking.
  27
  28 Some VPP Use-cases include vSwitches, vRouters, Gateways, Firewalls
  29 and Load-Balancers, to name a few.
  30
  31 For more details click on the links below or press next.
  32
  33 .. toctree::
  34    :caption: About VPP
  35    :maxdepth: 1
  36
  37    aboutvpp/scalar-vs-vector-packet-processing
  38    aboutvpp/extensible
  39    aboutvpp/networkstack
  40    aboutvpp/hoststack
  41    aboutvpp/developer
  42    aboutvpp/supported
  43    aboutvpp/performance
  44    aboutvpp/releasenotes/index
  45    aboutvpp/featurelist
  46
  47 .. toctree::
  48    :caption: Use Cases
  49    :maxdepth: 1
  50
  51    usecases/containers/index
  52    usecases/simpleperf/index
  53    usecases/vppcloud/index
  54    usecases/vhost/index
  55    usecases/vmxnet3
  56    usecases/home_gateway
  57    usecases/acls
  58    usecases/networksim
  59    usecases/webapp
  60    usecases/container_test
  61    usecases/trafficgen
  62    usecases/ikev2/index
  63    usecases/contiv/index
  64
  65
  66 .. toctree::
  67    :caption: Getting started
  68    :maxdepth: 2
  69
  70    gettingstarted/installing/index
  71    gettingstarted/running/index
  72    gettingstarted/progressivevpp/index
  73    gettingstarted/troubleshooting/index
  74
  75 .. toctree::
  76     :caption: Developer Documentation
  77     :maxdepth: 2
  78
  79     developer/build-run-debug/index
  80     developer/corearchitecture/index
  81     developer/corefeatures/index
  82     developer/plugindoc/index
  83     developer/plugins/index
  84     developer/devicedrivers/index
  85     developer/tests/overview
  86     developer/extras/index
  87
  88 .. toctree::
  89     :caption: Interfacing with VPP
  90     :maxdepth: 2
  91
  92     interfacing/binapi/index
  93     interfacing/go/index
  94     interfacing/rust/index
  95     interfacing/libmemif/index
  96
  97
  98
  99 .. toctree::
 100     :caption: Contributing
 101     :maxdepth: 2
 102
 103     contributing/gitreview
 104     contributing/writingdocs
 105     contributing/reportingissues/index
 106
 107
 108 .. toctree::
 109     :caption: Debug CLI
 110     :maxdepth: 2
 111
 112     cli-reference/gettingstarted/index
 113     cli-reference/interface/index
 114     cli-reference/index
 115
 116
 117 .. toctree::
 118     :caption: Configuration file
 119     :maxdepth: 2
 120
 121     configuration/config_getting_started
 122     configuration/reference
 123
 124
 125 About this documentation
 126
 127 ::
 128
 129     VPP Version : __VPP_VERSION__
 130     Built on    : __BUILT_ON__