.. _workbook-baremetal:

==================
Baremetal Workbook
==================

:Workbook name: tripleo.baremetal.v1

TripleO Baremetal Workflows

Workflows in the Baremetal Workbook

.. object:: tripleo.baremetal.v1._introspect

   An internal workflow. The tripleo.baremetal.v1.introspect workflow should be used for introspection.


   Workflow inputs:

   :input node_uuid: Required.
   :input queue_name: Required.

.. object:: tripleo.baremetal.v1.cellv2_discovery

   Run cell_v2 host discovery

   Workflow inputs:

   :input node_uuids: Required.
   :input queue_name: Default: tripleo

.. object:: tripleo.baremetal.v1.configure

   Take a list of manageable nodes and update their boot configuration.

   Workflow inputs:

   :input node_uuids: Required.
   :input queue_name: Default: tripleo
   :input kernel_name: Default: bm-deploy-kernel
   :input ramdisk_name: Default: bm-deploy-ramdisk
   :input instance_boot_option: Default: None
   :input root_device: Default: None
   :input root_device_minimum_size: Default: 4
   :input overwrite_root_device_hints: Default: False

.. object:: tripleo.baremetal.v1.configure_manageable_nodes

   Update the boot configuration of all nodes in 'manageable' state.

   Workflow inputs:

   :input queue_name: Default: tripleo
   :input kernel_name: Default: bm-deploy-kernel
   :input ramdisk_name: Default: bm-deploy-ramdisk
   :input instance_boot_option: Default: None
   :input root_device: Default: None
   :input root_device_minimum_size: Default: 4
   :input overwrite_root_device_hints: Default: False

.. object:: tripleo.baremetal.v1.create_raid_configuration

   Create and apply RAID configuration for given nodes

   Workflow inputs:

   :input node_uuids: Required.
   :input configuration: Required.
   :input queue_name: Default: tripleo

.. object:: tripleo.baremetal.v1.introspect

   Take a list of nodes and move them through introspection.

   Workflow inputs:

   :input node_uuids: Required.
   :input run_validations: Default: False
   :input queue_name: Default: tripleo
   :input concurrency: Default: 20

.. object:: tripleo.baremetal.v1.introspect_manageable_nodes

   Introspect all nodes in a 'manageable' state.

   Workflow inputs:

   :input run_validations: Default: False
   :input queue_name: Default: tripleo

.. object:: tripleo.baremetal.v1.manage

   Set a list of nodes to 'manageable' state

   Workflow inputs:

   :input node_uuids: Required.
   :input queue_name: Default: tripleo

.. object:: tripleo.baremetal.v1.manual_cleaning

   Workflow inputs:

   :input node_uuid: Required.
   :input clean_steps: Required.
   :input timeout: Default: 7200
   :input retry_delay: Default: 10
   :input retry_count: Default: 720
   :input queue_name: Default: tripleo

.. object:: tripleo.baremetal.v1.nodes_with_profile

   Find nodes with a specific profile

   Workflow inputs:

   :input profile: Required.
   :input queue_name: Default: tripleo

.. object:: tripleo.baremetal.v1.provide

   Take a list of nodes and move them to "available"

   Workflow inputs:

   :input node_uuids: Required.
   :input queue_name: Default: tripleo

.. object:: tripleo.baremetal.v1.provide_manageable_nodes

   Provide all nodes in a 'manageable' state.

   Workflow inputs:

   :input queue_name: Default: tripleo

.. object:: tripleo.baremetal.v1.register_or_update

   Take nodes JSON and create nodes in a "manageable" state

   Workflow inputs:

   :input nodes_json: Required.
   :input remove: Default: False
   :input queue_name: Default: tripleo
   :input kernel_name: Default: None
   :input ramdisk_name: Default: None
   :input instance_boot_option: Default: local
   :input initial_state: Default: manageable

.. object:: tripleo.baremetal.v1.set_node_state

   Workflow inputs:

   :input node_uuid: Required.
   :input state_action: Required.
   :input target_state: Required.

.. object:: tripleo.baremetal.v1.set_power_state

   Workflow inputs:

   :input node_uuid: Required.
   :input state_action: Required.
   :input target_state: Required.

.. object:: tripleo.baremetal.v1.tag_node

   Tag a node with a role

   Workflow inputs:

   :input node_uuid: Required.
   :input role: Default: None
   :input queue_name: Default: tripleo

.. object:: tripleo.baremetal.v1.tag_nodes

   Runs the tag_node workflow in a loop

   Workflow inputs:

   :input tag_node_uuids: Required.
   :input untag_node_uuids: Required.
   :input role: Required.
   :input plan: Default: overcloud
   :input queue_name: Default: tripleo

.. object:: tripleo.baremetal.v1.validate_nodes

   Validate nodes JSON

   Workflow inputs:

   :input nodes_json: Required.
   :input queue_name: Default: tripleo