Merge pull request #1632 from rackerlabs/PUC-1454

feat: PU-1454: Add method to grab current RAID controller/disk in enroll process.

Author: stevekeay

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

@@ -0,0 +1,81 @@
+import argparse
+import json
+import logging
+import logging.config
+import os
+
+from sushy import Sushy
+
+from understack_workflows.bmc import bmc_for_ip_address
+from understack_workflows.helpers import setup_logger
+
+logger = setup_logger(__name__)
+
+log_config = {
+    "version": 1,
+    "disable_existing_loggers": False,
+    "loggers": {
+        "__main__": {"level": "INFO"},
+        "sushy.main": {"level": "INFO"},
+        "sushy.resources.base": {"level": "INFO"},
+        "sushy.connector": {"level": "INFO"},
+        "urllib3.connectionpool": {"level": "INFO"},
+    },
+}
+
+logging.config.dictConfig(log_config)
+
+
+def main():
+    """Export RAID details for a BMC using Sushy.
+
+    - connect to the BMC using standard password
+
+    -  Using Sushy, gather controller details:
+       - controller name
+       - list of drive references for raid configuration.
+
+    - output json object response.
+    """
+    args = argument_parser().parse_args()
+
+    ip_address = args.ip_address
+    password = args.password or None
+    logger.debug("%s starting for ip_address=%s", __file__, ip_address)
+
+    bmc = bmc_for_ip_address(ip_address=ip_address, password=password)
+    client = bmc.sushy()
+
+    # argo workflows captures stdout as the results which we can use
+    # to return the device UUID
+    print(json.dumps(parse_controller_details(client)))
+
+
+def argument_parser():
+    """Parse runtime arguments."""
+    parser = argparse.ArgumentParser(
+        prog=os.path.basename(__file__), description="Gather RAID Device info."
+    )
+    parser.add_argument("--ip-address", type=str, required=True, help="BMC IP")
+    parser.add_argument(
+        "--password", type=str, required=False, help="Custom Password", default=None
+    )
+    return parser
+
+
+def parse_controller_details(client: Sushy) -> dict:
+    """Parse available RAID controller details for execution."""
+    result = {"controller": None, "physical_disks": []}
+    system_objects = client.get_system_collection().get_members()
+    system = system_objects[0]
+    for c in system.storage.get_members():
+        if "RAID" in c.identity:
+            result["controller"] = c.identity
+            for d in c.drives:
+                result["physical_disks"].append(d.identity)
+            break
+    return result
+
+
+if __name__ == "__main__":
+    main()

workflows/argo-events/workflowtemplates/enroll-server.yaml

@@ -15,6 +15,8 @@ spec:
       - name: ip_address
       - name: firmware_update
         value: "false"
+      - name: raid_configure
+        value: "true"
   templates:
     - name: main
       steps:
@@ -35,12 +37,20 @@ spec:
                 - name: device_id
                   value: "{{steps.enroll-server.outputs.result}}"
             when: "{{steps.server-enroll-state.outputs.result}} == enroll"
+        - - name: get-raid-config
+            template: get-raid-config
+            when: "{{workflow.parameters.raid_configure}} == true"
         - - name: openstack-set-baremetal-node-raid-config
             template: openstack-set-baremetal-node-raid-config
             arguments:
               parameters:
                 - name: device_id
                   value: "{{steps.enroll-server.outputs.result}}"
+                - name: controller_id
+                  value: "{{=jsonpath(steps.['get-raid-config'].outputs.result, $.controller)}}"
+                - name: physical_disks
+                  value: "{{=jsonpath(steps.['get-raid-config'].outputs.result, $.physical_disks)}}"
+            when: "{{workflow.parameters.raid_configure}} == true"
         - - name: server-manage-state
             template: openstack-state-cmd
             arguments:
@@ -135,10 +145,44 @@ spec:
             items:
               - key: clouds.yaml
                 path: clouds.yaml
+    - name: get-raid-config
+      container:
+        image: ghcr.io/rackerlabs/understack/ironic-nautobot-client:latest
+        command:
+          - get-raid-devices
+        args:
+          - --ip-address
+          - "{{workflow.parameters.ip_address}}"
+        volumeMounts:
+          - mountPath: /etc/openstack
+            name: baremetal-manage
+            readOnly: true
+          - mountPath: /etc/bmc_master/
+            name: bmc-master
+            readOnly: true
+        env:
+        - name: WF_NS
+          value: "{{workflow.namespace}}"
+        - name: WF_NAME
+          value: "{{workflow.name}}"
+        - name: WF_UID
+          value: "{{workflow.uid}}"
+      volumes:
+        - name: bmc-master
+          secret:
+            secretName: bmc-master
+        - name: baremetal-manage
+          secret:
+            secretName: baremetal-manage
+            items:
+              - key: clouds.yaml
+                path: clouds.yaml
     - name: openstack-set-baremetal-node-raid-config
       inputs:
         parameters:
           - name: device_id
+          - name: controller_id
+          - name: physical_disks
       # https://rackerlabs.github.io/understack/user-guide/openstack-ironic/#setting-baremetal-node-flavor
       script:
         image: ghcr.io/rackerlabs/understack/openstack-client:2025.2
@@ -149,12 +193,9 @@ spec:
           # than passing a big json string on command line
           cat <<'EOF' >> raid1-config.json
           { "logical_disks":
-            [ { "controller": "RAID.SL.1-1",
+            [ { "controller": {{ inputs.parameters.controller_id }},
                 "is_root_volume": true,
-                "physical_disks": [
-                    "Disk.Bay.0:Enclosure.Internal.0-1:RAID.SL.1-1",
-                    "Disk.Bay.1:Enclosure.Internal.0-1:RAID.SL.1-1"
-                ],
+                "physical_disks": {{ inputs.parameters.physical_disks }},
                 "raid_level": "1",
                 "size_gb": "MAX"
               }