X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=docs%2Findex.rst;h=391c5832820b62e8cb4cbc74976afc65b229261e;hb=61717cc38;hp=ed47bccd253fa5d0a49df69ef98011502eeebc5c;hpb=d9b2fcebef0f2acd350511e949a2543513cc7bb7;p=vpp.git diff --git a/docs/index.rst b/docs/index.rst index ed47bccd253..391c5832820 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,25 +1,37 @@ -.. fdio-firstcut documentation master file, created by +.. fdio-vpp documentation master file, created by sphinx-quickstart on Thu Apr 12 11:02:31 2018. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -######### -FD.io VPP -######### +######################################### +What is the Vector Packet Processor (VPP) +######################################### -FD.io Vector Packet Processing (VPP) is a fast, scalable and multi-platform network stack. +FD.io's Vector Packet Processor (VPP) is a fast, scalable layer 2-4 +multi-platform network stack. It runs in `Linux Userspace `_ +on multiple architectures including x86, ARM, and Power architectures. +VPP is built using the `Dataplane Development Kit (DPDK) `_. -FD.io VPP is, at it's core, a scalable layer 2-4 network stack. -It supports integration into both Open Stack and Kubernetes environments. -It supports network management features including configuration, counters and sampling. -It supports extending with plugins, tracing and debugging. -It supports use cases such as vSwitch, vRouter, Gateways, Firewalls and Load Balancers, to name but a few. -Finally it is useful both a software development kit or an appliance out of the box. +VPP benefits include high performance, proven technology, modularity, +and a rich feature set. + +VPP supports integration with OpenStack and Kubernetes. Network +management features include configuration, counters, sampling and +more. For developers, VPP includes plugin extensibility, +high-performance event-logging, and multiple kinds of packet +tracing. Development debug images include complete symbol tables, and +extensive consistency checking. + +Some VPP Use-cases include vSwitches, vRouters, Gateways, Firewalls +and Load Balancers, to name a few. Out of the box, VPP can work as a +software development kit or an appliance. + +For more details click on the links below or press next. .. toctree:: :maxdepth: 2 - overview/index + whatisvpp/index.rst gettingstarted/index links/index usecases/index @@ -27,3 +39,6 @@ Finally it is useful both a software development kit or an appliance out of the troubleshooting/index events/index reference/index + relatedprojects/index + archive/index + about.rst