chore: move sync-srv-redfish-intfs-to-nb into python package

Moved the sync-srv-redfish-intfs-to-nb code into the our workflows python
package. This required fixing up some places to craft the necessary
entry points as well as setting dependencies. Removed the building of
the container for the old directory and add it into the common one.

.github/workflows/build-container-images.yaml

@@ -88,16 +88,6 @@ jobs:
           labels: |
               org.opencontainers.image.version=${{ env.VERSION_OBM_UTILS }}
 
-      - name: Build and deploy Python 3.11 with Nautobot Int Sync
-        uses: docker/build-push-action@v5
-        with:
-          context: argo-workflows/sync-srv-redfish-intfs-to-nb
-          file: argo-workflows/sync-srv-redfish-intfs-to-nb/containers/Dockerfile.nautobot_int_sync
-          # push for all main branch commits
-          push: ${{ github.event_name != 'pull_request' }}
-          tags: ghcr.io/rackerlabs/understack/nautobot-interfaces-sync:latest,ghcr.io/rackerlabs/understack/nautobot-interfaces-sync:${{ env.VERSION_PYTHON_NAUTOBOT_INT_SYNC }}
-          labels: |
-              org.opencontainers.image.version=${{ env.VERSION_PYTHON_NAUTOBOT_INT_SYNC }}
       - name: Build and deploy Python 3.11 with PyNautobot
         uses: docker/build-push-action@v5
         with:

argo-workflows/sync-srv-redfish-intfs-to-nb/workflowtemplates/sync-interfaces-to-nautobot.yaml

@@ -12,10 +12,9 @@ spec:
   templates:
     - name: synchronize-interfaces
       container:
-        image: ghcr.io/rackerlabs/understack/nautobot-interfaces-sync:0.0.1
+        image: ghcr.io/rackerlabs/understack/ironic-nautobot-client:latest
         command:
-          - python
-          - /app/sync_nautobot_interfaces.py
+          - sync-nautobot-interfaces
         args: ["--hostname", "{{workflow.parameters.device_hostname}}"]
         volumeMounts:
           - mountPath: /etc/nb-token/

python/understack-workflows/pyproject.toml

@@ -28,12 +28,15 @@ dependencies = [
     "pydantic==2.8.0",
     "pynautobot==2.2.0",
     "python-ironicclient==5.5.0",
+    "requests==2.32.3",
+    "sushy==5.1.1",
 ]
 
 [project.scripts]
 synchronize-interfaces = "understack_workflows.main.synchronize_interfaces:main"
 synchronize-obm-creds = "understack_workflows.main.synchronize_obm_creds:main"
 synchronize-server = "understack_workflows.main.synchronize_server:main"
