.. _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: Default: tripleo
   :input plan_name: Default: overcloud
   :input ssh_network: Default: ctlplane
   :input work_dir: Default: /var/lib/mistral
   :input verbosity: Default: 1
   :input blacklist: Default: []
   :input override_ansible_cfg: Default: 
   :input config_download_timeout: Default: 14400

.. 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: Default: tripleo
   :input config_type: Default: 

.. 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: Default: overcloud
   :input no_proxy: Default: 
   :input queue_name: Default: tripleo

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

.. object:: tripleo.deployment.v1.deploy_on_servers


   Workflow inputs:

   :input server_name: Required.
   :input config_name: Required.
   :input config: Required.
   :input group: Default: script
   :input queue_name: Default: tripleo

.. object:: tripleo.deployment.v1.deploy_plan

   Deploy the overcloud for a plan.



   Workflow inputs:

   :input container: Required.
   :input run_validations: Default: False
   :input timeout: Default: 240
   :input skip_deploy_identifier: Default: False
   :input queue_name: Default: tripleo
   :input config_download: Default: False
   :input ssh_network: Default: ctlplane
   :input deployment_options: Default: {}

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

   Get deployment failures



   Workflow inputs:

   :input plan: Default: overcloud
   :input queue_name: Default: tripleo

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

.. object:: tripleo.deployment.v1.get_horizon_url

   Retrieve the Horizon URL from the Overcloud stack.



   Workflow inputs:

   :input stack: Default: overcloud
   :input queue_name: Default: tripleo

.. object:: tripleo.deployment.v1.recover_deployment_status

   Convert an existing deployment into one that supports config-download



   Workflow inputs:

   :input container: Default: overcloud
   :input queue_name: Default: tripleo

.. object:: tripleo.deployment.v1.set_deployment_status_deploying

   Set deployment status to deploying and return the new status



   Workflow inputs:

   :input plan: Default: overcloud
   :input queue_name: Default: tripleo

.. object:: tripleo.deployment.v1.set_deployment_status_failed

   Set deployment status to failed and return the new status



   Workflow inputs:

   :input plan: Default: overcloud
   :input queue_name: Default: tripleo

.. object:: tripleo.deployment.v1.set_deployment_status_success

   Set deployment status to success and return the new status



   Workflow inputs:

   :input plan: Default: overcloud
   :input queue_name: Default: tripleo

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

   Undeploy a plan.



   Workflow inputs:

   :input container: Required.
   :input timeout: Default: 240
   :input queue_name: Default: tripleo
