diff --git a/ansible/overcloud-hardware-inspect.yml b/ansible/overcloud-hardware-inspect.yml
new file mode 100644
index 0000000000000000000000000000000000000000..d4b93eef90678f36d9f4f04a81cda33391a6f752
--- /dev/null
+++ b/ansible/overcloud-hardware-inspect.yml
@@ -0,0 +1,144 @@
+---
+# Use bifrost to inspect the overcloud nodes' hardware.
+
+- name: Ensure the overcloud controller hardware is inspected
+ hosts: controllers
+ vars:
+ # Set to False to avoid waiting for the controllers to become active.
+ wait_inspected: True
+ wait_inspected_timeout: 600
+ wait_inspected_interval: 10
+ # List of states from which we can get to inspecting.
+ inspectable_states:
+ - enroll
+ - manageable
+ - available
+ - inspect failed
+ # List of valid states while a node is being inspected.
+ inspecting_states:
+ - inspecting
+ # Retries to use when using Ironic API and hitting node locked errors.
+ ironic_retries: 6
+ ironic_retry_interval: 5
+ gather_facts: no
+ tasks:
+ - name: Check the ironic node's initial provision state
+ command: >
+ docker exec bifrost_deploy
+ bash -c '. env-vars &&
+ export OS_URL=$IRONIC_URL &&
+ export OS_TOKEN=$OS_AUTH_TOKEN &&
+ export BIFROST_INVENTORY_SOURCE=ironic &&
+ ansible baremetal
+ --connection local
+ --inventory /etc/bifrost/inventory/
+ -e @/etc/bifrost/bifrost.yml
+ -e @/etc/bifrost/dib.yml
+ --limit {{ inventory_hostname }}
+ -m command
+ -a "openstack baremetal node show {% raw %}{{ inventory_hostname }}{% endraw %} -f value -c provision_state"'
+ register: show_result
+ changed_when: False
+ # We use this convoluted construct to work around Ansible's limitations
+ # in evaluation of the delegate_to keyword.
+ delegate_to: "{{ item }}"
+ with_items:
+ - "{{ hostvars[groups['seed'][0]].ansible_host }}"
+
+ - name: Set a fact containing the ironic node's initial provision state
+ set_fact:
+ initial_provision_state: "{{ show_result.results[0].stdout_lines[1] }}"
+
+ - name: Fail if the ironic node is in an unexpected provision state
+ fail:
+ msg: >
+ Ironic node for {{ inventory_hostname }} is in an unexpected
+ initial provision state: {{ initial_provision_state }}. Expected
+ states are: {{ inspectable_states | join(',') }}.
+ when: "{{ initial_provision_state not in inspectable_states }}"
+
+ - name: Ensure the ironic node is manageable
+ command: >
+ docker exec bifrost_deploy
+ bash -c '. env-vars &&
+ export BIFROST_INVENTORY_SOURCE=ironic &&
+ ansible baremetal -vvvv
+ --connection local
+ --inventory /etc/bifrost/inventory/
+ -e @/etc/bifrost/bifrost.yml
+ -e @/etc/bifrost/dib.yml
+ --limit {{ inventory_hostname }}
+ -m command
+ -a "ironic node-set-provision-state {% raw %}{{ inventory_hostname }}{% endraw %} manage"'
+ register: manage_result
+ until: "{{ manage_result | success or 'is locked by host' in manage_result.stdout }}"
+ retries: "{{ ironic_retries }}"
+ delay: "{{ ironic_retry_interval }}"
+ when: "{{ initial_provision_state != 'manageable' }}"
+ delegate_to: "{{ item }}"
+ with_items:
+ - "{{ hostvars[groups['seed'][0]].ansible_host }}"
+
+ - name: Ensure the ironic node is inspected
+ command: >
+ docker exec bifrost_deploy
+ bash -c '. env-vars &&
+ export BIFROST_INVENTORY_SOURCE=ironic &&
+ ansible baremetal -vvvv
+ --connection local
+ --inventory /etc/bifrost/inventory/
+ -e @/etc/bifrost/bifrost.yml
+ -e @/etc/bifrost/dib.yml
+ --limit {{ inventory_hostname }}
+ -m command
+ -a "ironic node-set-provision-state {% raw %}{{ inventory_hostname }}{% endraw %} inspect"'
+ register: provide_result
+ until: "{{ provide_result | success or 'is locked by host' in provide_result.stdout }}"
+ retries: "{{ ironic_retries }}"
+ delay: "{{ ironic_retry_interval }}"
+ delegate_to: "{{ item }}"
+ with_items:
+ - "{{ hostvars[groups['seed'][0]].ansible_host }}"
+
+ - name: Wait for the ironic node to be inspected
+ command: >
+ docker exec bifrost_deploy
+ bash -c '. env-vars &&
+ export OS_URL=$IRONIC_URL &&
+ export OS_TOKEN=$OS_AUTH_TOKEN &&
+ export BIFROST_INVENTORY_SOURCE=ironic &&
+ ansible baremetal
+ --connection local
+ --inventory /etc/bifrost/inventory/
+ -e @/etc/bifrost/bifrost.yml
+ -e @/etc/bifrost/dib.yml
+ --limit {{ inventory_hostname }}
+ -m command
+ -a "openstack baremetal node show {% raw %}{{ inventory_hostname }}{% endraw %} -f value -c provision_state"'
+ register: show_result
+ # Wait until the node is no longer in one of the inspecting states.
+ until: "{{ not show_result.stdout_lines[1:] | intersect(inspecting_states) }}"
+ retries: "{{ wait_inspected_timeout // wait_inspected_interval }}"
+ delay: "{{ wait_inspected_interval }}"
+ when:
+ - "{{ wait_inspected | bool }}"
+ changed_when: False
+ delegate_to: "{{ item }}"
+ with_items:
+ - "{{ hostvars[groups['seed'][0]].ansible_host }}"
+
+ - name: Set a fact containing the final provision state
+ set_fact:
+ final_provision_state: "{{ show_result.results[0].stdout_lines[1] }}"
+ when:
+ - "{{ wait_inspected | bool }}"
+
+ - name: Fail if any of the controllers are not manageable
+ fail:
+ msg: >
+ Ironic node for {{ inventory_hostname }} is in an unexpected
+ provision state after inspecting. Ironic provision state:
+ {{ final_provision_state }}. Expected: manageable.
+ when:
+ - "{{ wait_inspected | bool }}"
+ - "{{ final_provision_state != 'manageable' }}"
diff --git a/doc/source/usage.rst b/doc/source/usage.rst
index 7b805775322d091d5a189e6b8f3995a014fac253..2442f48391dc86964f0b0fe612ac83d044f353b4 100644
--- a/doc/source/usage.rst
+++ b/doc/source/usage.rst
@@ -299,6 +299,12 @@ RAID::
(kayobe-venv) $ kayobe overcloud bios raid configure
+After configuring the nodes' RAID volumes it may be necessary to perform
+hardware inspection of the nodes to reconfigure the ironic nodes' scheduling
+properties and root device hints. To perform manual hardware inspection::
+
+ (kayobe-venv) $ kayobe overcloud hardware inspect
+
Provisioning
------------
diff --git a/kayobe/cli/commands.py b/kayobe/cli/commands.py
index f7621ea6ffc9d11a7f0cac67c075b26142df8344..394fece4db9f70ab8a205b99349b993357a637f0 100644
--- a/kayobe/cli/commands.py
+++ b/kayobe/cli/commands.py
@@ -302,6 +302,15 @@ class OvercloudBIOSRAIDConfigure(KayobeAnsibleMixin, Command):
self.run_kayobe_playbooks(parsed_args, playbooks)
+class OvercloudHardwareInspect(KayobeAnsibleMixin, Command):
+ """Inspect the overcloud hardware using ironic inspector."""
+
+ def take_action(self, parsed_args):
+ self.app.LOG.debug("Inspecting overcloud")
+ playbooks = _build_playbook_list("overcloud-hardware-inspect")
+ self.run_kayobe_playbooks(parsed_args, playbooks)
+
+
class OvercloudProvision(KayobeAnsibleMixin, Command):
"""Provision the overcloud."""
diff --git a/setup.py b/setup.py
index ffa0051a9b4624d04210d3f9de5756c053ebdcc8..a5c4c2ca4bfad2757728b74981384e09f5c26915 100644
--- a/setup.py
+++ b/setup.py
@@ -44,6 +44,7 @@ setup(
'overcloud_container_image_build = kayobe.cli.commands:OvercloudContainerImageBuild',
'overcloud_container_image_pull = kayobe.cli.commands:OvercloudContainerImagePull',
'overcloud_deprovision = kayobe.cli.commands:OvercloudDeprovision',
+ 'overcloud_hardware_inspect = kayobe.cli.commands:OvercloudHardwareInspect',
'overcloud_host_configure = kayobe.cli.commands:OvercloudHostConfigure',
'overcloud_inventory_discover = kayobe.cli.commands:OvercloudInventoryDiscover',
'overcloud_post_configure = kayobe.cli.commands:OvercloudPostConfigure',