blob: 391c5832820b62e8cb4cbc74976afc65b229261e [file] [log] [blame]
jdenisco3bfeff72019-05-17 17:43:31 +00001.. fdio-vpp documentation master file, created by
John DeNisco06dcd452018-07-26 12:45:10 -04002 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
John DeNiscoc96d6182019-11-06 10:58:28 -08006#########################################
7What is the Vector Packet Processor (VPP)
8#########################################
John DeNisco06dcd452018-07-26 12:45:10 -04009
John DeNiscoc96d6182019-11-06 10:58:28 -080010FD.io's Vector Packet Processor (VPP) is a fast, scalable layer 2-4
11multi-platform network stack. It runs in `Linux Userspace <https://en.wikipedia.org/wiki/User_space>`_
12on multiple architectures including x86, ARM, and Power architectures.
13VPP is built using the `Dataplane Development Kit (DPDK) <https://en.wikipedia.org/wiki/Data_Plane_Development_Kit>`_.
John DeNisco06dcd452018-07-26 12:45:10 -040014
John DeNiscoc96d6182019-11-06 10:58:28 -080015VPP benefits include high performance, proven technology, modularity,
16and a rich feature set.
17
18VPP supports integration with OpenStack and Kubernetes. Network
19management features include configuration, counters, sampling and
20more. For developers, VPP includes plugin extensibility,
21high-performance event-logging, and multiple kinds of packet
22tracing. Development debug images include complete symbol tables, and
23extensive consistency checking.
24
25Some VPP Use-cases include vSwitches, vRouters, Gateways, Firewalls
26and Load Balancers, to name a few. Out of the box, VPP can work as a
27software development kit or an appliance.
28
29For more details click on the links below or press next.
John DeNisco06dcd452018-07-26 12:45:10 -040030
31.. toctree::
32 :maxdepth: 2
33
John DeNiscoc96d6182019-11-06 10:58:28 -080034 whatisvpp/index.rst
John DeNisco06dcd452018-07-26 12:45:10 -040035 gettingstarted/index
John DeNisco758dc462018-08-13 17:00:06 -040036 links/index
John DeNisco06dcd452018-07-26 12:45:10 -040037 usecases/index
Scitt Keelerd9b2fce2018-08-30 13:09:34 -040038 featuresbyrelease/index
John DeNisco06dcd452018-07-26 12:45:10 -040039 troubleshooting/index
John DeNisco06dcd452018-07-26 12:45:10 -040040 events/index
41 reference/index
jdenisco45e1cd92018-09-17 15:39:09 -040042 relatedprojects/index
43 archive/index
jdenisco65ed2d02018-11-06 12:32:33 -050044 about.rst