Allow osism to update multiple netbox instances (#1300)

Add a parameter to the osism command to allow to specify a list of
secondary netbox instances, which are also to be updated with the ironic
node state.

Part of osism/issues#1246

Signed-off-by: Jan Horstmann <[email protected]>

Author: janhorstmann

osism/settings.py

@@ -39,3 +39,7 @@ def read_secret(secret_name):
     "OSISM_CONDUCTOR_NETBOX_FILTER_LIST",
     "[{'state': 'active', 'tag': ['managed-by-ironic']}]",
 )
+
+NETBOX_SECONDARIES = (
+    os.getenv("NETBOX_SECONDARIES", read_secret("NETBOX_SECONDARIES")) or "[]"
+)

osism/tasks/netbox.py

@@ -21,6 +21,9 @@ def run(self, action, arguments):
     pass
 
 
+# NOTE: While `get_*` tasks only operate on the netbox configured in NETBOX_URL, `set_*` tasks additionally operate on all netbox instances listed in NETBOX_SECONDARIES
+
+
 @app.task(bind=True, name="osism.tasks.netbox.set_maintenance")
 def set_maintenance(self, device_name, state=True):
     """Set the maintenance state for a device in the Netbox."""
@@ -32,14 +35,18 @@ def set_maintenance(self, device_name, state=True):
     )
     if lock.acquire(timeout=20):
         try:
-            logger.info(f"Set maintenance state of device {device_name} = {state}")
-
-            device = utils.nb.dcim.devices.get(name=device_name)
-            if device:
-                device.custom_fields.update({"maintenance": state})
-                device.save()
-            else:
-                logger.error(f"Could not set maintenance for {device_name}")
+            for nb in [utils.nb] + utils.secondary_nb_list:
+                logger.info(
+                    f"Set maintenance state of device {device_name} = {state} on {nb.base_url}"
+                )
+                device = nb.dcim.devices.get(name=device_name)
+                if device:
+                    device.custom_fields.update({"maintenance": state})
+                    device.save()
+                else:
+                    logger.error(
+                        f"Could not set maintenance for {device_name} on {nb.base_url}"
+                    )
         finally:
             lock.release()
     else:
@@ -57,14 +64,19 @@ def set_provision_state(self, device_name, state):
     )
     if lock.acquire(timeout=20):
         try:
-            logger.info(f"Set provision state of device {device_name} = {state}")
-
-            device = utils.nb.dcim.devices.get(name=device_name)
-            if device:
-                device.custom_fields.update({"provision_state": state})
-                device.save()
-            else:
-                logger.error(f"Could not set provision state for {device_name}")
+
+            for nb in [utils.nb] + utils.secondary_nb_list:
+                logger.info(
+                    f"Set provision state of device {device_name} = {state} on {nb.base_url}"
+                )
+                device = nb.dcim.devices.get(name=device_name)
+                if device:
+                    device.custom_fields.update({"provision_state": state})
+                    device.save()
+                else:
+                    logger.error(
+                        f"Could not set provision state for {device_name} on {nb.base_url}"
+                    )
         finally:
             lock.release()
     else:
@@ -82,14 +94,18 @@ def set_power_state(self, device_name, state):
     )
     if lock.acquire(timeout=20):
         try:
-            logger.info(f"Set power state of device {device_name} = {state}")
-
-            device = utils.nb.dcim.devices.get(name=device_name)
-            if device:
-                device.custom_fields.update({"power_state": state})
-                device.save()
-            else:
-                logger.error(f"Could not set power state for {device_name}")
+            for nb in [utils.nb] + utils.secondary_nb_list:
+                logger.info(
+                    f"Set power state of device {device_name} = {state} on {nb.base_url}"
+                )
+                device = nb.dcim.devices.get(name=device_name)
+                if device:
+                    device.custom_fields.update({"power_state": state})
+                    device.save()
+                else:
+                    logger.error(
+                        f"Could not set power state for {device_name} on {nb.base_url}"
+                    )
         finally:
             lock.release()
     else:

