From f5529e613305fcc77fa8b9211c3be5fbb9bf81f7 Mon Sep 17 00:00:00 2001 From: Stig Telfer Date: Mon, 6 Mar 2023 17:22:58 +0000 Subject: [PATCH] Add details of physical net configure --display The --display parameter is very helpful but apparently undocumented. Add it here. Change-Id: I0e0e5ab8c2ca549d3278d7319ca6988c8790aef1 --- doc/source/configuration/reference/physical-network.rst | 7 +++++++ doc/source/deployment.rst | 2 +- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/doc/source/configuration/reference/physical-network.rst b/doc/source/configuration/reference/physical-network.rst index 7bfde2ddb..ef5de6f14 100644 --- a/doc/source/configuration/reference/physical-network.rst +++ b/doc/source/configuration/reference/physical-network.rst @@ -24,6 +24,13 @@ The following switch operating systems are currently supported: * Juniper Junos OS * Mellanox MLNX OS +.. note:: + + When developing switch configuration, it can be helpful to see what commands + will be generated. This can be done using the ``--display`` parameter for + ``kayobe physical network configure``, which will output switch global and port + configuration as terminal output without applying it. + Adding Devices to the Inventory =============================== diff --git a/doc/source/deployment.rst b/doc/source/deployment.rst index 21a32a940..24bd7c554 100644 --- a/doc/source/deployment.rst +++ b/doc/source/deployment.rst @@ -35,7 +35,7 @@ Physical Network ================ The physical network can be managed by Kayobe, which uses Ansible's network -modules. Currently Dell Network OS 6 and Dell Network OS 9 switches are +modules. Currently the most popular switches for cloud infrastructure are supported but this could easily be extended. To provision the physical network::