+sync-nautobot-interfaces = "understack_workflows.main.sync_nautobot_interfaces:main"
 
 [build-system]
 requires = [

argo-workflows/sync-srv-redfish-intfs-to-nb/code/helpers.py → python/understack-workflows/understack_workflows/helpers.py

@@ -1,9 +1,10 @@
 import argparse
 import logging
 import os
-import sushy
 import sys
 
+import sushy
+
 logger = logging.getLogger(__name__)
 
 
@@ -23,8 +24,7 @@ def arg_parser(name):
     parser = argparse.ArgumentParser(
         prog=os.path.basename(name), description="Nautobot Interface sync"
     )
-    parser.add_argument("--hostname", required=True,
-                        help="Nautobot device name")
+    parser.add_argument("--hostname", required=True, help="Nautobot device name")
     parser.add_argument("--oob_username", required=False, help="OOB username")
     parser.add_argument("--oob_password", required=False, help="OOB password")
     parser.add_argument("--nautobot_url", required=False)
@@ -39,7 +39,7 @@ def exit_with_error(error):
 
 def credential(subpath, item):
     try:
-        return open(f"/etc/{subpath}/{item}", "r").read().strip()
+        return open(f"/etc/{subpath}/{item}").read().strip()
     except FileNotFoundError:
         exit_with_error(f"{subpath} {item} not found in mounted files")
 
@@ -57,7 +57,4 @@ def oob_sushy_session(oob_ip, oob_username, oob_password):
 
 
 def is_off_board(interface):
-    return (
-        "Embedded ALOM" in interface.location
-        or "Embedded" not in interface.location
-    )
+    return "Embedded ALOM" in interface.location or "Embedded" not in interface.location

argo-workflows/sync-srv-redfish-intfs-to-nb/code/sync_nautobot_interfaces.py → python/understack-workflows/understack_workflows/main/sync_nautobot_interfaces.py

@@ -1,15 +1,14 @@
 import sushy
-from models import Chassis
-from helpers import (
-    setup_logger,
-    arg_parser,
-    credential,
-    oob_sushy_session,
-    exit_with_error,
-    is_off_board,
-)
 from nautobot import Nautobot
 
+from understack_workflows.helpers import arg_parser
+from understack_workflows.helpers import credential
+from understack_workflows.helpers import exit_with_error
+from understack_workflows.helpers import is_off_board
+from understack_workflows.helpers import oob_sushy_session
+from understack_workflows.helpers import setup_logger
+from understack_workflows.models import Chassis
+
 logger = setup_logger(__name__)
 
 
@@ -34,9 +33,7 @@ def main():
         exit_with_error(e)
 
     interfaces = [
-        interface
-        for interface in chassis.network_interfaces
-        if is_off_board(interface)
+        interface for interface in chassis.network_interfaces if is_off_board(interface)
     ]
 
     nautobot.bulk_create_interfaces(device_name, interfaces)

argo-workflows/sync-srv-redfish-intfs-to-nb/code/models.py → python/understack-workflows/understack_workflows/models.py

@@ -1,10 +1,12 @@
 from __future__ import annotations
+
 from dataclasses import dataclass
+
 from sushy import Sushy
 from sushy.exceptions import ResourceNotFoundError
+from sushy.resources.chassis.chassis import Chassis as SushyChassis
 from sushy.resources.system.network.adapter import NetworkAdapter
 from sushy.resources.system.network.port import NetworkPort
-from sushy.resources.chassis.chassis import Chassis as SushyChassis
 
 
 class ManufacturerNotSupported(Exception):
@@ -22,10 +24,7 @@ class NIC:
     def from_redfish(cls, data: NetworkAdapter) -> NIC:
         location = cls.nic_location(data)
         nic = cls(data.identity, location, [], data.model)
-        nic.interfaces = [
-            Interface.from_redfish(i, nic)
-            for i in cls.nic_ports(data)
-        ]
+        nic.interfaces = [Interface.from_redfish(i, nic) for i in cls.nic_ports(data)]
         return nic
 
     @classmethod
@@ -89,9 +88,11 @@ def from_hp_json(cls, data: dict, nic: NIC, ports: list) -> Interface:
     def fetch_macaddr_from_sys_resource(cls, data: NetworkPort) -> str:
         try:
             path = f"{data.root.get_system().ethernet_interfaces.path}/{data.identity}"
-            macaddr = data.root.get_system().ethernet_interfaces.get_member(path).mac_address
+            macaddr = (
+                data.root.get_system().ethernet_interfaces.get_member(path).mac_address
+            )
         except ResourceNotFoundError:
-            macaddr = ''
+            macaddr = ""
         return macaddr
 
 
@@ -130,8 +131,7 @@ def from_redfish(cls, oob_obj: Sushy) -> Chassis:
 
         chassis = cls(chassis_data.name, [], [])
         chassis.nics = [
-            NIC.from_redfish(i)
-            for i in chassis_data.network_adapters.get_members()
+            NIC.from_redfish(i) for i in chassis_data.network_adapters.get_members()
         ]
         chassis.network_interfaces = cls.interfaces_from_nics(chassis.nics)
         return chassis

argo-workflows/sync-srv-redfish-intfs-to-nb/code/nautobot.py → python/understack-workflows/understack_workflows/nautobot.py

@@ -1,8 +1,9 @@
 import logging
-import pynautobot
-import requests
 import sys
 from typing import Protocol
+
+import pynautobot
+import requests
 from pynautobot.core.api import Api as NautobotApi
 from pynautobot.models.dcim import Devices as NautobotDevice
 from pynautobot.models.dcim import Interfaces as NautobotInterface
@@ -43,7 +44,6 @@ def device_oob_interface(
         self,
         device: NautobotDevice,
     ) -> NautobotInterface:
-
         oob_intf = self.session.dcim.interfaces.get(
             device_id=device.id, name=["iDRAC", "iLO"]
         )
@@ -73,31 +73,24 @@ def construct_interfaces_payload(
         device_id: str,
         device_name: str,
     ) -> list[dict]:
-
         payload = []
         for interface in interfaces:
             nautobot_intf = self.session.dcim.interfaces.get(
                 device_id=device_id, name=interface.name
             )
             if nautobot_intf is None:
                 self.logger.info(
-                    f"{interface.name} was NOT found for "
-                    f"{device_name}, creating..."
-                )
-                payload.append(
-                    self.interface_payload_data(device_id, interface)
+                    f"{interface.name} was NOT found for " f"{device_name}, creating..."
                 )
+                payload.append(self.interface_payload_data(device_id, interface))
             else:
                 self.logger.info(
                     f"{nautobot_intf.name} found in Nautobot for "
                     f"{device_name}, no action will be taken."
                 )
         return payload
 
-    def interface_payload_data(
-        self, device_id: str, interface: Interface
-    ) -> dict:
-
+    def interface_payload_data(self, device_id: str, interface: Interface) -> dict:
         return {
             "device": device_id,
             "name": interface.name,
@@ -111,9 +104,7 @@ def bulk_create_interfaces(
         self, device_name: str, interfaces: list[Interface]
     ) -> list[NautobotInterface] | None:
         device = self.device(device_name)
-        payload = self.construct_interfaces_payload(
-            interfaces, device.id, device.name
-        )
+        payload = self.construct_interfaces_payload(interfaces, device.id, device.name)
         if payload:
             try:
                 req = self.session.dcim.interfaces.create(payload)