Difference between revisions of "GoVPP"
Dwallacelf (Talk | contribs) |
Ondrej-fabry (Talk | contribs) |
||
(One intermediate revision by one other user not shown) | |||
Line 10: | Line 10: | ||
* Jan Medved | * Jan Medved | ||
* Rastislav Szabo | * Rastislav Szabo | ||
+ | * Nathan Skrzypczak | ||
}} | }} | ||
Line 43: | Line 44: | ||
# GoVPP API packages: | # GoVPP API packages: | ||
#* api: high-level API for communication with govpp core using Go channels | #* api: high-level API for communication with govpp core using Go channels | ||
− | #* core: main functionality of the govpp, sends and receives the messages to/from VPP using the adapter, | + | #* core: main functionality of the govpp, sends and receives the messages to/from VPP using the adapter, encodes them and forwards them between the client Go channels and the VPP |
#* adapter: the adapter between the govpp core and the VPP, responsible for sending and receiving binary-encoded data via shared memory, leverages VPP pneum library | #* adapter: the adapter between the govpp core and the VPP, responsible for sending and receiving binary-encoded data via shared memory, leverages VPP pneum library | ||
− | # Other code to ease the adoption of | + | # Other code to ease the adoption of FD.io by Go users |
# Supporting code: | # Supporting code: | ||
#* examples | #* examples | ||
Line 61: | Line 62: | ||
== Devel == | == Devel == | ||
− | * Go | + | * Adding Go module dependency: |
− | go get | + | go get go.fd.io/govpp |
− | * Installing | + | * Installing VPP binary API generator: |
− | go install | + | go install go.fd.io/govpp/cmd/binapi-generator@latest |
* [https://blog.golang.org/generate go generate] rule for generating binary API bindings: | * [https://blog.golang.org/generate go generate] rule for generating binary API bindings: | ||
− | //go:generate | + | //go:generate binapi-generator --input=/usr/share/vpp/api --output-dir=./binapi |
− | * [https:// | + | * [https://github.com/FDio/govpp/blob/master/README.md README.md] |
− | * Auto-generated documentation on [https:// | + | * Auto-generated documentation on [https://pkg.go.dev/go.fd.io/govpp GoDoc] |
− | + | ||
− | + | ||
== Previous Release Plans == | == Previous Release Plans == |
Latest revision as of 09:16, 14 March 2023
GoVPP Facts |
Project Lead: Ondrej Fabry
Repository: git clone https://gerrit.fd.io/r/govpp |
Contents
Intro
GoVPP is a Golang toolset for VPP management. It consists of a set of Golang packages that provide the API for VPP management based on the Go bindings generated from the VPP binary APIs. It can be used as the foundation for any VPP management/control plane written in Go.
Apart from the packages providing the API and tools allowing to write VPP management applications in Go from scratch, the project also aims to provide a cloud-native VPP management agent that can be used in VPP-based container infrastructure.
Get Involved
- GoVPP Meeting
- GoVPP Slack Channel: fdio-project #govpp
- Join the GoVPP Mailing List
- GoVPP Release Plan 22.06
Note: Slack is the preferred application for GoVPP developer and user communications.
Project Contacts
Scope
GoVPP project scope:
- Go bindings generator:
- generates Go structs from binary API definitions in JSON
- annotates the generated Go bindings so they can be marshalled / unmarshalled to/from binary data as understood by VPP
- GoVPP API packages:
- api: high-level API for communication with govpp core using Go channels
- core: main functionality of the govpp, sends and receives the messages to/from VPP using the adapter, encodes them and forwards them between the client Go channels and the VPP
- adapter: the adapter between the govpp core and the VPP, responsible for sending and receiving binary-encoded data via shared memory, leverages VPP pneum library
- Other code to ease the adoption of FD.io by Go users
- Supporting code:
- examples
- unit tests
Out of scope:
- Generator of JSON definitions of VPP binary APIs
- vppapiclient (former pneum) library used to send & receive binary-encoded data to/from VPP
Performance
According to the performance benchmark results, GoVPP is currently able to handle more than 250 000 binary API requests per second via the asynchronous API on a standard laptop. More details: [1]
Devel
- Adding Go module dependency:
go get go.fd.io/govpp
- Installing VPP binary API generator:
go install go.fd.io/govpp/cmd/binapi-generator@latest
- go generate rule for generating binary API bindings:
//go:generate binapi-generator --input=/usr/share/vpp/api --output-dir=./binapi
- Auto-generated documentation on GoDoc
Previous Release Plans
List of all subpages (used or unused)
GoVPP | GoVPP/Meeting | GoVPP/Performance |
GoVPP/Release Plans/Release Plan 17.07 | GoVPP/gerrit-review |