From f8cab9972795d13b9ea5d02af82182ba51327020 Mon Sep 17 00:00:00 2001 From: Mark Stapp Date: Mon, 8 Apr 2024 14:23:58 -0400 Subject: [PATCH] doc: add doc about the zebra dataplane api version Add a block to the dev doc about the dataplane api version. Signed-off-by: Mark Stapp --- doc/developer/zebra.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/doc/developer/zebra.rst b/doc/developer/zebra.rst index be2952e71a..482df96267 100644 --- a/doc/developer/zebra.rst +++ b/doc/developer/zebra.rst @@ -161,6 +161,21 @@ Zebra Protocol Commands The definitions of zebra protocol commands can be found at ``lib/zclient.h``. + +Zebra Dataplane +=============== + +The zebra dataplane subsystem provides a framework for FIB +programming. Zebra uses the dataplane to program the local kernel as +it makes changes to objects such as IP routes, MPLS LSPs, and +interface IP addresses. The dataplane runs in its own pthread, in +order to off-load work from the main zebra pthread. + +The zebra dataplane API is versioned; the version number must be +updated along with API changes. Plugins can test the current version +number and confirm that they are compatible with the current version. + + Dataplane batching ================== -- 2.39.5