.. _workbook-package_update:

=======================
Package update Workbook
=======================

:Workbook name: tripleo.package_update.v1

TripleO update workflows

Workflows in the Package update Workbook

.. object:: tripleo.package_update.v1.converge_upgrade_plan

   Take a container and perform the converge step of a major upgrade

   Workflow inputs:

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

.. object:: tripleo.package_update.v1.ffwd_upgrade_converge_plan

   ffwd-upgrade converge removes DeploymentSteps no-op from plan

   Workflow inputs:

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

.. object:: tripleo.package_update.v1.get_config

   Workflow inputs:

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

.. object:: tripleo.package_update.v1.package_update_plan

   Take a container and perform a package update with possible breakpoints

   Workflow inputs:

   :input container: Required.
   :input timeout: Default: 240
   :input queue_name: Default: tripleo
   :input skip_deploy_identifier: Default: False
   :input config_dir: Default: /tmp/

.. object:: tripleo.package_update.v1.update_converge_plan

   Take a container and perform the converge for minor update

   Workflow inputs:

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

.. object:: tripleo.package_update.v1.update_nodes

   Take a container and perform an update nodes by nodes

   Workflow inputs:

   :input node_user: Default: tripleo-admin
   :input nodes: Required.
   :input playbook: Required.
   :input inventory_file: Required.
   :input ansible_queue_name: Default: tripleo
   :input module_path: Default: /usr/share/ansible-modules
   :input ansible_extra_env_variables: Default: {'ANSIBLE_HOST_KEY_CHECKING': 'False', 'ANSIBLE_LOG_PATH': '/var/log/mistral/package_update.log'}
   :input verbosity: Default: 1
   :input work_dir: Default: /var/lib/mistral
   :input tags: Default: 
   :input skip_tags: Default: 
