Add support level information to 'netlab show devices' (#2540)

Author: ipspace

docs/platforms.md

@@ -61,6 +61,10 @@ The support level of a platform is defined as:
 
 [^WTLTB]: Particularly on platforms that take way too long to boot, like Cisco IOS XR. We're all forced to deal with a limited lifespan.
 
+```{tip}
+Use **netlab show devices** to display the up-to-date device list and device support levels.
+```
+
 (platform-host)=
 Most devices behave as routers (or layer-3 switches); the following devices can take multiple roles or behave as [IP hosts](node-router-host):
 

netsim/cli/show_commands/devices.py

@@ -14,10 +14,50 @@ def parse() -> argparse.ArgumentParser:
   parser_add_device(parser)
   return parser
 
-def show(settings: Box, args: argparse.Namespace) -> None:
-  heading = ['device','description']
+def print_result_table(result: Box, settings: Box) -> None:
+
+  device_rows = []
+  daemon_rows = []
+  caveat_rows = []
+  support_level = data.get_empty_box()
+
+  heading = ['device','description','support level']
+  for d_name in sorted(list(result)):
+    d_data = result[d_name]
+    support_text = d_data.get('support.level','✅') + (' ❗' if d_data.get('support.caveats') else '')
+    row = [ d_name, d_data.description, support_text.center(len(heading[2])) ]
+    d_support = d_data.get('support.level',None)
+    if d_support:
+      support_level[d_support] = True
+    d_caveat = d_data.get('support.caveats',[])
+    if d_caveat:
+      caveat_rows.extend(d_caveat if isinstance(d_caveat,list) else [ d_caveat ])
+
+    if d_data.get('daemon',False):
+      daemon_rows.append(row)
+    else:
+      device_rows.append(row)
+
+  if device_rows:
+    strings.print_colored_text('Virtual network devices supported by netlab\n\n',color='bold')
+    strings.print_table(heading,device_rows,inter_row_line=False)
 
-  rows = []
+  if daemon_rows:
+    strings.print_colored_text('\nNetworking daemons supported by netlab\n\n',color='bold')
+    heading[1] = 'daemon'
+    strings.print_table(heading,daemon_rows,inter_row_line=False)
+
+  if support_level:
+    strings.print_colored_text('\nLegend: support levels\n\n',color='bold')
+    for sl in sorted(list(support_level)):
+      print(strings.wrap_error_message(f'* {sl}: {settings.hints.support[sl]}',indent=2))
+
+  if caveat_rows:
+    strings.print_colored_text('\nCaveats:\n\n',color='bold')
+    for cv in caveat_rows:
+      print(strings.wrap_error_message(f'* {cv}',indent=2))
+
+def show(settings: Box, args: argparse.Namespace) -> None:
   result = data.get_empty_box()
   for device in sorted(settings.devices.keys()):
     dev_data = settings.devices[device]
@@ -27,24 +67,17 @@ def show(settings: Box, args: argparse.Namespace) -> None:
     if device != args.device and args.device != '*':
       continue
 
-    row = [ device,dev_data.description ]
+    dev_summary = data.get_box({ 'description': dev_data.description })
+    if 'support' in dev_data:
+      dev_summary.support = dev_data.support
     if dev_data.daemon:
-      row[1] = {
-        'daemon': True,
-        'description': dev_data.description,
-        'parent': dev_data.daemon_parent
-      }
-    rows.append(row)
-    result[device] = row[1]
+      dev_summary.daemon = True
+      dev_summary.parent = dev_data.daemon_parent
+
+    result[device] = dev_summary
 
   if args.format == 'table':
-    print('Virtual network devices supported by netlab')
-    print("")
-    strings.print_table(heading,[ r for r in rows if isinstance(r[1],str) ],inter_row_line=False)
-    daemons = [ [ r[0],r[1]['description']] for r in rows if isinstance(r[1],dict) and r[1]['daemon'] ]
-    if daemons:
-      print('\nNetworking daemons supported by netlab\n')
-      strings.print_table(['daemon','description'],daemons,inter_row_line=False)
+    print_result_table(result,settings)
 
   elif args.format in ['text','yaml']:
     print(strings.get_yaml_string(result))

netsim/defaults/hints.yml

@@ -77,3 +77,11 @@ nodes:
     Netlab uses the node device type for unmanaged nodes to figure out what
     features the node supports. If you're using a device that is not supported
     by netlab, set the device type to 'none'.
+
+support:
+  best-effort:
+    While a core contributor might still work on the platform, we don't run integration tests
+  minimal:
+    Don't expect too much (particularly new functionality)
+  obsolete:
+    These platforms are still part of the netlab package because the storage prices keep falling

netsim/devices/asav.yml

@@ -1,5 +1,7 @@
 ---
 description: Cisco ASAv
+support:
+  level: minimal
 interface_name: GigabitEthernet0/{ifindex}
 ifindex_offset: 0
 mgmt_if: Management0/0

netsim/devices/cumulus.yml

@@ -1,5 +1,9 @@
 ---
 description: Cumulus VX 4.x or 5.x configured without NVUE
+support:
+  level: obsolete
+  caveats:
+  - The last Cumulus 4.x image was released in September 2022
 interface_name: swp{ifindex}
 loopback_interface_name: lo{ifindex if ifindex else ""}
 tunnel_interface_name: "tun{ifindex}"

netsim/devices/cumulus_nvue.yml

@@ -1,4 +1,8 @@
 description: Cumulus VX 5.x configured with NVUE
+support:
+  level: minimal
+  caveats:
+  - The new Cumulus 5.x releases run only on NVIDIA air. The last public release was 5.10.0 from September 2024
 interface_name: swp{ifindex}
 lag_interface_name: "bond{lag.ifindex}"
 #

netsim/devices/fortios.yml

@@ -1,4 +1,8 @@
 description: Fortinet FortiOS firewall
+support:
+  level: minimal
+  caveats:
+  - We don't test Fortinet configurations due to their ridiculous temporary licensing policy
 interface_name: port{ifindex}
 loopback_interface_name: loopback{ifindex}
 loopback: false

netsim/devices/iosxr.yml

@@ -1,5 +1,7 @@
 ---
 description: Cisco IOS XRv
+support:
+  level: minimal
 mgmt_if: MgmtEth0/RP0/CPU0/0
 interface_name: GigabitEthernet0/0/0/{ifindex}
 loopback_interface_name: Loopback{ifindex}

netsim/devices/nxos.yml

@@ -1,5 +1,7 @@
 ---
 description: Cisco Nexus 9300v
+support:
+  level: best-effort
 interface_name: Ethernet1/{ifindex}
 mgmt_if: mgmt0
 loopback_interface_name: loopback{ifindex}

netsim/devices/openbsd.yml

@@ -1,4 +1,6 @@
 description: OpenBSD
+support:
+  level: best-effort
 interface_name: vio{ifindex}
 loopback_interface_name: lo{ifindex}
 ifindex_offset: 1