.. _workbook-support:

================
Support Workbook
================

:Workbook name: tripleo.support.v1

TripleO support workflows

Workflows in the Support Workbook

.. object:: tripleo.support.v1.collect_logs

   This workflow runs sosreport on the servers where their names match the provided server_name input. The logs are stored in the provided sos_dir.


   Workflow inputs:

   :input server_name: Required.
   :input sos_dir: Default: /var/tmp/tripleo-sos
   :input sos_options: Default: boot,cluster,hardware,kernel,memory,nfs,openstack,packagemanager,performance,services,storage,system,webserver,virt
   :input queue_name: Default: tripleo

.. object:: tripleo.support.v1.create_container

   This work flow is used to check if the container exists and creates it if it does not exist.


   Workflow inputs:

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

.. object:: tripleo.support.v1.delete_container

   This workflow deletes all the objects in a provided swift container and then removes the container itself from the undercloud.


   Workflow inputs:

   :input container: Required.
   :input concurrency: Default: 5
   :input timeout: Default: 900
   :input queue_name: Default: tripleo

.. object:: tripleo.support.v1.fetch_logs

   This workflow creates a container on the undercloud, executes the log collection on the servers whose names match the provided server_name, and executes the log upload process on all the servers to the container on the undercloud.


   Workflow inputs:

   :input server_name: Required.
   :input container: Required.
   :input concurrency: Default: 5
   :input timeout: Default: 1800
   :input queue_name: Default: tripleo

.. object:: tripleo.support.v1.upload_logs

   This workflow uploads the sosreport files stored in the provide sos_dir on the provided host (server_uuid) to a swift container on the undercloud


   Workflow inputs:

   :input server_uuid: Required.
   :input server_name: Required.
   :input container: Required.
   :input sos_dir: Default: /var/tmp/tripleo-sos
   :input queue_name: Default: tripleo