Plan management Workbook¶

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._get_sample_plan

Workflow inputs:

Input container:
	Default: overcloud
Input plan_file:
	Required.

tripleo.plan_management.v1._validate_networks_from_roles

Internal workflow for validating a network exists from a role

Workflow inputs:

Input container:
	Default: overcloud
Input defined_networks:
	Required.
Input networks_in_roles:
	Required.
Input queue_name:
	Default: tripleo

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:
	Default: overcloud
Input queue_name:
	Default: tripleo

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
Input validate_stack:
	Default: True

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:
	Default: overcloud
Input queue_name:
	Default: tripleo

tripleo.plan_management.v1.download_logs

Creates a tarball with logging data

Workflow inputs:

Input queue_name:
	Default: tripleo
Input logging_container:
	Default: tripleo-ui-logs
Input downloads_container:
	Default: tripleo-ui-logs-downloads
Input delete_after:
	Default: 3600

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

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

tripleo.plan_management.v1.get_passwords

Retrieves passwords for a given plan

Workflow inputs:

Input container:
	Required.
Input queue_name:
	Default: tripleo

tripleo.plan_management.v1.list_available_networks

Workflow inputs:

Input container:
	Required.
Input queue_name:
	Default: tripleo

tripleo.plan_management.v1.list_available_roles

Workflow inputs:

Input container:
	Default: overcloud
Input queue_name:
	Default: tripleo

tripleo.plan_management.v1.list_networks

Workflow inputs:

Input container:
	Default: overcloud
Input network_data_file:
	Default: network_data.yaml
Input queue_name:
	Default: tripleo

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:
	Default: tripleo

tripleo.plan_management.v1.list_roles

Retrieve the roles_data.yaml and return a usable object

Workflow inputs:

Input container:
	Default: overcloud
Input roles_data_file:
	Default: roles_data.yaml
Input queue_name:
	Default: tripleo

tripleo.plan_management.v1.list_sample_plans

Workflow inputs:

Input container:
	Default: overcloud
Input queue_name:
	Default: tripleo

tripleo.plan_management.v1.publish_ui_logs_to_swift

This workflow drains a zaqar queue, and publish its messages into a log file in swift. This workflow is called by cron trigger.

Workflow inputs:

Input logging_queue_name:
	Default: tripleo-ui-logging
Input logging_container:
	Default: tripleo-ui-logs

tripleo.plan_management.v1.rotate_passwords

Rotate passwords for a given plan

Workflow inputs:

Input container:
	Required.
Input queue_name:
	Default: tripleo
Input password_list:
	Default: []

tripleo.plan_management.v1.select_roles

takes a list of role names as input and populates roles_data.yaml in container in Swift with respective roles from ‘roles directory’

Workflow inputs:

Input container:
	Required.
Input role_names:
	Required.
Input roles_data_file:
	Default: roles_data.yaml
Input replace_all:
	Default: True
Input queue_name:
	Default: tripleo

tripleo.plan_management.v1.select_sample_plan

Workflow inputs:

Input container:
	Default: overcloud
Input sample_plan_name:
	Default: openstack
Input queue_name:
	Default: tripleo

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
Input plan_environment:
	Default: None
Input validate_stack:
	Default: True

tripleo.plan_management.v1.update_parameters

Updates plan environment with parameters.

Workflow inputs:

Input container:
	Default: overcloud
Input parameters:
	Required.
Input key:	Required.
Input queue_name:
	Default: tripleo

tripleo.plan_management.v1.update_roles

takes data in json format validates its contents and persists them in roles_data.yaml, after successful update, templates are regenerated.

Workflow inputs:

Input container:
	Required.
Input roles:	Required.
Input roles_data_file:
	Default: roles_data.yaml
Input replace_all:
	Default: False
Input queue_name:
	Default: tripleo

tripleo.plan_management.v1.validate_network_files

Validate network files exist

Workflow inputs:

Input container:
	Default: overcloud
Input network_data:
	Required.
Input queue_name:
	Default: tripleo

tripleo.plan_management.v1.validate_networks

Validate network files were generated properly and exist

Workflow inputs:

Input container:
	Default: overcloud
Input network_data_file:
	Default: network_data.yaml
Input queue_name:
	Default: tripleo

tripleo.plan_management.v1.validate_roles

Vaildate roles data exists and is parsable

Workflow inputs:

Input container:
	Default: overcloud
Input roles_data_file:
	Default: roles_data.yaml
Input queue_name:
	Default: tripleo

tripleo.plan_management.v1.validate_roles_and_networks

Vaidate that roles and network data are valid

Workflow inputs:

Input container:
	Default: overcloud
Input roles_data_file:
	Default: roles_data.yaml
Input network_data_file:
	Default: network_data.yaml
Input queue_name:
	Default: tripleo