Add caveats to 'netlab show images' command

Also: add the most glaring Cumulus Linux caveats

Author: ipspace

netsim/cli/show_commands/images.py

@@ -28,6 +28,7 @@ def show(settings: Box, args: argparse.Namespace) -> None:
     heading.extend([ p for p in settings.providers.keys() if p != 'external'])
 
   rows = []
+  caveats = []
   result = data.get_empty_box()
   for device in sorted(settings.devices.keys()):
     if device in DEVICES_TO_SKIP:
@@ -39,12 +40,18 @@ def show(settings: Box, args: argparse.Namespace) -> None:
     row = [ device ]
     has_image = False
     for p in heading[1:]:
-      p_image = settings.devices[device][p].get("image","")
-      row.append(p_image)
+      p_data = settings.devices[device][p]
+      p_image = p_data.get("image","")
       if p_image:
         result[device][p] = p_image
+        if p_data.caveats:
+          data.append_to_list(result[device],'caveats',p_data.caveats,flatten=True)
+          caveats.extend(p_data.caveats if isinstance(p_data.caveats,list) else [ p_data.caveats ])
+          p_image = '❗' + p_image
         has_image = True
 
+      row.append(p_image)
+
     if has_image:
       rows.append(row)
 
@@ -56,5 +63,10 @@ def show(settings: Box, args: argparse.Namespace) -> None:
     print(f"{args.device} image names {p_text}")
     print("")
     strings.print_table(heading,rows,inter_row_line=False)
+    if caveats:
+      strings.print_colored_text('\nCaveats:\n\n',color='bold')
+      for cv in caveats:
+        print(strings.wrap_error_message(f'* {cv}',indent=2))
+
   elif args.format in ['text','yaml']:
     print(strings.get_yaml_string(result))

netsim/devices/cumulus.yml

@@ -23,6 +23,8 @@ clab:
       interfaces: /etc/network/interfaces
       hosts: /etc/hosts
   image: networkop/cx:4.4.0                         # Note: dated and known to have issues, unsupported
+  caveats:
+  - Cumulus 4.x containers are out-of-date and not supported
   group_vars:
     ansible_connection: docker
     ansible_user: root

netsim/devices/cumulus_nvue.yml

@@ -16,6 +16,11 @@ libvirt:
   #
   # Latest as of November 2024, supports PVRST+ on single vlan-aware bridge
   image: CumulusCommunity/cumulus-vx:5.10.0
+  caveats:
+  - >-
+    The Vagrant account on public Cumulus 5.x Vagrant boxes has expired password
+    (details in https://netlab.tools/labs/cumulus_nvue/#changing-the-password-expiration-policy)
+  - Newer Cumulus 5.x releases run only on NVIDIA Air
 virtualbox:
   image: CumulusCommunity/cumulus-vx:5.10.0
 group_vars:
@@ -86,6 +91,8 @@ clab:
     kind: cvx
     runtime: docker
   image: networkop/cx:5.3.0                    # Note: dated and known to have issues, unsupported
+  caveats:
+  - Cumulus 5.x containers are out-of-date and not supported
   group_vars:
     ansible_connection: docker
     ansible_user: root