Baremetal Configure Playbook

This playbook replaces the Mistral functionality used by the `openstack
baremetal node configure` CLI command.

A module to support using methods from tripleo-common has been created.

Related-Bug: #1835230
Depends-On: https://review.opendev.org/#/c/691717/
Change-Id: I372aa52928a5aa000b619e6cde72bdbd5b086330
Signed-off-by: Kevin Carter <kecarter@redhat.com>

tripleo_ansible/ansible_plugins/modules/os_tripleo_baremetal_configure.py

@@ -0,0 +1,146 @@
+# All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.openstack import openstack_full_argument_spec
+from ansible.module_utils.openstack import openstack_module_kwargs
+from ansible.module_utils.openstack import openstack_cloud_from_module
+
+
+DOCUMENTATION = """
+---
+module: os_tripleo_baremetal_configure
+short_description: Configure Baremetal nodes
+extends_documentation_fragment: openstack
+author:
+  - "Dougal Matthews (@d0ugal)"
+  - "Kevin Carter (@cloudnull)"
+version_added: "2.10"
+description:
+    - Configure baremetal tripleo node.
+options:
+    action:
+        description:
+        - Run a given action on a baremetal node target.
+        type: str
+        required: true
+        choices:
+        - baremetal_configure_boot
+        - baremetal_configure_root_device
+    args:
+      description:
+      - A set of key=value arguments.
+      type: dict
+      required: true
+
+requirements: ["openstacksdk"]
+"""
+
+EXAMPLES = """
+# Invoke baremetal setup
+- name: configure boot
+  os_tripleo_baremetal_configure:
+    cloud: undercloud
+    action: baremetal_configure_boot
+    args:
+        node_uuid: "6d225f94-b385-4ac1-ab23-7581de425127"
+        kernel_name: "bm-deploy-kernel"
+        ramdisk_name: "bm-deploy-ramdisk"
+
+- name: configure root device
+  os_tripleo_baremetal_configure:
+    cloud: undercloud
+    action: baremetal_configure_root_device
+    args:
+        node_uuid: "6d225f94-b385-4ac1-ab23-7581de425127"
+"""
+
+
+import os
+
+import yaml
+
+# NOTE(cloudnull): This is still using the legacy clients. We've not
+#                  changed to using the OpenStackSDK fully because
+#                  tripleo-common expects the legacy clients. Once
+#                  we've updated tripleo-common to use the SDK we
+#                  should revise this.
+from tripleo_common.actions import baremetal
+from glanceclient import client as glanceclient
+from ironicclient import client as ironicclient
+import ironic_inspector_client
+
+
+class TripleOCommon(object):
+    def __init__(self, session):
+        self.sess = session
+
+    def baremetal_configure_boot(self, kwargs):
+        action = baremetal.ConfigureBootAction(**kwargs)
+        baremetal_client = ironicclient.Client(
+            1,
+            session=self.sess
+        )
+        image_client = glanceclient.Client(2, session=self.sess)
+        return action.configure_boot(
+            baremetal_client,
+            image_client
+        )
+
+    def baremetal_configure_root_device(self, kwargs):
+        action = baremetal.ConfigureRootDeviceAction(**kwargs)
+        baremetal_client = ironicclient.Client(
+            1,
+            session=self.sess
+        )
+        inspector_client = ironic_inspector_client.ClientV1(session=self.sess)
+        if not action.root_device:
+            return
+        else:
+            return action.configure_root_device(
+                baremetal_client,
+                inspector_client
+            )
+
+
+def main():
+    argument_spec = openstack_full_argument_spec(
+        **yaml.safe_load(DOCUMENTATION)['options']
+    )
+    module = AnsibleModule(
+        argument_spec,
+        **openstack_module_kwargs()
+    )
+
+    sdk, _ = openstack_cloud_from_module(module)
+    conn = sdk.connect()
+    tripleo = TripleOCommon(session=conn.session)
+
+    if hasattr(tripleo, module.params["action"]):
+        action = getattr(tripleo, module.params["action"])
+        result = action(
+            kwargs=module.params["args"]
+        )
+        module.exit_json(result=result)
+    else:
+        module.fail_json(
+            msg="Unknown action name {}".format(
+                module.params["action"]
+            )
+        )
+
+
+if __name__ == "__main__":
+    main()

tripleo_ansible/playbooks/cli-baremetal-configure.yaml

@@ -0,0 +1,96 @@
+---
+# Copyright 2019 Red Hat, Inc.
+# All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+- name: Baremetal Configure - set the boot and root devices for ironic nodes
+  connection: "{{ (tripleo_target_host is defined) | ternary('ssh', 'local') }}"
+  hosts: "{{ tripleo_target_host | default('localhost') }}"
+  remote_user: "{{ tripleo_target_user | default(lookup('env', 'USER')) }}"
+  gather_facts: "{{ (tripleo_target_host is defined) | ternary(true, false) }}"
+  any_errors_fatal: true
+  vars:
+    tripleo_undercloud_name: undercloud
+    kernel_name: bm-deploy-kernel
+    ramdisk_name: bm-deploy-ramdisk
+    root_device_minimum_size: 4
+    overwrite_root_device_hints: false
+  pre_tasks:
+    - name: Check for required inputs
+      fail:
+        msg: >
+          `node_uuids` or `all_manageable` are required inputs but
+          currently undefined. Check you inputs and try again.
+      when:
+        - node_uuids is undefined
+        - all_manageable is undefined
+
+    - name: Check for required inputs
+      fail:
+        msg: >
+          The option `all_manageable` is "false" but `node_uuids` is
+          undefined. Check your inputs and try again.
+      when:
+        - node_uuids is undefined
+        - not (all_manageable | bool)
+  tasks:
+    - name: Run all manageable block
+      block:
+        # Get Node UUIDs, if "all_manageable" is True
+        - name: Get node UUIDS
+          command: >
+            openstack baremetal node list --provision-state=manageable -c UUID -f value
+          register: command_output
+          changed_when: false
+
+        - name: Set node_uuids fact
+          set_fact:
+            node_uuids: "{{ command_output.stdout_lines }}"
+      when:
+        - all_manageable | bool
+        - node_uuids is undefined
+
+    - name: exit if nothing to do
+      block:
+        - name: Notice
+          debug:
+            msg: No nodes are manageable at this time.
+
+        - name: end play
+          meta: end_play
+      when:
+        - (node_uuids | length) < 1
+
+    # Configure Nodes
+    - name: Configure node boot
+      os_tripleo_baremetal_configure:
+        cloud: "{{ tripleo_undercloud_name }}"
+        action: baremetal_configure_boot
+        args:
+          node_uuid: "{{ item }}"
+          kernel_name: "{{ kernel_name }}"
+          ramdisk_name: "{{ ramdisk_name }}"
+          instance_boot_option: "{{ instance_boot_option | default(omit) }}"
+      loop: "{{ node_uuids }}"
+
+    - name: Configure root device
+      os_tripleo_baremetal_configure:
+        cloud: "{{ tripleo_undercloud_name }}"
+        action: baremetal_configure_root_device
+        args:
+          node_uuid: "{{ item }}"
+          root_device: "{{ root_device | default(omit) }}"
+          minimum_size: "{{ root_device_minimum_size }}"
+          overwrite: "{{ overwrite_root_device_hints }}"
+      loop: "{{ node_uuids }}"