From: Quentin Young Date: Thu, 28 Sep 2023 15:44:59 +0000 (-0400) Subject: doc: fixup nbapi doc images X-Git-Tag: base_9.1~21^2~3 X-Git-Url: https://git.puffer.fish/?a=commitdiff_plain;h=011d411c618d3c43f36dfbce262acaf5864a0927;p=mirror%2Ffrr.git doc: fixup nbapi doc images Pulled from web hosting into repo, all figure blocks updated. Signed-off-by: Quentin Young --- diff --git a/doc/developer/northbound/architecture.rst b/doc/developer/northbound/architecture.rst index f551ce9e2f..8a77ef528f 100644 --- a/doc/developer/northbound/architecture.rst +++ b/doc/developer/northbound/architecture.rst @@ -98,11 +98,10 @@ scripts that send CLI commands and parse the text output (which usually doesn’t have any structure) using screen scraping and regular expressions. -+-----------------------------------------+ -| |space-1.jpg| | -+=========================================+ -| *Figure 1: old northbound architecture* | -+-----------------------------------------+ +.. figure:: images/arch-before.png + :alt: diagram of northbound architecture prior to nbapi conversion + + Old northbound architecture The new northbound architectures, on the other hand, features a multitude of different management APIs, all of them connected to the @@ -116,11 +115,10 @@ write custom northbound plugins that can be tailored to all needs (e.g. support custom transport protocols, different data encoding formats, fine-grained access control, etc). -+-----------------------------------------+ -| |space-1.jpg| | -+=========================================+ -| *Figure 2: new northbound architecture* | -+-----------------------------------------+ +.. figure:: images/arch-after.png + :alt: diagram of northbound architecture after nbapi conversion + + New northbound architecture Figure 3 shows the internal view of the FRR northbound architecture. In this image we can see that northbound layer is an abstract entity @@ -133,11 +131,10 @@ plugins that can be maintained separately. The northbound plugins, in turn, have their own APIs to communicate with external management clients. -+---------------------------------------------------------+ -| |space-1.jpg| | -+=========================================================+ -| *Figure 3: new northbound architecture - internal view* | -+---------------------------------------------------------+ +.. figure:: images/nb-layer.png + :alt: diagram of northbound architecture internals + + New northbound architecture - internal view Initially the CLI (and all of its commands) will be maintained inside the FRR daemons. In the long term, however, the goal is to move the CLI @@ -210,29 +207,29 @@ definitive solution to support standard models or not. Northbound Architecture ----------------------- -+-----------------------------------------------+ -| |space-1.jpg| | -+===============================================+ -| *Figure 4: libyang’s lys_node data structure* | -+-----------------------------------------------+ - -+-----------------------------------------------+ -| |space-1.jpg| | -+===============================================+ -| *Figure 5: libyang’s lyd_node data structure* | -+-----------------------------------------------+ - -+---------------------------------------------+ -| |space-1.jpg| | -+=============================================+ -| *Figure 6: libyang’s ly_ctx data structure* | -+---------------------------------------------+ - -+----------------------------------------+ -| |space-1.jpg| | -+========================================+ -| *Figure 7: configuration transactions* | -+----------------------------------------+ +.. figure:: images/lys-node.png + :alt: diagram of libyanbg's lys_node data structure + + ``libyang's`` lys_node data structure + + +.. figure:: images/lyd-node.png + :alt: diagram of libyanbg's lyd_node data structure + + ``libyang's`` lyd_node data structure + + +.. figure:: images/ly-ctx.png + :alt: diagram of libyanbg's ly_ctx data structure + + ``libyang's`` ly_ctx data structure + + +.. figure:: images/transactions.png + :alt: diagram showing how configuration transactions work + + Configuration transactions + Testing ------- @@ -273,11 +270,3 @@ commands. The ``debug northbound`` command can be used to see which northbound callbacks are called in response to the ``commit`` command. For reference, the [[Demos]] page shows a small demonstration of the transactional CLI in action and what it’s capable of. - -.. |space-1.jpg| image:: https://s22.postimg.cc/se52j8awh/arch-before.png -.. |space-1.jpg| image:: https://s22.postimg.cc/fziaiwboh/arch-after.png -.. |space-1.jpg| image:: https://s22.postimg.cc/qmc3ocmep/nb-layer.png -.. |space-1.jpg| image:: https://s22.postimg.cc/z4ljsodht/lys_node.png -.. |space-1.jpg| image:: https://s22.postimg.cc/6eynw1h7l/lyd_node.png -.. |space-1.jpg| image:: https://s22.postimg.cc/5cohdhiyp/ly_ctx.png -.. |space-1.jpg| image:: https://s22.postimg.cc/8waf3bgjl/transactions.png diff --git a/doc/developer/northbound/images/arch-after.png b/doc/developer/northbound/images/arch-after.png new file mode 100644 index 0000000000..01e6ae6364 Binary files /dev/null and b/doc/developer/northbound/images/arch-after.png differ diff --git a/doc/developer/northbound/images/arch-before.png b/doc/developer/northbound/images/arch-before.png new file mode 100644 index 0000000000..ab2bb0deb2 Binary files /dev/null and b/doc/developer/northbound/images/arch-before.png differ diff --git a/doc/developer/northbound/images/ly-ctx.png b/doc/developer/northbound/images/ly-ctx.png new file mode 100644 index 0000000000..4d4e138c73 Binary files /dev/null and b/doc/developer/northbound/images/ly-ctx.png differ diff --git a/doc/developer/northbound/images/lyd-node.png b/doc/developer/northbound/images/lyd-node.png new file mode 100644 index 0000000000..4ba2b48b71 Binary files /dev/null and b/doc/developer/northbound/images/lyd-node.png differ diff --git a/doc/developer/northbound/images/lys-node.png b/doc/developer/northbound/images/lys-node.png new file mode 100644 index 0000000000..e9e46e7f64 Binary files /dev/null and b/doc/developer/northbound/images/lys-node.png differ diff --git a/doc/developer/northbound/images/nb-layer.png b/doc/developer/northbound/images/nb-layer.png new file mode 100644 index 0000000000..4aa1fd6bff Binary files /dev/null and b/doc/developer/northbound/images/nb-layer.png differ diff --git a/doc/developer/northbound/images/transactions.png b/doc/developer/northbound/images/transactions.png new file mode 100644 index 0000000000..d18faf4478 Binary files /dev/null and b/doc/developer/northbound/images/transactions.png differ