Plan management Workbook

Workbook name

tripleo.plan_management.v1

TripleO Overcloud Deployment Workflows v1

Workflows in the Plan management Workbook

tripleo.plan_management.v1._check_plan_environment

Workflow inputs:

Input container

Required.

Input queue_name

Required.

tripleo.plan_management.v1._copy_object_to_root

Workflow inputs:

Input container

Required.

Input plan_name

Required.

Input object_name

Required.

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.

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.

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.

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.

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.

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.

tripleo.plan_management.v1.get_passwords

Retrieves passwords for a given plan

Workflow inputs:

Input container

Required.

Input {‘queue_name’

‘tripleo’}: Required.

tripleo.plan_management.v1.list_available_networks

Workflow inputs:

Input container

Required.

Input {‘queue_name’

‘tripleo’}: Required.

tripleo.plan_management.v1.list_available_roles

Workflow inputs:

Input {‘container’

‘overcloud’}: Required.

Input {‘queue_name’

‘tripleo’}: Required.

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.

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.

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.

tripleo.plan_management.v1.select_sample_plan

Workflow inputs:

Input {‘container’

‘overcloud’}: Required.

Input {‘sample_plan_name’

‘openstack’}: Required.

Input {‘queue_name’

‘tripleo’}: Required.

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.

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.

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.

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.

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.