Merge pull request #556 from stackhpc/upstream/master-2026-04-27

Synchronise master with upstream

Author: Alex-Welsh

bindep.txt

@@ -2,5 +2,9 @@
 libpcre2-dev [platform:dpkg test]
 pcre2-devel [platform:rpm test]
 
+# Sphinx graphviz extension requires the dot binary.
+graphviz [platform:dpkg test doc]
+graphviz [platform:rpm test doc]
+
 # PDF Docs package dependencies
 tex-gyre [platform:dpkg doc]

doc/source/_static/network-topology-nwdiag.svg

@@ -58,6 +58,20 @@ We can use the ``--var-name`` argument to inspect a particular variable or the
 ``--host`` or ``--hosts`` arguments to view a variable or variables for a
 specific host or set of hosts.
 
+Viewing the Kayobe inventory
+============================
+
+In some cases you may want to examine the full inventory that Kayobe will
+pass to Ansible.  The ``kayobe inventory`` command wraps
+``ansible-inventory`` and automatically assembles the list of inventory
+paths (shared config plus any environment-specific directories).  It can
+be used exactly like ``ansible-inventory``; for example::
+
+    (kayobe) $ kayobe inventory --graph
+
+Any other flags supported by ``ansible-inventory`` are also accepted.
+
+
 Checking Network Connectivity
 =============================
 

doc/source/administration/general.rst

@@ -56,6 +56,7 @@
     'openstackdocstheme',
     #'sphinx.ext.autodoc',
     #'sphinx.ext.intersphinx',
+    'sphinx.ext.graphviz',
     'sphinxcontrib.rsvgconverter',
 ]
 

doc/source/conf.py

@@ -0,0 +1,10 @@
+======================
+Configuration Examples
+======================
+
+This section provides real-world configuration examples.
+
+.. toctree::
+   :maxdepth: 2
+
+   real-world-bridges-and-bonds-configuration-a-virtualised-case-study