Merge pull request #318 from rackerlabs/workflow-auth

feat: utilize clouds.yaml for authentication in workflows

Author: cardoe

python/understack-workflows/understack_workflows/create_node.py

@@ -1,54 +1,21 @@
-from ironicclient import client as iclient
-from keystoneauth1 import session
-from keystoneauth1.identity import v3
+from understack_workflows.openstack.client import get_ironic_client
 
 
 class IronicClient:
     def __init__(
         self,
-        svc_url: str,
-        username: str,
-        password: str,
-        auth_url: str,
-        tenant_name: str,
     ) -> None:
         """Initialize our ironicclient wrapper."""
-        self.svc_url = svc_url
-        self.username = username
-        self.password = password
-        self.auth_url = auth_url
-        self.tenant_name = tenant_name
         self.logged_in = False
-        self.os_ironic_api_version = "1.82"
 
     def login(self):
-        auth = v3.Password(
-            auth_url=self.auth_url,
-            username=self.username,
-            password=self.password,
-            project_name=self.tenant_name,
-            project_domain_name="Default",
-            user_domain_name="Default",
-        )
-        insecure_ssl = True
-        sess = session.Session(
-            auth=auth, verify=(not insecure_ssl), app_name="nautobot"
-        )
-        self.client = iclient.Client(
-            1,
-            endpoint_override=self.svc_url,
-            session=sess,
-            insecure=insecure_ssl,
-        )
-        self.client.negotiate_api_version()
+        self.client = get_ironic_client()
         self.logged_in = True
 
     def create_node(self, node_data: dict):
         self._ensure_logged_in()
 
-        return self.client.node.create(
-            os_ironic_api_version=self.os_ironic_api_version, **node_data
-        )
+        return self.client.node.create(**node_data)
 
     def list_nodes(self):
         self._ensure_logged_in()
@@ -59,35 +26,36 @@ def get_node(self, node_ident: str, fields: list[str] | None = None):
         self._ensure_logged_in()
 
         return self.client.node.get(
-            node_ident, fields, os_ironic_api_version=self.os_ironic_api_version
+            node_ident,
+            fields,
         )
 
     def update_node(self, node_id, patch):
         self._ensure_logged_in()
 
         return self.client.node.update(
-            node_id, patch, os_ironic_api_version=self.os_ironic_api_version
+            node_id,
+            patch,
         )
 
     def create_port(self, port_data: dict):
         self._ensure_logged_in()
 
-        return self.client.port.create(
-            os_ironic_api_version=self.os_ironic_api_version, **port_data
-        )
+        return self.client.port.create(**port_data)
 
     def update_port(self, port_id: str, patch: list):
         self._ensure_logged_in()
 
         return self.client.port.update(
-            port_id, patch, os_ironic_api_version=self.os_ironic_api_version
+            port_id,
+            patch,
         )
 
     def delete_port(self, port_id: str):
         self._ensure_logged_in()
 
         return self.client.port.delete(
-            port_id, os_ironic_api_version=self.os_ironic_api_version
+            port_id,
         )
 
     def list_ports(self, node_id: dict):

python/understack-workflows/understack_workflows/ironic/client.py

@@ -85,13 +85,7 @@ def main():
     nautobot_ports = get_nautobot_interfaces(nautobot, device_id)
 
     # get Ironic Ports
-    client = IronicClient(
-        svc_url=os.environ["IRONIC_SVC_URL"],
-        username=os.environ["IRONIC_USERNAME"],
-        password=os.environ["IRONIC_PASSWORD"],
-        auth_url=os.environ["IRONIC_AUTH_URL"],
-        tenant_name=os.environ["IRONIC_TENANT"],
-    )
+    client = IronicClient()
 
     logger.info("Fetching Ironic Ports ...")
     ironic_ports = client.list_ports(device_id)

python/understack-workflows/understack_workflows/ironic/secrets.py

@@ -3,15 +3,14 @@
 import uuid
 from enum import StrEnum
 
-import openstack
-from openstack.connection import Connection
-
 from understack_workflows.domain import DefaultDomain
 from understack_workflows.domain import domain_id
 from understack_workflows.helpers import credential
 from understack_workflows.helpers import parser_nautobot_args
 from understack_workflows.helpers import setup_logger
 from understack_workflows.nautobot import Nautobot
+from understack_workflows.openstack.client import Connection
+from understack_workflows.openstack.client import get_openstack_client
 
 logger = setup_logger(__name__, level=logging.INFO)
 
