.. _workbook-heat_environments:

==========================
Heat environments Workbook
==========================

:Workbook name: tripleo.heat_environments.v1

TripleO Heat Environments Workflows

Workflows in the Heat environments Workbook

.. object:: tripleo.heat_environments.v1.get

   Get list of available heat environments.
   Parses the capabilities_map.yaml file in a given plan and returns a list of environments.
   

   Workflow inputs:

   :input container: Required.
   :input {'queue_name': 'tripleo'}: Required.

.. object:: tripleo.heat_environments.v1.update

   Update plan environment with selected environments.
   Takes a list of environment files and depending on the value of the enabled flag, adds or removes them from the plan environment.
   

   Workflow inputs:

   :input environments: Required.
   :input container: Required.
   :input {'purge_missing': False}: Required.
   :input {'sort_environments': False}: Required.
   :input {'queue_name': 'tripleo'}: Required.
