Deployment Workbook

Deployment Workbook

Workbook name:tripleo.deployment.v1

TripleO deployment workflows

Workflows in the Deployment Workbook

tripleo.deployment.v1.config_download_deploy

Configure the overcloud with config-download.

Workflow inputs:

Input {‘queue_name’:
 ‘tripleo’}: Required.
Input {‘plan_name’:
 ‘overcloud’}: Required.
Input {‘ssh_network’:
 ‘ctlplane’}: Required.
Input {‘work_dir’:
 ‘/var/lib/mistral’}: Required.
Input {‘verbosity’:
 1}: Required.
Input {‘blacklist’:
 []}: Required.
Input {‘override_ansible_cfg’:
 ‘’}: Required.
Input {‘config_download_timeout’:
 14400}: Required.
Input {‘deployment_options’:
 {}}: Required.
Input {‘skip_tags’:
 ‘’}: Required.
tripleo.deployment.v1.config_download_export

Creates an export tarball and an associated Swift tempurl for config-download for the given plan.

Workflow inputs:

Input plan:Required.
Input {‘queue_name’:
 ‘tripleo’}: Required.
Input {‘config_type’:
 ‘’}: Required.
tripleo.deployment.v1.create_overcloudrc

Given the name of a container and optionally a comma-separated string of hosts that shouldn’t be proxied, generate the overcloudrc files needed to access the overcloud via the CLI.

Workflow inputs:

Input {‘container’:
 ‘overcloud’}: Required.
Input {‘no_proxy’:
 ‘’}: Required.
Input {‘queue_name’:
 ‘tripleo’}: Required.
tripleo.deployment.v1.deploy_on_server

Workflow inputs:

Input server_uuid:
 Required.
Input server_name:
 Required.
Input config:Required.
Input config_name:
 Required.
Input group:Required.
Input {‘queue_name’:
 ‘tripleo’}: Required.
tripleo.deployment.v1.deploy_on_servers

Workflow inputs:

Input server_name:
 Required.
Input config_name:
 Required.
Input config:Required.
Input {‘group’:‘script’}: Required.
Input {‘queue_name’:
 ‘tripleo’}: Required.
tripleo.deployment.v1.deploy_plan

Deploy the overcloud for a plan.

Workflow inputs:

Input container:
 Required.
Input {‘run_validations’:
 False}: Required.
Input {‘timeout’:
 240}: Required.
Input {‘skip_deploy_identifier’:
 False}: Required.
Input {‘queue_name’:
 ‘tripleo’}: Required.
Input {‘config_download’:
 False}: Required.
Input {‘ssh_network’:
 ‘ctlplane’}: Required.
Input {‘deployment_options’:
 {}}: Required.
tripleo.deployment.v1.get_deployment_failures

Get deployment failures

Workflow inputs:

Input {‘plan’:‘overcloud’}: Required.
Input {‘queue_name’:
 ‘tripleo’}: Required.
tripleo.deployment.v1.get_deployment_status

Get deployment status and update it if needed based on stack and config_downlooad status.

Workflow inputs:

Input {‘plan’:‘overcloud’}: Required.
Input {‘queue_name’:
 ‘tripleo’}: Required.
tripleo.deployment.v1.get_horizon_url

Retrieve the Horizon URL from the Overcloud stack.

Workflow inputs:

Input {‘stack’:‘overcloud’}: Required.
Input {‘queue_name’:
 ‘tripleo’}: Required.
tripleo.deployment.v1.recover_deployment_status

Convert an existing deployment into one that supports config-download

Workflow inputs:

Input {‘container’:
 ‘overcloud’}: Required.
Input {‘queue_name’:
 ‘tripleo’}: Required.
tripleo.deployment.v1.set_deployment_status_deploying

Set deployment status to deploying and return the new status

Workflow inputs:

Input {‘plan’:‘overcloud’}: Required.
Input {‘queue_name’:
 ‘tripleo’}: Required.
tripleo.deployment.v1.set_deployment_status_failed

Set deployment status to failed and return the new status

Workflow inputs:

Input {‘plan’:‘overcloud’}: Required.
Input {‘queue_name’:
 ‘tripleo’}: Required.
tripleo.deployment.v1.set_deployment_status_success

Set deployment status to success and return the new status

Workflow inputs:

Input {‘plan’:‘overcloud’}: Required.
Input {‘queue_name’:
 ‘tripleo’}: Required.
tripleo.deployment.v1.undeploy_plan

Undeploy a plan.

Workflow inputs:

Input container:
 Required.
Input {‘timeout’:
 240}: Required.
Input {‘queue_name’:
 ‘tripleo’}: Required.
Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.