.. _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': 240}: Required.
   :input {'queue_name': 'tripleo'}: Required.
   :input {'skip_deploy_identifier': False}: Required.

.. 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': 'tripleo'}: Required.

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


   Workflow inputs:

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

.. object:: tripleo.package_update.v1.get_key

   Get private ssh key stored in Mistral


   Workflow inputs:

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

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

   Update the heat stack outputs for purposes of update/upgrade. This workflow assumes that previously the plan_management.update_deployment_plan workflow has already been run to process the templates and environments (the same way as 'deploy' command processes them).


   Workflow inputs:

   :input container: Required.
   :input {'timeout': 240}: Required.
   :input {'queue_name': 'tripleo'}: Required.
   :input {'skip_deploy_identifier': False}: Required.
   :input {'config_dir': '/tmp/'}: Required.

.. 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': 'tripleo'}: Required.

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

   Take a container and perform an update nodes by nodes


   Workflow inputs:

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