@@ -123,7 +122,7 @@ def do_action(
 def main():
     args = argument_parser().parse_args()
 
-    conn = openstack.connect(cloud=args.os_cloud)
+    conn = get_openstack_client(cloud=args.os_cloud)
     nb_token = args.nautobot_token or credential("nb-token", "token")
     nautobot = Nautobot(args.nautobot_url, nb_token, logger=logger)
 

python/understack-workflows/understack_workflows/main/sync_interfaces.py

@@ -7,7 +7,6 @@
 from understack_workflows.helpers import credential
 from understack_workflows.helpers import setup_logger
 from understack_workflows.ironic.client import IronicClient
-from understack_workflows.ironic.secrets import read_secret
 from understack_workflows.node_configuration import IronicNodeConfiguration
 
 logger = setup_logger(__name__)
@@ -20,13 +19,7 @@ def main():
         )
 
     logger.info("Pushing device new node to Ironic.")
-    client = IronicClient(
-        svc_url=read_secret("IRONIC_SVC_URL"),
-        username=read_secret("IRONIC_USERNAME"),
-        password=read_secret("IRONIC_PASSWORD"),
-        auth_url=read_secret("IRONIC_AUTH_URL"),
-        tenant_name=read_secret("IRONIC_TENANT"),
-    )
+    client = IronicClient()
 
     interface_update_event = json.loads(sys.argv[1])
     logger.debug(f"Received: {interface_update_event}")

python/understack-workflows/understack_workflows/main/sync_keystone.py

@@ -6,7 +6,6 @@
 
 from understack_workflows.helpers import setup_logger
 from understack_workflows.ironic.client import IronicClient
-from understack_workflows.ironic.secrets import read_secret
 from understack_workflows.node_configuration import IronicNodeConfiguration
 
 logger = setup_logger(__name__)
@@ -26,16 +25,6 @@ def get_args():
     return json.loads(sys.argv[1])
 
 
-def get_ironic_client():
-    return IronicClient(
-        svc_url=read_secret("IRONIC_SVC_URL"),
-        username=read_secret("IRONIC_USERNAME"),
-        password=read_secret("IRONIC_PASSWORD"),
-        auth_url=read_secret("IRONIC_AUTH_URL"),
-        tenant_name=read_secret("IRONIC_TENANT"),
-    )
-
-
 def get_ironic_node(node, ironic_client):
     logger.debug(f"Checking if node UUID {node.uuid} exists in Ironic.")
 
@@ -82,7 +71,7 @@ def main():
     update_data = interface_update_event["data"]
 
     logger.info("Pushing device new node to Ironic.")
-    ironic_client = get_ironic_client()
+    ironic_client = IronicClient()
 
     node = IronicNodeConfiguration.from_event(interface_update_event)
     ironic_node = get_ironic_node(node, ironic_client)

python/understack-workflows/understack_workflows/main/sync_obm_creds.py

@@ -0,0 +1,56 @@
+"""helper to setup OpenStack clients."""
+
+# attempt to prevent re-export
+import os as _os
+import sys as _sys
+from importlib import metadata as _meta
+
+from ironicclient.client import Client as IronicClient
+from ironicclient.client import get_client as _get_ironic_client
+from openstack import config as _os_config
+from openstack.connection import Connection
+
+try:
+    _pkg_ver = _meta.version(__package__.split(".")[0])
+except Exception:
+    _pkg_ver = "dev"
+
+try:
+    _prog_name = _os.path.basename(_sys.argv[0]) or "local"
+except Exception:
+    _prog_name = "local"
+
+
+def _get_os_cloud_region(cloud=None, region_name=""):
+    """Returns a keystoneauth1 Session based on our clouds.yaml."""
+    return _os_config.get_cloud_region(
+        load_yaml_config=True,
+        load_envvars=True,
+        app_name=_prog_name,
+        app_version=_pkg_ver,
+        cloud=cloud,
+        region_name=region_name,
+    )
+
+
+def get_openstack_client(cloud=None, region_name="") -> Connection:
+    """Returns an OpenStackSDK Connection based on our clouds.yaml."""
+    cloud_region = _get_os_cloud_region(cloud, region_name)
+
+    return Connection(config=cloud_region)
+
+
+def get_ironic_client(cloud=None, region_name="") -> IronicClient:
+    """Returns our Ironic Client wrapper configured from our clouds.yaml."""
+    cloud_region = _get_os_cloud_region(cloud, region_name)
+    client = _get_ironic_client(
+        "1", session=cloud_region.get_session(), os_ironic_api_version="latest"
+    )
+    client.negotiate_api_version()
+    return client
+
+
+__all__ = [
+    "get_openstack_client",
+    "get_ironic_client",
+]

python/understack-workflows/understack_workflows/main/sync_server.py

@@ -9,7 +9,6 @@ resources:
   - secrets/obm-creds.yaml
   - secrets/placeholder-obm-creds.yaml
   - secrets/operate-workflow-sa.token.yaml
-  - secrets/production-ironic-for-argo-creds.yaml
   - secrets/nautobot-token.yaml
   - secrets/placeholder-obm-legacy-passwords.yaml
   - sensors/ironic-node-update.yaml