README
¶
VPP sample service
The VPP sample service showcases the extensibility of the VPP Agent. The VPP Agent repository has its own examples but this dedicated repository demonstrates the usage of the VPP Agent as dependency. This enables us to demostrate also interconnections of the VPP Agent with other Ligato components (i.e. BGP Agent). Use this repository as skeleton for your software projects (copy&paste it at the very beginning).
The sample service repository contains:
- vpp l3 bgp routes - minimalistic fusion of the VPP Agent and the BGP Agent that configures the VPP according to the BGP-learned IPv4 routes
Quickstart
First project setup steps
For the basic steps to setup a project you can follow the quickstart from cn-sample-service repository.
You will need the VPP Agent dependency (optionally also the BGP Agent dependency) for your glide.yaml file:
package: github.com/ligato/vpp-sample-service
import:
- package: github.com/ligato/vpp-agent
version: 8b61778490fa4a22df294b0682c13e39b8f51869
- package: github.com/ligato/bgp-agent
version: eb9cda59c6c44b8c6e51e8bcc3f738a15c714983
VPP Agent already contains the cn-infra dependency.
Run Examples
If you are more interested in examples, you can run them all just by using the makefile in the root of the repository:
make run-examples
The command pulls needed docker images from Dockerhub, setups networking, builds the examples, runs them, validates their output and cleans after them.
Each example is explained in detail. You can check the examples folder.
Documentation
GoDoc can be browsed online.
Documentation
¶
Overview ¶
Package vppsampleservice is the parent for the VPP sample service specific packages that provide the examples of the VPP Agent extensibility.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package examples contains several examples that illustrate various aspects of VPP sample service functionality.
|
Package examples contains several examples that illustrate various aspects of VPP sample service functionality. |
|
vpp_l3_bgp_routes
Package examples provide examples of Vpp sample service usage.
|
Package examples provide examples of Vpp sample service usage. |
|
Package plugins is the parent package for all VPP sample service plugins.
|
Package plugins is the parent package for all VPP sample service plugins. |
|
vppl3bgp
Package vppl3bgp implements the Vpp sample service plugin that allows plugin to render learned IP-based routes to l3 plugin.
|
Package vppl3bgp implements the Vpp sample service plugin that allows plugin to render learned IP-based routes to l3 plugin. |