.. _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 timeout: Default: 240
   :input queue_name: Default: tripleo
   :input plan_name: Default: overcloud
   :input work_dir: Default: /var/lib/mistral
   :input verbosity: Default: 1

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

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