Tweaks, FRR support

Author: ipspace

docs/node/debug.md

@@ -33,11 +33,14 @@ You can enable debugging *before* configuring network devices with this simple t
 3. Log into the network devices and enable debugging, or use a custom configuration template and execute it with **netlab config _debugging_template_** (this approach yet again gives you multi-vendor capabilities).
 4. Start device configuration with **netlab initial**
 
-Finally, you might be worried that the symptoms you're experiencing depend on the time after the device boots, so you want to enable debugging as soon as possible. In that case, you can use the node **debug** attribute (on devices for which we implemented it), which is a list of device-specific debugging parameters that will be executed at the very beginning of the initial device configuration.
+(node-debug-attribute)=
+Finally, you might be worried that the symptoms you're experiencing depend on the time after the device boots, so you want to enable debugging as soon as possible. In that case, you can use the node **debug** attribute (on [devices for which we implemented it](platform-initial-extra)), which is a list of device-specific debugging parameters that will be executed at the very beginning of the initial device configuration.
 
 **Caveats:**
 
-* The contents of the **debug** attribute are device-specific. *netlab* currently does not have multi-vendor **debug** capabilites. The values of the **debug** attribute must be relevant to the underlying network device, or you'll get configuration errors during the initial configuration
+* The contents of the **debug** attribute are device-specific. *netlab* currently does not have multi-vendor **debug** capabilites.
+* The values of the **debug** attribute are not checked. They must be relevant to the underlying network device, or you'll get configuration errors during the initial configuration
+* _netlab_ does not check whether the initial configuration template of the device you're using includes debugging support. See the [initial device configuration support tables](platform-initial-extra) for more details.
 * The initial device configuration template supplies the mandatory prefix (for example, **do debug**). You only have to list the debugging conditions, for example:
 
 ```

docs/platforms.md

@@ -283,6 +283,14 @@ The following interface addresses are supported on various platforms:
 * See [Initial Configuration Integration Tests Results](https://release.netlab.tools/_html/coverage.initial) for up-to-date details.
 ```
 
+(platform-initial-extra)=
+Some platforms can enable additional functionality during the initial device configuration:
+
+| Operating system | Enable<br>[debugging](node-debug-attribute) |
+|------------------|:-:|
+| Cisco IOS/IOS XE[^18v]| ✅  |
+| FRRouting             | ✅  | 
+
 ## Supported Configuration Modules
 
 (platform-routing-support)=

netsim/ansible/templates/initial/_debug_commands.j2

@@ -0,0 +1,9 @@
+{% macro enable_debugging(debug,limit='',prefix='do debug') %}
+{%   for dbg in debug|default([]) if dbg and (limit == '' or limit in dbg) %}
+{%     if loop.first %}
+!
+! Enable debugging
+{%     endif %}
+{{ prefix }} {{ dbg }}
+{%   endfor %}
+{% endmacro %}

netsim/ansible/templates/initial/frr.j2

@@ -129,6 +129,12 @@ echo "service integrated-vtysh-config" >/etc/frr/vtysh.conf
 cat >/tmp/config <<CONFIG
 hostname {{ inventory_hostname }}
 !
+{% if debug is defined %}
+log file /tmp/logging
+{%   from '_debug_commands.j2' import enable_debugging %}
+{{   enable_debugging(debug,prefix='debug') }}
+{% endif %}
+!
 {#
   These commands set the corresponding net.ipv4 / net.ipv6 variables.
   As we don't want to assume the default values, we set them explicitly
@@ -183,4 +189,5 @@ interface {{ i.ifname }}
 do write
 CONFIG
 vtysh -f /tmp/config
+!
 exit 0

netsim/ansible/templates/initial/ios.j2

@@ -2,13 +2,8 @@ hostname {{ inventory_hostname }}
 !
 no ip domain lookup
 logging buffered 256000
-{% for dbg in debug|default([]) %}
-{%   if loop.first %}
-!
-! Enable debugging
-{%   endif %}
-do debug {{ dbg }}
-{% endfor %}
+{% from '_debug_commands.j2' import enable_debugging %}
+{{ enable_debugging(debug) }}
 !
 lldp run
 !