From fd.io
Revision as of 15:16, 14 November 2022 by Ayourtch (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
VPP Facts

Project Lead: Damjan Marion

  • Dave Barach
  • Florin Coras
  • Benoit Ganne
  • John Lo
  • Chris Luke
  • Damjan Marion
  • Neale Ranns
  • Matthew Smith
  • Ole Trøan
  • Paul Vinciguerra
  • Dave Wallace
  • Ed Warnicke
  • Andrew Yourtchenko
  • Fan Zhang

Repository: git clone https://gerrit.fd.io/r/vpp
Mailing List: vpp-dev@lists.fd.io
Jenkins: jenkins silo
Gerrit Patches: code patches/reviews
Bugs: VPP bugs


What is VPP? - An introduction to the open-source Vector Packet Processing (VPP) platform

VPP - Working Environments - Environments/distributions, etc... that VPP builds/run on.

Feature Summary - A list of features included in VPP

Get Involved

VPP Documentation

VPP is the core technology behind the FD.io Project. The best place to learn how VPP fits in to the larger FD.io project is the FD.io Main Site.

The VPP User Documents is the most complete and up to date description of VPP. To get started as a user of VPP look at the Getting Started section. For developer guidance, look at the Developer Documentation section. To contribute to the user documents look at the Contributing section.

More VPP related documents:

Getting started with VPP development

Installing VPP binaries from packages - using APT/YUM to install VPP

Pulling, Building, Hacking, and Pushing VPP Code - Explains how to get up and going with the vpp code base.

Building and Installing A VPP Package - Explains how to build, install and test a VPP package

Alternative builds - various platform and feature specific VPP builds

Reporting Bugs - Explains how to report a bug, specifically: how to gather the required information

Python Version Policy - Explains the selection and support of Python in use for many of the development tools.

VPP Troubleshooting - Various tips/tricks for commonly seen issues

Dive Deeper

The VPP API - design and implementation of the VPP API

API Change Process - Change your production-grade APIs in a compatible way without inhibiting innovation

Build System Deep Dive - A close look at the components of the build system.

Introduction To IP Adjacency - An explanation of the characteristics of IP adjacency and its uses.

Introduction To N-tuple Classifiers - An explanation of classifiers and how to create classifier tables and sessions.

Modifying The Packet Processing Directed Graph - An explanation of how a directed node graph processes packets, and possible ways to change the node graph.

Using VPP In A Multi-thread Model - An explanation of multi-thread modes, configurations, and setup.

Using VPP as a VXLAN Tunnel Terminator - An explanation of the VXLAN tunnel terminator, its features, architecture, and API support.

Adding a VPP tunnel encapsulation - How to add a tunnel encapsulation type to vpp.

Using VPP IPSec and IKEv2 - An explanation of IPSec and IKEv2 configuration.

Reference Material

VPP Software Architecture

VPP debug Command-line Interface (CLI) User Guide

VPP debug CLI arguments and startup configuration

Writing VPP Documentation

Performance Analysis Tools

How to spot missing prefetches

Feature Arc infrastructure

DPOs and Feature Arcs

Per-feature Notes

VPP Host Stack

Bounded-index extensible hash infrastructure

Make Test Framework


Deep dive code walkthrough VoDs (recorded at 2016 FD.io pre-launch Event)

VPP video tutorials (collection of short video tutorials).

VPP Howtos (collection of step-by-step howto guides).

VPP training events (videos of VPP training events).

Progressive Tutorial in Using VPP

Use Cases

Use VPP as a Router Between Namespaces - An example configuration of the VPP platform as a router.

Use VPP with dynamic TAP interfaces as a Router Between Containers - Another example of inter-namespace/inter-container routing, using TAP interfaces.

Use VPP to Connect VMs Using Vhost-User Interface - An example of connecting two virtual machines using VPP L2 Bridge and vhost-user interfaces.

Use VPP to Chain VMs Using Vhost-User Interface - An example of chaining two virtual machines and connecting to physical interface.

Use VPP as an LW46 (MAP-E) Terminator - An example configuration of the VPP platform as an lw46 (MAP-E) terminator.

Use VPP for IPv6 Segment Routing - An example of how to leverage SRv6 to create an overlay VPN with underlay optimization.

Use VPP MPLS - Examples for programming VPP for MPLS P/PE support..

Use VPP IP Multicast - Examples for programming VPP for IP Multicast..

Use VPP BIER - Examples for programming VPP for BIER..

Use VPP for Policy Based Routing - Examples for programming VPP for PBR support..

Interconnecting vRouters with VPP - An example to interconnect vRoutes (xrv9000) with VPP using vhost-user feature and VLAN tagging

Use user mode TCP stack with VPP - An example to use user mode TCP stack with VPP using netmap virtual interfaces

Use VPP as a Home Gateway - Configure VPP as a classic ipv4 NAT home gateway

Setup Bi-directional Forwarding Detection - An example on how to setup BFD between VPP and a Cisco Nexus switch

VPP on EC2 instance with SR-IOV support - An example of how to use VPP on EC2 instance with SR-IOV support

How to deploy VPP in an EC2 instance and use it to connect two different VPCs with SR functionalities - How to deploy VPP in an EC2 instance and how use it as router to connect two different VPCs with SR functionalities

VPP Committer Tasks

Release Milestones



NAT plugin - VPP CGN, NAT44, stateful NAT64 project

Security Groups - ACLs, Security Groups, Group Based Policy

VPP/IPFIX - IP Flow Information Export

VPP/AArch64 - VPP on ARM64


VPP/VOM - VPP Object Model

Starter Tasks

If you are looking for tasks to pick up as 'Starter Tasks' to start contributing, we keep a list of those in Jira.

Previous Release Plans

List of all subpages (used or unused)

VPPVPP-16.09 Test Report Performance DataVPP/2022 Make Test Use Case Poll
VPP/API VersioningVPP/Alternative buildsVPP/ApiChangeProcess
VPP/BugReportsVPP/Build, install, and test imagesVPP/Build System Deep Dive
VPP/CodeStyleConventionsVPP/Code Walkthrough VoDVPP/Code Walkthrough VoD Topic Index
VPP/Code Walkthrough VoDsVPP/CodingTipsVPP/Command-line Arguments
VPP/Command-line Interface (CLI) GuideVPP/CommitMessagesVPP/CommitterTasks/ApiFreeze
VPP/CommitterTasks/Compare API ChangesVPP/CommitterTasks/CutPointReleaseVPP/CommitterTasks/CutRelease
VPP/Committers/SMEsVPP/Configuration ToolVPP/Configure VPP As A Router Between Namespaces
VPP/Configure VPP TAP Interfaces For Container RoutingVPP/Configure an LW46 (MAP-E) TerminatorVPP/CoreFileMismatch
VPP/DPOs and Feature ArcsVPP/DocumentationVPP/EC2 instance with SRIOV
VPP/FeaturesVPP/Features/IPv6VPP/Getting VPP 16.06
VPP/Getting VPP Release BinariesVPP/HostStackVPP/HostStack/BuiltinEchoClientServer
VPP/HotplugVPP/How To Build The Sample PluginVPP/How To Connect A PCI Interface To VPP
VPP/How To Optimize Performance (System Tuning)VPP/How To Use The API Trace ToolsVPP/How To Use The C API
VPP/How To Use The Packet Generator and Packet TracerVPP/How to Create a VPP binary control-plane APIVPP/How to add a tunnel encapsulation
VPP/IPSec and IKEv2VPP/IP adjacency introductionVPP/IPv6 SR VIRL topology file
VPP/Installing VPP binaries from packagesVPP/Interconnecting vRouters with VPPVPP/Introduction To IP Adjacency
VPP/Introduction To N-tuple ClassifiersVPP/Java APIVPP/Java API/Plugin support
VPP/MakeTestFrameworkVPP/MeetingVPP/Missing Prefetches
VPP/Modifying The Packet Processing Directed GraphVPP/NATVPP/OVN
VPP/Per-feature NotesVPP/Performance Analysis ToolsVPP/Progressive VPP Tutorial
VPP/Pulling, Building, Running, Hacking and Pushing VPP CodeVPP/Pure L3 Between Namespaces with /32sVPP/Pure L3 Container Networking
VPP/Pushing and Testing a TagVPP/PythonVersionPolicyVPP/Python API
VPP/QuickTrexSetupVPP/RMVPP/Random Hints and Kinks for KVM usage
VPP/STN TestingVPP/SecurityGroupsVPP/Segment Routing for IPv6
VPP/Segment Routing for MPLSVPP/Setting Up Your Dev EnvironmentVPP/Software Architecture
VPP/The VPP APIVPP/Training EventsVPP/Troubleshooting
VPP/Troubleshooting/BuildIssuesVPP/Troubleshooting/VagrantVPP/Tutorial DPDK and MacSwap
VPP/Tutorial Routing and SwitchingVPP/TutorialsVPP/Use VPP to Chain VMs Using Vhost-User Interface
VPP/Use VPP to connect VMs Using Vhost-User InterfaceVPP/Using VPP In A Multi-thread ModelVPP/Using VPP as a VXLAN Tunnel Terminator
VPP/Using mTCP user mode TCP stack with VPPVPP/VOMVPP/VPP/HostStack/BuiltinEchoClientServer
VPP/What is ODP4VPP?VPP/What is VPP?VPP/Working with the 16.06 Throttle Branch
VPP/elogVPP/g2VPP/jira workflow
VPP - Working EnvironmentsVPP 16.06 DPDK PatchsetVPP Sandbox
VPP Sandbox/flowtableVPP Sandbox/mmbVPP Sandbox/router
VPP Sandbox/turbotapVPP Sandbox/vpp-userdemoVPP Usability Track