Welcome to the user guide for the vpp-agent.

Table of contents

• Getting started with vpp-agent
• Concepts in vpp-agent
• Reference guide for vpp-agent
• Components of vpp-agent
• Miscellaneous

Getting started

• Get the general Overview of the vpp-agent, what it is, what it can do and what components is it made of.
• Begin with the Quickstart guide how to download, install and run the vpp-agent.
• Learn how-to use the vpp-agent for configuration.

Concepts

• Models - describes model concept used in the northbound API.
• Key-value Datastore - describes key-value datastore usage in vpp-agent.
• Learn more about the VPP configuration ordering
• VPP multi-version support - describes what is the VPP multi-version support and how it works

Reference

• Find a list of all model keys currently supported.

Components of vpp-agent

• VPP related components:
• VPP configuration management:
  • Access Lists
  • Interfaces
  • IPSec
  • L2 plugin
  • L3 plugin
  • NAT plugin
  • Punt
  • STN plugin
• Collecting and exporting the VPP statistics:
  • Telemetry
• Linux configuration management plugins:
• Linux Interfaces
• Linux L3 plugin
• Namespaces
• Northbound access:
• Clientv2
• REST API
• GRPC
• Data processing & synchronization:
• Configurator
• Orchestrator
• KV Scheduler

Miscellaneous

• The VPP-Agent-ctl to test the vpp-agent with pre-prepared configuration data.
• Examples for various vpp-agent features.