.. _workbook-derive_params:

======================
Derive params Workbook
======================

:Workbook name: tripleo.derive_params.v1

TripleO Workflows to derive deployment parameters from the introspected data

Workflows in the Derive params Workbook

.. object:: tripleo.derive_params.v1._derive_parameters_per_role

   Workflow which runs per role to get the introspection data on the first matching node assigned to role. Once introspection data is fetched, this worklow will trigger the actual derive parameters workflow



   Workflow inputs:

   :input plan: Required.
   :input role_name: Required.
   :input environment_parameters: Required.
   :input heat_resource_tree: Required.
   :input user_inputs: Required.

.. object:: tripleo.derive_params.v1._get_role_info

   Workflow that determines the list of derived parameter features (DPDK, HCI, etc.) for a role based on the services assigned to the role.



   Workflow inputs:

   :input role_name: Required.
   :input heat_resource_tree: Required.

.. object:: tripleo.derive_params.v1.derive_parameters

   The main workflow for deriving parameters from the introspected data


   Workflow inputs:

   :input {'plan': 'overcloud'}: Required.
   :input {'queue_name': 'tripleo'}: Required.
   :input {'persist_params_in_plan': True}: Required.
   :input {'user_inputs': {}}: Required.

.. object:: tripleo.derive_params.v1.get_flattened_parameters

   Workflow to retreive a list of flattened parameters


   Workflow inputs:

   :input {'plan': 'overcloud'}: Required.
   :input {'queue_name': 'tripleo'}: Required.
