Baremetal Workbook

Baremetal Workbook

Workbook name:tripleo.baremetal.v1

TripleO Baremetal Workflows

Workflows in the Baremetal Workbook

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 timeout:Required.
Input queue_name:
 Required.
tripleo.baremetal.v1.apply_bios_settings

Apply BIOS settings for given nodes

Workflow inputs:

Input node_uuids:
 Required.
Input settings:Required.
Input {‘queue_name’:
 ‘tripleo’}: Required.
tripleo.baremetal.v1.apply_bios_settings_on_manageable_nodes

Apply BIOS settings on manageable nodes

Workflow inputs:

Input settings:Required.
Input {‘concurrency’:
 20}: Required.
Input {‘queue_name’:
 ‘tripleo’}: Required.
tripleo.baremetal.v1.cellv2_discovery

Run cell_v2 host discovery

Workflow inputs:

Input node_uuids:
 Required.
tripleo.baremetal.v1.clean_manageable_nodes

Clean all nodes in a ‘manageable’ state.

Workflow inputs:

Input {‘concurrency’:
 20}: Required.
Input {‘queue_name’:
 ‘tripleo’}: Required.
tripleo.baremetal.v1.clean_nodes

Wipe partition tables on all disks of given nodes

Workflow inputs:

Input node_uuids:
 Required.
Input {‘concurrency’:
 20}: Required.
Input {‘queue_name’:
 ‘tripleo’}: Required.
tripleo.baremetal.v1.configure

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

Workflow inputs:

Input node_uuids:
 Required.
Input {‘queue_name’:
 ‘tripleo’}: Required.
Input {‘kernel_name’:
 ‘bm-deploy-kernel’}: Required.
Input {‘ramdisk_name’:
 ‘bm-deploy-ramdisk’}: Required.
Input {‘instance_boot_option’:
 None}: Required.
Input {‘root_device’:
 None}: Required.
Input {‘root_device_minimum_size’:
 4}: Required.
Input {‘overwrite_root_device_hints’:
 False}: Required.
tripleo.baremetal.v1.configure_manageable_nodes

Update the boot configuration of all nodes in ‘manageable’ state.

Workflow inputs:

Input {‘queue_name’:
 ‘tripleo’}: Required.
Input {‘kernel_name’:
 ‘bm-deploy-kernel’}: Required.
Input {‘ramdisk_name’:
 ‘bm-deploy-ramdisk’}: Required.
Input {‘instance_boot_option’:
 None}: Required.
Input {‘root_device’:
 None}: Required.
Input {‘root_device_minimum_size’:
 4}: Required.
Input {‘overwrite_root_device_hints’:
 False}: Required.
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’:
 ‘tripleo’}: Required.
tripleo.baremetal.v1.discover_and_enroll_nodes

Run nodes discovery over the given IP range and enroll nodes

Workflow inputs:

Input ip_addresses:
 Required.
Input credentials:
 Required.
Input {‘ports’:[623]}: Required.
Input {‘kernel_name’:
 None}: Required.
Input {‘ramdisk_name’:
 None}: Required.
Input {‘instance_boot_option’:
 None}: Required.
Input {‘initial_state’:
 ‘manageable’}: Required.
Input {‘queue_name’:
 ‘tripleo’}: Required.
tripleo.baremetal.v1.discover_nodes

Run nodes discovery over the given IP range

Workflow inputs:

Input ip_addresses:
 Required.
Input credentials:
 Required.
Input {‘ports’:[623]}: Required.
Input {‘queue_name’:
 ‘tripleo’}: Required.
tripleo.baremetal.v1.introspect

Take a list of nodes and move them through introspection. By default each node will attempt introspection up to 3 times (two retries plus the initial attemp) if it fails. This behaviour can be modified by changing the max_retry_attempts input. The workflow will assume the node has timed out after 20 minutes (1200 seconds). This can be changed by passing the node_timeout input in seconds.

Workflow inputs:

Input node_uuids:
 Required.
Input {‘run_validations’:
 False}: Required.
