Getting Started

The Getting Started Guide is comprised of several different sections; a User section that describes a basic installation and configuration of VPP (either manually or using a config utility), another install for Developers, which contains additional code that provides tools that are used in a development environment.

This section covers the following:

• Describes how to manually install VPP Binaries on different OS platforms (Ubuntu, Centos) and then how to configure and use VPP.

• Describes the different types of VPP packages, which are used in both basic and developer installs.

• A VPP tutorial which is a great way to learn VPP basics.

The Users section covers configuration operations; this

• How to configure and Run VPP manually.

• How to use the Configuration Utility to install, and then configure VPP.

The Developers section covers the following areas:

• Building VPP

• Describes the components of the four VPP layers

• How to Create, Add, Enable/Disable features

• Discusses different aspects of Bounded-index Extensible Hashing (bihash)

The Writing VPP Documentation section covers the following topics:

• How to build VPP documents

• How to push your changes to the VPP Docs Repository

• Identifies the different styles associated to reStructuredText

• Identifies the different styles associated to Markdown

• Downloading and Installing VPP
  • Installing on Ubuntu
  • Installing on Centos
  • Package Descriptions
• Progressive VPP Tutorial
  • Setting up your environment
  • Running VPP
  • Creating an Interface
  • Using the trace command
  • Connecting Two FD.io VPP Instances
  • Routing
  • Switching
• For Users
  • Configuring VPP
  • Running VPP
• For Developers
  • Building VPP
  • Running VPP
  • GDB Examples
  • Adding a plugin
  • Add a plugin’s GO API
  • Getting a Patch Reviewed
  • Software Architecture
  • VPPINFRA (Infrastructure)
  • VLIB (Vector Processing Library)
  • Packet generator input script
  • Start vpp with 2 worker threads
  • Enable tracing, and start the packet generator
  • Sample Run
  • Plugins
  • VNET (VPP Network Stack)
  • Feature Arcs
  • Buffer Metadata
  • Buffer Metadata Extensions
  • Multi-architecture support
  • Bounded-index Extensible Hashing (bihash)
  • VPP API module
  • Binary API Support
  • Build System
  • Event-logger
  • G2 graphical event viewer
  • FIB 2.0 Hierarchical, Protocol, Independent
  • How to build a vpp dispatch trace aware Wireshark
  • Punting Packets
  • QUIC HostStack
  • Cross compilation on MacOS
  • Cloud NAT
  • VPP API Language {#api_lang_doc}
• Writing Documents
  • Creating VPP Documents
  • reStructured Text Style Guide
  • Markdown Style Guide