.. _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._check_plan_environment


   Workflow inputs:

   :input container: Required.
   :input queue_name: Required.

.. object:: tripleo.plan_management.v1._copy_object_to_root


   Workflow inputs:

   :input container: Required.
   :input plan_name: Required.
   :input object_name: Required.

.. object:: tripleo.plan_management.v1._validate_networks_from_roles

   Internal workflow for validating a network exists from a role


   Workflow inputs:

   :input {'container': 'overcloud'}: Required.
   :input defined_networks: Required.
   :input networks_in_roles: Required.
   :input {'queue_name': 'tripleo'}: Required.

.. object:: tripleo.plan_management.v1.create_container

   Creates an object container for a given name.  If a container with the same name already exists an error is returned.



   Workflow inputs:

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

.. 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': None}: Required.
   :input {'queue_name': 'tripleo'}: Required.
   :input {'generate_passwords': True}: Required.
   :input {'use_default_templates': False}: Required.
   :input {'validate_stack': True}: Required.

.. object:: tripleo.plan_management.v1.delete_deployment_plan

   Deletes a plan by deleting the container matching plan_name. It will not delete the plan if a stack exists with the same name.



   Workflow inputs:

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

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

   Creates an export tarball for a given plan


   Workflow inputs:

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

.. 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': 'overcloud'}: Required.
   :input {'queue_name': 'tripleo'}: Required.

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

   Retrieves passwords for a given plan


   Workflow inputs:

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

.. object:: tripleo.plan_management.v1.list_available_networks


   Workflow inputs:

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

.. object:: tripleo.plan_management.v1.list_available_roles


   Workflow inputs:

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

.. object:: tripleo.plan_management.v1.list_networks


   Workflow inputs:

   :input {'container': 'overcloud'}: Required.
   :input {'network_data_file': 'network_data.yaml'}: Required.
   :input {'queue_name': 'tripleo'}: Required.

.. object:: tripleo.plan_management.v1.list_plans

   This workflow lists all deployment plans residing in the undercloud.  A deployment plan consists of a container marked with metadata 'x-container-meta-usage-tripleo'.



   Workflow inputs:

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

.. object:: tripleo.plan_management.v1.rotate_passwords

   Rotate passwords for a given plan


   Workflow inputs:

   :input container: Required.
   :input {'queue_name': 'tripleo'}: Required.
   :input {'password_list': []}: Required.

.. object:: tripleo.plan_management.v1.select_sample_plan


   Workflow inputs:

   :input {'container': 'overcloud'}: Required.
   :input {'sample_plan_name': 'openstack'}: Required.
   :input {'queue_name': 'tripleo'}: Required.

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


   Workflow inputs:

   :input container: Required.
   :input {'source_url': None}: Required.
   :input {'queue_name': 'tripleo'}: Required.
   :input {'generate_passwords': True}: Required.
   :input {'plan_environment': None}: Required.
   :input {'validate_stack': True}: Required.

.. object:: tripleo.plan_management.v1.validate_network_files

   Validate network files exist


   Workflow inputs:

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

.. object:: tripleo.plan_management.v1.validate_networks

   Validate network files were generated properly and exist


   Workflow inputs:

   :input {'container': 'overcloud'}: Required.
   :input {'network_data_file': 'network_data.yaml'}: Required.
   :input {'queue_name': 'tripleo'}: Required.

.. object:: tripleo.plan_management.v1.validate_roles

   Vaildate roles data exists and is parsable


   Workflow inputs:

   :input {'container': 'overcloud'}: Required.
   :input {'roles_data_file': 'roles_data.yaml'}: Required.
   :input {'queue_name': 'tripleo'}: Required.

.. object:: tripleo.plan_management.v1.validate_roles_and_networks

   Vaidate that roles and network data are valid


   Workflow inputs:

   :input {'container': 'overcloud'}: Required.
   :input {'roles_data_file': 'roles_data.yaml'}: Required.
   :input {'network_data_file': 'network_data.yaml'}: Required.
   :input {'queue_name': 'tripleo'}: Required.
