summaryrefslogtreecommitdiffstats
path: root/doc/developer
diff options
context:
space:
mode:
authorQuentin Young <qlyoung@qlyoung.net>2023-09-28 17:44:59 +0200
committerQuentin Young <qlyoung@qlyoung.net>2023-09-28 17:53:07 +0200
commit011d411c618d3c43f36dfbce262acaf5864a0927 (patch)
tree56ce5eca73a089de2b921f4ea6680790058785b3 /doc/developer
parentMerge pull request #14494 from idryzhov/mgmtd-show-datastore-contents-crash (diff)
downloadfrr-011d411c618d3c43f36dfbce262acaf5864a0927.tar.xz
frr-011d411c618d3c43f36dfbce262acaf5864a0927.zip
doc: fixup nbapi doc images
Pulled from web hosting into repo, all figure blocks updated. Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
Diffstat (limited to 'doc/developer')
-rw-r--r--doc/developer/northbound/architecture.rst81
-rw-r--r--doc/developer/northbound/images/arch-after.pngbin0 -> 18651 bytes
-rw-r--r--doc/developer/northbound/images/arch-before.pngbin0 -> 4360 bytes
-rw-r--r--doc/developer/northbound/images/ly-ctx.pngbin0 -> 7242 bytes
-rw-r--r--doc/developer/northbound/images/lyd-node.pngbin0 -> 21699 bytes
-rw-r--r--doc/developer/northbound/images/lys-node.pngbin0 -> 18018 bytes
-rw-r--r--doc/developer/northbound/images/nb-layer.pngbin0 -> 25388 bytes
-rw-r--r--doc/developer/northbound/images/transactions.pngbin0 -> 21532 bytes
8 files changed, 35 insertions, 46 deletions
diff --git a/doc/developer/northbound/architecture.rst b/doc/developer/northbound/architecture.rst
index f551ce9e2..8a77ef528 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 000000000..01e6ae636
--- /dev/null
+++ b/doc/developer/northbound/images/arch-after.png
Binary files differ
diff --git a/doc/developer/northbound/images/arch-before.png b/doc/developer/northbound/images/arch-before.png
new file mode 100644
index 000000000..ab2bb0deb
--- /dev/null
+++ b/doc/developer/northbound/images/arch-before.png
Binary files differ
diff --git a/doc/developer/northbound/images/ly-ctx.png b/doc/developer/northbound/images/ly-ctx.png
new file mode 100644
index 000000000..4d4e138c7
--- /dev/null
+++ b/doc/developer/northbound/images/ly-ctx.png
Binary files differ
diff --git a/doc/developer/northbound/images/lyd-node.png b/doc/developer/northbound/images/lyd-node.png
new file mode 100644
index 000000000..4ba2b48b7
--- /dev/null
+++ b/doc/developer/northbound/images/lyd-node.png
Binary files differ
diff --git a/doc/developer/northbound/images/lys-node.png b/doc/developer/northbound/images/lys-node.png
new file mode 100644
index 000000000..e9e46e7f6
--- /dev/null
+++ b/doc/developer/northbound/images/lys-node.png
Binary files differ
diff --git a/doc/developer/northbound/images/nb-layer.png b/doc/developer/northbound/images/nb-layer.png
new file mode 100644
index 000000000..4aa1fd6bf
--- /dev/null
+++ b/doc/developer/northbound/images/nb-layer.png
Binary files differ
diff --git a/doc/developer/northbound/images/transactions.png b/doc/developer/northbound/images/transactions.png
new file mode 100644
index 000000000..d18faf447
--- /dev/null
+++ b/doc/developer/northbound/images/transactions.png
Binary files differ