osism 0.20250628.0__py3-none-any.whl → 0.20250709.0__py3-none-any.whl

osism/settings.py

@@ -54,3 +54,6 @@ SONIC_EXPORT_IDENTIFIER = os.getenv("SONIC_EXPORT_IDENTIFIER", "serial-number")
 NETBOX_SECONDARIES = (
     os.getenv("NETBOX_SECONDARIES", read_secret("NETBOX_SECONDARIES")) or "[]"
 )
+
+# Redfish connection timeout in seconds
+REDFISH_TIMEOUT = int(os.getenv("REDFISH_TIMEOUT", "20"))

osism/tasks/__init__.py

@@ -1,12 +1,10 @@
 # SPDX-License-Identifier: Apache-2.0
 
-import logging
 import os
 import re
 import subprocess
 
 from loguru import logger
-from pottery import Redlock
 
 from osism import utils
 
@@ -77,10 +75,8 @@ def run_ansible_in_environment(
 
     # NOTE: Consider arguments in the future
     if locking:
-        logging.getLogger("redlock").setLevel(logging.WARNING)
-        lock = Redlock(
+        lock = utils.create_redlock(
             key=f"lock-ansible-{environment}-{role}",
-            masters={utils.redis},
             auto_release_time=auto_release_time,
         )
 
@@ -195,9 +191,8 @@ def run_command(
         command_env.update(env)
 
     if locking:
-        lock = Redlock(
+        lock = utils.create_redlock(
             key=f"lock-{command}",
-            masters={utils.redis},
             auto_release_time=auto_release_time,
         )
 

osism/tasks/ansible.py

@@ -1,7 +1,6 @@
 # SPDX-License-Identifier: Apache-2.0
 
 from celery import Celery
-from pottery import Redlock
 
 from osism import settings, utils
 from osism.tasks import Config, run_ansible_in_environment
@@ -12,9 +11,8 @@ app.config_from_object(Config)
 
 @app.on_after_configure.connect
 def setup_periodic_tasks(sender, **kwargs):
-    lock = Redlock(
+    lock = utils.create_redlock(
         key="lock_osism_tasks_ansible_setup_periodic_tasks",
-        masters={utils.redis},
     )
     if settings.GATHER_FACTS_SCHEDULE > 0 and lock.acquire(timeout=10):
         sender.add_periodic_task(

osism/tasks/conductor/__init__.py

@@ -8,6 +8,7 @@ from loguru import logger
 from osism.tasks import Config
 from osism.tasks.conductor.config import get_configuration
 from osism.tasks.conductor.ironic import sync_ironic as _sync_ironic
+from osism.tasks.conductor.redfish import get_resources as _get_redfish_resources
 from osism.tasks.conductor.sonic import sync_sonic as _sync_sonic
 
 
@@ -52,9 +53,15 @@ def sync_sonic(self, device_name=None, show_diff=True):
     return _sync_sonic(device_name, self.request.id, show_diff)
 
 
+@app.task(bind=True, name="osism.tasks.conductor.get_redfish_resources")
+def get_redfish_resources(self, hostname, resource_type):
+    return _get_redfish_resources(hostname, resource_type)
+
+
 __all__ = [
     "app",
     "get_ironic_parameters",
+    "get_redfish_resources",
     "sync_netbox",
     "sync_ironic",
     "sync_sonic",

osism/tasks/conductor/config.py

@@ -1,22 +1,12 @@
 # SPDX-License-Identifier: Apache-2.0
 
-import uuid
-
 from loguru import logger
+import validators
 import yaml
 
 from osism.tasks import Config, openstack
 
 
-def is_uuid(value):
-    """Check if a string is a valid UUID."""
-    try:
-        uuid.UUID(value)
-        return True
-    except (ValueError, AttributeError):
-        return False
-
-
 def get_configuration():
     with open("/etc/conductor.yml") as fp:
         configuration = yaml.load(fp, Loader=yaml.SafeLoader)
@@ -39,54 +29,81 @@ def get_configuration():
                 image_source = configuration["ironic_parameters"]["instance_info"][
                     "image_source"
                 ]
-                if not is_uuid(image_source):
+                if not validators.uuid(image_source) and not validators.url(
+                    image_source
+                ):
                     result = openstack.image_get(image_source)
-                    configuration["ironic_parameters"]["instance_info"][
-                        "image_source"
-                    ] = result.id
+                    if result:
+                        configuration["ironic_parameters"]["instance_info"][
+                            "image_source"
+                        ] = result.id
+                    else:
+                        logger.warning(f"Could not resolve image ID for {image_source}")
 
         if "driver_info" in configuration["ironic_parameters"]:
             if "deploy_kernel" in configuration["ironic_parameters"]["driver_info"]:
                 deploy_kernel = configuration["ironic_parameters"]["driver_info"][
                     "deploy_kernel"
                 ]
-                if not is_uuid(deploy_kernel):
+                if not validators.uuid(deploy_kernel) and not validators.url(
+                    deploy_kernel
+                ):
                     result = openstack.image_get(deploy_kernel)
-                    configuration["ironic_parameters"]["driver_info"][
-                        "deploy_kernel"
-                    ] = result.id
+                    if result:
+                        configuration["ironic_parameters"]["driver_info"][
+                            "deploy_kernel"
+                        ] = result.id
+                    else:
+                        logger.warning(
+                            f"Could not resolve image ID for {deploy_kernel}"
+                        )
 
             if "deploy_ramdisk" in configuration["ironic_parameters"]["driver_info"]:
                 deploy_ramdisk = configuration["ironic_parameters"]["driver_info"][
                     "deploy_ramdisk"
                 ]
-                if not is_uuid(deploy_ramdisk):
+                if not validators.uuid(deploy_ramdisk) and not validators.url(
+                    deploy_ramdisk
+                ):
                     result = openstack.image_get(deploy_ramdisk)
-                    configuration["ironic_parameters"]["driver_info"][
-                        "deploy_ramdisk"
-                    ] = result.id
+                    if result:
+                        configuration["ironic_parameters"]["driver_info"][
+                            "deploy_ramdisk"
+                        ] = result.id
+                    else:
+                        logger.warning(
+                            f"Could not resolve image ID for {deploy_ramdisk}"
+                        )
 
             if "cleaning_network" in configuration["ironic_parameters"]["driver_info"]:
-                result = openstack.network_get(
+                cleaning_network = configuration["ironic_parameters"]["driver_info"][
+                    "cleaning_network"
+                ]
+                result = openstack.network_get(cleaning_network)
+                if result:
                     configuration["ironic_parameters"]["driver_info"][
                         "cleaning_network"
-                    ]
-                )
-                configuration["ironic_parameters"]["driver_info"][
-                    "cleaning_network"
-                ] = result.id
+                    ] = result.id
+                else:
+                    logger.warning(
+                        f"Could not resolve network ID for {cleaning_network}"
+                    )
 
             if (
                 "provisioning_network"
                 in configuration["ironic_parameters"]["driver_info"]
             ):
-                result = openstack.network_get(
+                provisioning_network = configuration["ironic_parameters"][
+                    "driver_info"
+                ]["provisioning_network"]
+                result = openstack.network_get(provisioning_network)
+                if result:
                     configuration["ironic_parameters"]["driver_info"][
                         "provisioning_network"
-                    ]
-                )
-                configuration["ironic_parameters"]["driver_info"][
-                    "provisioning_network"
-                ] = result.id
+                    ] = result.id
+                else:
+                    logger.warning(
+                        f"Could not resolve network ID for {provisioning_network}"
+                    )
 
         return configuration

osism/tasks/conductor/ironic.py

@@ -3,7 +3,6 @@
 import json
 
 import jinja2
-from pottery import Redlock
 
 from osism import utils as osism_utils
 from osism.tasks import netbox, openstack
@@ -34,6 +33,100 @@ driver_params = {
 }
 
 
+def _prepare_node_attributes(device, get_ironic_parameters):
+    node_attributes = get_ironic_parameters()
+    if (
+        "ironic_parameters" in device.custom_fields
+        and device.custom_fields["ironic_parameters"]
+    ):
+        deep_merge(node_attributes, device.custom_fields["ironic_parameters"])
+
+    vault = get_vault()
+    deep_decrypt(node_attributes, vault)
+
+    node_secrets = device.custom_fields.get("secrets", {})
+    if node_secrets is None:
+        node_secrets = {}
+    deep_decrypt(node_secrets, vault)
+
+    if (
+        "driver" in node_attributes
+        and node_attributes["driver"] in driver_params.keys()
+    ):
+        if "driver_info" in node_attributes:
+            unused_drivers = [
+                driver
+                for driver in driver_params.keys()
+                if driver != node_attributes["driver"]
+            ]
+            for key in list(node_attributes["driver_info"].keys()):
+                for driver in unused_drivers:
+                    if key.startswith(driver + "_"):
+                        node_attributes["driver_info"].pop(key, None)
+
+            username_key = driver_params[node_attributes["driver"]]["username"]
+            if username_key in node_attributes["driver_info"]:
+                node_attributes["driver_info"][username_key] = (
+                    jinja2.Environment(loader=jinja2.BaseLoader())
+                    .from_string(node_attributes["driver_info"][username_key])
+                    .render(
+                        remote_board_username=str(
+                            node_secrets.get("remote_board_username", "admin")
+                        )
+                    )
+                )
+
+            password_key = driver_params[node_attributes["driver"]]["password"]
+            if password_key in node_attributes["driver_info"]:
+                node_attributes["driver_info"][password_key] = (
+                    jinja2.Environment(loader=jinja2.BaseLoader())
+                    .from_string(node_attributes["driver_info"][password_key])
+                    .render(
+                        remote_board_password=str(
+                            node_secrets.get("remote_board_password", "password")
+                        )
+                    )
+                )
+
+            address_key = driver_params[node_attributes["driver"]]["address"]
+            if address_key in node_attributes["driver_info"]:
+                oob_ip_result = get_device_oob_ip(device)
+                if oob_ip_result:
+                    oob_ip, _ = oob_ip_result
+                    node_attributes["driver_info"][address_key] = (
+                        jinja2.Environment(loader=jinja2.BaseLoader())
+                        .from_string(node_attributes["driver_info"][address_key])
+                        .render(remote_board_address=oob_ip)
+                    )
+    node_attributes.update({"resource_class": device.name})
+    if "extra" not in node_attributes:
+        node_attributes["extra"] = {}
+    if "instance_info" in node_attributes and node_attributes["instance_info"]:
+        node_attributes["extra"].update(
+            {"instance_info": json.dumps(node_attributes["instance_info"])}
+        )
+    if (
+        "netplan_parameters" in device.custom_fields
+        and device.custom_fields["netplan_parameters"]
+    ):
+        node_attributes["extra"].update(
+            {
+                "netplan_parameters": json.dumps(
+                    device.custom_fields["netplan_parameters"]
+                )
+            }
+        )
+    if (
+        "frr_parameters" in device.custom_fields
+        and device.custom_fields["frr_parameters"]
+    ):
+        node_attributes["extra"].update(
+            {"frr_parameters": json.dumps(device.custom_fields["frr_parameters"])}
+        )
+
+    return node_attributes
+
+
 def sync_ironic(request_id, get_ironic_parameters, force_update=False):
     osism_utils.push_task_output(
         request_id,
@@ -79,114 +172,15 @@ def sync_ironic(request_id, get_ironic_parameters, force_update=False):
 
         node_interfaces = list(netbox.get_interfaces_by_device(device.name))
 
-        node_attributes = get_ironic_parameters()
-        if (
-            "ironic_parameters" in device.custom_fields
-            and device.custom_fields["ironic_parameters"]
-        ):
-            # NOTE: Update node attributes with overrides from NetBox device
-            deep_merge(node_attributes, device.custom_fields["ironic_parameters"])
-
-        # NOTE: Decrypt ansible vaulted secrets
-        vault = get_vault()
-        deep_decrypt(node_attributes, vault)
-
-        node_secrets = device.custom_fields.get("secrets", {})
-        if node_secrets is None:
-            node_secrets = {}
-        deep_decrypt(node_secrets, vault)
-
-        if (
-            "driver" in node_attributes
-            and node_attributes["driver"] in driver_params.keys()
-        ):
-            if "driver_info" in node_attributes:
-                # NOTE: Remove all fields belonging to a different driver
-                unused_drivers = [
-                    driver
-                    for driver in driver_params.keys()
-                    if driver != node_attributes["driver"]
-                ]
-                for key in list(node_attributes["driver_info"].keys()):
-                    for driver in unused_drivers:
-                        if key.startswith(driver + "_"):
-                            node_attributes["driver_info"].pop(key, None)
-
-                # NOTE: Render driver username field
-                username_key = driver_params[node_attributes["driver"]]["username"]
-                if username_key in node_attributes["driver_info"]:
-                    node_attributes["driver_info"][username_key] = (
-                        jinja2.Environment(loader=jinja2.BaseLoader())
-                        .from_string(node_attributes["driver_info"][username_key])
-                        .render(
-                            remote_board_username=str(
-                                node_secrets.get("remote_board_username", "admin")
-                            )
-                        )
-                    )
-
-                # NOTE: Render driver password field
-                password_key = driver_params[node_attributes["driver"]]["password"]
-                if password_key in node_attributes["driver_info"]:
-                    node_attributes["driver_info"][password_key] = (
-                        jinja2.Environment(loader=jinja2.BaseLoader())
-                        .from_string(node_attributes["driver_info"][password_key])
-                        .render(
-                            remote_board_password=str(
-                                node_secrets.get("remote_board_password", "password")
-                            )
-                        )
-                    )
-
-                # NOTE: Render driver address field
-                address_key = driver_params[node_attributes["driver"]]["address"]
-                if address_key in node_attributes["driver_info"]:
-                    oob_ip_result = get_device_oob_ip(device)
-                    if oob_ip_result:
-                        oob_ip, _ = (
-                            oob_ip_result  # Extract IP address, ignore prefix length
-                        )
-                        node_attributes["driver_info"][address_key] = (
-                            jinja2.Environment(loader=jinja2.BaseLoader())
-                            .from_string(node_attributes["driver_info"][address_key])
-                            .render(remote_board_address=oob_ip)
-                        )
-        node_attributes.update({"resource_class": device.name})
-        if "extra" not in node_attributes:
-            node_attributes["extra"] = {}
-        # NOTE: Copy instance_info into extra field. because ironic removes it on undeployment. This way it may be readded on undeploy without querying the netbox again
-        if "instance_info" in node_attributes and node_attributes["instance_info"]:
-            node_attributes["extra"].update(
-                {"instance_info": json.dumps(node_attributes["instance_info"])}
-            )
-        # NOTE: Write metadata used for provisioning into 'extra' field, so that it is available during node deploy without querying the netbox again
-        if (
-            "netplan_parameters" in device.custom_fields
-            and device.custom_fields["netplan_parameters"]
-        ):
-            node_attributes["extra"].update(
-                {
-                    "netplan_parameters": json.dumps(
-                        device.custom_fields["netplan_parameters"]
-                    )
-                }
-            )
-        if (
-            "frr_parameters" in device.custom_fields
-            and device.custom_fields["frr_parameters"]
-        ):
-            node_attributes["extra"].update(
-                {"frr_parameters": json.dumps(device.custom_fields["frr_parameters"])}
-            )
+        node_attributes = _prepare_node_attributes(device, get_ironic_parameters)
         ports_attributes = [
             dict(address=interface.mac_address)
             for interface in node_interfaces
             if interface.enabled and not interface.mgmt_only and interface.mac_address
         ]
 
-        lock = Redlock(
+        lock = osism_utils.create_redlock(
             key=f"lock_osism_tasks_conductor_sync_ironic-{device.name}",
-            masters={osism_utils.redis},
             auto_release_time=600,
         )
         if lock.acquire(timeout=120):