.. _workbook-baremetal_deploy:

=========================
Baremetal deploy Workbook
=========================

:Workbook name: tripleo.baremetal_deploy.v1

TripleO Baremetal Deployment Workflows

Workflows in the Baremetal deploy Workbook

.. object:: tripleo.baremetal_deploy.v1._deploy_one

   Internal workflow to deploy one node


   Workflow inputs:

   :input instance: Required.
   :input node: Required.
   :input {'ssh_keys': []}: Required.
   :input {'ssh_user_name': 'heat-admin'}: Required.
   :input {'timeout': 3600}: Required.
   :input {'queue_name': 'tripleo'}: Required.

.. object:: tripleo.baremetal_deploy.v1.deploy_instances

   Deploy instances on bare metal nodes.


   Workflow inputs:

   :input instances: Required.
   :input {'ssh_keys': []}: Required.
   :input {'ssh_user_name': 'heat-admin'}: Required.
   :input {'timeout': 3600}: Required.
   :input {'concurrency': 20}: Required.
   :input {'queue_name': 'tripleo'}: Required.

.. object:: tripleo.baremetal_deploy.v1.deploy_roles

   Deploy roles on bare metal nodes.


   Workflow inputs:

   :input roles: Required.
   :input {'plan': 'overcloud'}: Required.
   :input {'ctlplane_network': 'ctlplane'}: Required.
   :input {'ssh_keys': []}: Required.
   :input {'ssh_user_name': 'heat-admin'}: Required.
   :input {'timeout': 3600}: Required.
   :input {'concurrency': 20}: Required.
   :input {'queue_name': 'tripleo'}: Required.

.. object:: tripleo.baremetal_deploy.v1.undeploy_instances

   Undeploy previously deployed instances


   Workflow inputs:

   :input instances: Required.
   :input {'timeout': 3600}: Required.
   :input {'concurrency': 20}: Required.
   :input {'queue_name': 'tripleo'}: Required.

.. object:: tripleo.baremetal_deploy.v1.undeploy_roles

   Undeploy provisioned=False instances in roles.


   Workflow inputs:

   :input roles: Required.
   :input {'plan': 'overcloud'}: Required.
   :input {'timeout': 3600}: Required.
   :input {'concurrency': 20}: Required.
   :input {'queue_name': 'tripleo'}: Required.