Input {‘queue_name’:
 ‘tripleo’}: Required.
Input {‘concurrency’:
 20}: Required.
Input {‘max_retry_attempts’:
 2}: Required.
Input {‘node_timeout’:
 1200}: Required.
tripleo.baremetal.v1.introspect_manageable_nodes

Introspect all nodes in a ‘manageable’ state.

Workflow inputs:

Input {‘run_validations’:
 False}: Required.
Input {‘queue_name’:
 ‘tripleo’}: Required.
Input {‘concurrency’:
 20}: Required.
tripleo.baremetal.v1.manage

Set a list of nodes to ‘manageable’ state

Workflow inputs:

Input node_uuids:
 Required.
Input {‘queue_name’:
 ‘tripleo’}: Required.
tripleo.baremetal.v1.manual_cleaning

Workflow inputs:

Input node_uuid:
 Required.
Input clean_steps:
 Required.
Input {‘timeout’:
 7200}: Required.
Input {‘retry_delay’:
 10}: Required.
Input {‘retry_count’:
 720}: Required.
Input {‘queue_name’:
 ‘tripleo’}: Required.
tripleo.baremetal.v1.nodes_with_hint

Find nodes matching a hint regex

Workflow inputs:

Input hint_regex:
 Required.
Input {‘queue_name’:
 ‘tripleo’}: Required.
tripleo.baremetal.v1.nodes_with_profile

Find nodes with a specific profile

Workflow inputs:

Input profile:Required.
Input {‘queue_name’:
 ‘tripleo’}: Required.
tripleo.baremetal.v1.provide

Take a list of nodes and move them to “available”

Workflow inputs:

Input node_uuids:
 Required.
Input {‘queue_name’:
 ‘tripleo’}: Required.
tripleo.baremetal.v1.provide_manageable_nodes

Provide all nodes in a ‘manageable’ state.

Workflow inputs:

Input {‘queue_name’:
 ‘tripleo’}: Required.
tripleo.baremetal.v1.register_or_update

Take nodes JSON and create nodes in a “manageable” state

Workflow inputs:

Input nodes_json:
 Required.
Input {‘remove’:
 False}: Required.
Input {‘queue_name’:
 ‘tripleo’}: Required.
Input {‘kernel_name’:
 None}: Required.
Input {‘ramdisk_name’:
 None}: Required.
Input {‘instance_boot_option’:
 None}: Required.
Input {‘initial_state’:
 ‘manageable’}: Required.
tripleo.baremetal.v1.reset_bios_settings

Reset BIOS settings for given nodes to factory default

Workflow inputs:

Input node_uuids:
 Required.
Input {‘queue_name’:
 ‘tripleo’}: Required.
tripleo.baremetal.v1.reset_bios_settings_on_manageable_nodes

Reset BIOS settings on manageable nodes to factory default

Workflow inputs:

Input {‘concurrency’:
 20}: Required.
Input {‘queue_name’:
 ‘tripleo’}: Required.
tripleo.baremetal.v1.set_node_state

Workflow inputs:

Input node_uuid:
 Required.
Input state_action:
 Required.
Input target_state:
 Required.
Input {‘error_states’:
 [‘error’, ‘adopt failed’, ‘clean failed’, ‘deploy failed’, ‘inspect failed’, ‘rescue failed’]}: Required.
tripleo.baremetal.v1.set_power_state

Workflow inputs:

Input node_uuid:
 Required.
Input state_action:
 Required.
Input target_state:
 Required.
Input {‘error_state’:
 ‘error’}: Required.
tripleo.baremetal.v1.tag_node

Tag a node with a role

Workflow inputs:

Input node_uuid:
 Required.
Input {‘role’:None}: Required.
Input {‘queue_name’:
 ‘tripleo’}: Required.
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’:‘overcloud’}: Required.
Input {‘queue_name’:
 ‘tripleo’}: Required.
tripleo.baremetal.v1.validate_nodes

Validate nodes JSON

Workflow inputs:

Input nodes_json:
 Required.
Input {‘queue_name’:
 ‘tripleo’}: Required.
Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.