.. _workbook-deployment:

===================
Deployment Workbook
===================

:Workbook name: tripleo.deployment.v1

TripleO deployment workflows

Workflows in the Deployment Workbook

.. object:: 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': 0}: Required.
   :input {'blacklist': []}: Required.
   :input {'override_ansible_cfg': ''}: Required.
   :input {'config_download_timeout': 14400}: Required.
   :input {'nodes': []}: Required.
   :input {'playbook_name': 'deploy_steps_playbook.yaml'}: Required.
   :input {'deployment_options': {}}: Required.
   :input {'skip_tags': ''}: Required.

.. object:: 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.

.. object:: 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.

.. object:: tripleo.deployment.v1.createcloudsyaml

   Generates the overcloud clouds.yaml It requires container and queue name as a input.



   Workflow inputs:

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

.. object:: 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.

.. object:: 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.

.. object:: 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.

.. object:: tripleo.deployment.v1.get_deployment_failures

   Get deployment failures



   Workflow inputs:

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

.. object:: 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.

.. object:: 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.

.. object:: 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.

.. object:: 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.

.. object:: 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.

.. object:: tripleo.deployment.v1.undeploy_plan

   Undeploy a plan.



   Workflow inputs:

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