osism/utils/__init__.py

@@ -1,13 +1,34 @@
 # SPDX-License-Identifier: Apache-2.0
 
 import keystoneauth1
+from loguru import logger
 import openstack
 import pynetbox
 from redis import Redis
 import urllib3
+import yaml
 
 from osism import settings
 
+
+def get_netbox_connection(netbox_url, netbox_token, ignore_ssl_errors=False):
+    if netbox_url and netbox_token:
+        nb = pynetbox.api(netbox_url, token=netbox_token)
+
+        if ignore_ssl_errors and nb:
+            import requests
+
+            urllib3.disable_warnings()
+            session = requests.Session()
+            session.verify = False
+            nb.http_session = session
+
+    else:
+        nb = None
+
+    return nb
+
+
 redis = Redis(
     host=settings.REDIS_HOST,
     port=settings.REDIS_PORT,
@@ -16,19 +37,53 @@
 )
 redis.ping()
 
-if settings.NETBOX_URL and settings.NETBOX_TOKEN:
-    nb = pynetbox.api(settings.NETBOX_URL, token=settings.NETBOX_TOKEN)
-
-    if settings.IGNORE_SSL_ERRORS and nb:
-        import requests
-
-        urllib3.disable_warnings()
-        session = requests.Session()
-        session.verify = False
-        nb.http_session = session
+nb = get_netbox_connection(
+    settings.NETBOX_URL, settings.NETBOX_TOKEN, settings.IGNORE_SSL_ERRORS
+)
 
-else:
-    nb = None
+try:
+    secondary_nb_settings_list = yaml.safe_load(settings.NETBOX_SECONDARIES)
+    supported_secondary_nb_keys = ["NETBOX_URL", "NETBOX_TOKEN", "IGNORE_SSL_ERRORS"]
+    secondary_nb_list = []
+    if type(secondary_nb_settings_list) is not list:
+        raise TypeError(
+            f"Setting NETBOX_SECONDARIES needs to be an array of mappings containing supported netbox API configuration: {supported_secondary_nb_keys}"
+        )
+    for secondary_nb_settings in secondary_nb_settings_list:
+        if type(secondary_nb_settings) is not dict:
+            raise TypeError(
+                f"Elements in setting NETBOX_SECONDARIES need to be mappings containing supported netbox API configuration: {supported_secondary_nb_keys}"
+            )
+        for key in list(secondary_nb_settings.keys()):
+            if key not in supported_secondary_nb_keys:
+                raise ValueError(
+                    f"Unknown key in element of setting NETBOX_SECONDARIES. Supported keys: {supported_secondary_nb_keys}"
+                )
+        if (
+            "NETBOX_URL" not in secondary_nb_settings
+            or not secondary_nb_settings["NETBOX_URL"]
+        ):
+            raise ValueError(
+                "All NETBOX_URL values in the elements of setting NETBOX_SECONDARIES need to be valid netbox URLs"
+            )
+        if (
+            "NETBOX_TOKEN" not in secondary_nb_settings
+            or not secondary_nb_settings["NETBOX_TOKEN"]
+        ):
+            raise ValueError(
+                "All NETBOX_TOKEN values in the elements of setting NETBOX_SECONDARIES need to be valid netbox tokens"
+            )
+
+        secondary_nb_list.append(
+            get_netbox_connection(
+                secondary_nb_settings["NETBOX_URL"],
+                secondary_nb_settings["NETBOX_TOKEN"],
+                secondary_nb_settings.get("IGNORE_SSL_ERRORS", True),
+            )
+        )
+except (yaml.YAMLError, TypeError, ValueError) as exc:
+    logger.error(f"Error parsing settings NETBOX_SECONDARIES: {exc}")
+    secondary_nb_list = []
 
 
 def get_openstack_connection():