]> git.puffer.fish Git - mirror/frr.git/commitdiff
doc: add doc about the zebra dataplane api version 15688/head
authorMark Stapp <mjs@cisco.com>
Mon, 8 Apr 2024 18:23:58 +0000 (14:23 -0400)
committerMark Stapp <mjs@cisco.com>
Tue, 9 Apr 2024 12:59:13 +0000 (08:59 -0400)
Add a block to the dev doc about the dataplane api version.

Signed-off-by: Mark Stapp <mjs@cisco.com>
doc/developer/zebra.rst

index be2952e71a5a94b5783d5982b616a73f147fbd33..482df96267a3f9ffa6e107ec2a664f71fa048ae8 100644 (file)
@@ -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
 ==================