.. _workbook-plan_management:

========================
Plan management Workbook
========================

:Workbook name: tripleo.plan_management.v1

TripleO Overcloud Deployment Workflows v1

Workflows in the Plan management Workbook

.. object:: tripleo.plan_management.v1.create_default_deployment_plan

   This workflow exists to maintain backwards compatibility in pike.  This workflow will likely be removed in queens in favor of create_deployment_plan.


   Workflow inputs:

   :input container: Required.
   :input queue_name: Default: tripleo
   :input generate_passwords: Default: True

.. object:: tripleo.plan_management.v1.create_deployment_plan

   This workflow provides the capability to create a deployment plan using the default heat templates provided in a standard TripleO undercloud deployment, heat templates contained in an external git repository, or a swift container that already contains templates.


   Workflow inputs:

   :input container: Required.
   :input source_url: Default: None
   :input queue_name: Default: tripleo
   :input generate_passwords: Default: True
   :input use_default_templates: Default: False

.. object:: tripleo.plan_management.v1.export_deployment_plan

   Creates an export tarball for a given plan

   Workflow inputs:

   :input plan: Required.
   :input queue_name: Default: tripleo

.. object:: tripleo.plan_management.v1.get_deprecated_parameters

   Gets the list of deprecated parameters in the whole of the plan including nested stack

   Workflow inputs:

   :input container: Default: overcloud
   :input queue_name: Default: tripleo

.. object:: tripleo.plan_management.v1.get_passwords

   Retrieves passwords for a given plan

   Workflow inputs:

   :input container: Required.
   :input queue_name: Default: tripleo

.. object:: tripleo.plan_management.v1.update_deployment_plan

   Workflow inputs:

   :input container: Required.
   :input source_url: Default: None
   :input queue_name: Default: tripleo
   :input generate_passwords: Default: True