| jdenisco | 3bfeff7 | 2019-05-17 17:43:31 +0000 | [diff] [blame] | 1 | .. fdio-vpp documentation master file, created by |
| John DeNisco | 06dcd45 | 2018-07-26 12:45:10 -0400 | [diff] [blame] | 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 | |
| John DeNisco | c96d618 | 2019-11-06 10:58:28 -0800 | [diff] [blame] | 6 | ######################################### |
| 7 | What is the Vector Packet Processor (VPP) |
| 8 | ######################################### |
| John DeNisco | 06dcd45 | 2018-07-26 12:45:10 -0400 | [diff] [blame] | 9 | |
| John DeNisco | c96d618 | 2019-11-06 10:58:28 -0800 | [diff] [blame] | 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. |
| John DeNisco | 06dcd45 | 2018-07-26 12:45:10 -0400 | [diff] [blame] | 13 | |
| John DeNisco | 742000a | 2020-07-06 12:27:58 -0400 | [diff] [blame] | 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 |
| Dave Barach | 3db2c67 | 2021-06-09 07:49:34 -0400 | [diff] [blame] | 18 | `Data Plane Development Kit (DPDK) <https://en.wikipedia.org/wiki/Data_Plane_Development_Kit>`_ |
| John DeNisco | 742000a | 2020-07-06 12:27:58 -0400 | [diff] [blame] | 19 | is a great example of this. It provides some important features and drivers |
| 20 | for VPP. |
| John DeNisco | c96d618 | 2019-11-06 10:58:28 -0800 | [diff] [blame] | 21 | |
| 22 | VPP supports integration with OpenStack and Kubernetes. Network |
| 23 | management features include configuration, counters, sampling and |
| John DeNisco | 742000a | 2020-07-06 12:27:58 -0400 | [diff] [blame] | 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. |
| John DeNisco | c96d618 | 2019-11-06 10:58:28 -0800 | [diff] [blame] | 27 | |
| 28 | Some VPP Use-cases include vSwitches, vRouters, Gateways, Firewalls |
| Nathan Skrzypczak | 9ad39c0 | 2021-08-19 11:38:06 +0200 | [diff] [blame] | 29 | and Load-Balancers, to name a few. |
| John DeNisco | c96d618 | 2019-11-06 10:58:28 -0800 | [diff] [blame] | 30 | |
| 31 | For more details click on the links below or press next. |
| John DeNisco | 06dcd45 | 2018-07-26 12:45:10 -0400 | [diff] [blame] | 32 | |
| 33 | .. toctree:: |
| Nathan Skrzypczak | 9ad39c0 | 2021-08-19 11:38:06 +0200 | [diff] [blame] | 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 |
| Matthew Giassa | 4a0dd38 | 2021-11-19 17:06:11 +0000 | [diff] [blame] | 64 | usecases/vpp_testbench/index |
| Nathan Skrzypczak | 9ad39c0 | 2021-08-19 11:38:06 +0200 | [diff] [blame] | 65 | |
| 66 | |
| 67 | .. toctree:: |
| 68 | :caption: Getting started |
| John DeNisco | 06dcd45 | 2018-07-26 12:45:10 -0400 | [diff] [blame] | 69 | :maxdepth: 2 |
| 70 | |
| Nathan Skrzypczak | 9ad39c0 | 2021-08-19 11:38:06 +0200 | [diff] [blame] | 71 | gettingstarted/installing/index |
| 72 | gettingstarted/running/index |
| 73 | gettingstarted/progressivevpp/index |
| 74 | gettingstarted/troubleshooting/index |
| 75 | |
| 76 | .. toctree:: |
| 77 | :caption: Developer Documentation |
| 78 | :maxdepth: 2 |
| 79 | |
| 80 | developer/build-run-debug/index |
| 81 | developer/corearchitecture/index |
| 82 | developer/corefeatures/index |
| 83 | developer/plugindoc/index |
| 84 | developer/plugins/index |
| 85 | developer/devicedrivers/index |
| 86 | developer/tests/overview |
| 87 | developer/extras/index |
| 88 | |
| 89 | .. toctree:: |
| 90 | :caption: Interfacing with VPP |
| 91 | :maxdepth: 2 |
| 92 | |
| 93 | interfacing/binapi/index |
| Nathan Skrzypczak | cbb4e46 | 2021-10-13 12:40:42 +0200 | [diff] [blame] | 94 | interfacing/c/index |
| 95 | interfacing/cpp/index |
| Nathan Skrzypczak | 9ad39c0 | 2021-08-19 11:38:06 +0200 | [diff] [blame] | 96 | interfacing/go/index |
| 97 | interfacing/rust/index |
| 98 | interfacing/libmemif/index |
| 99 | |
| 100 | |
| 101 | |
| 102 | .. toctree:: |
| 103 | :caption: Contributing |
| 104 | :maxdepth: 2 |
| 105 | |
| 106 | contributing/gitreview |
| 107 | contributing/writingdocs |
| 108 | contributing/reportingissues/index |
| 109 | |
| 110 | |
| 111 | .. toctree:: |
| 112 | :caption: Debug CLI |
| 113 | :maxdepth: 2 |
| 114 | |
| 115 | cli-reference/gettingstarted/index |
| 116 | cli-reference/interface/index |
| 117 | cli-reference/index |
| 118 | |
| 119 | |
| 120 | .. toctree:: |
| 121 | :caption: Configuration file |
| 122 | :maxdepth: 2 |
| 123 | |
| 124 | configuration/config_getting_started |
| 125 | configuration/reference |
| 126 | |
| 127 | |
| 128 | About this documentation |
| 129 | |
| 130 | :: |
| 131 | |
| 132 | VPP Version : __VPP_VERSION__ |
| 133 | Built on : __BUILT_ON__ |