Guide for Custom Recovery Workflow Configuration

If operator wants customized recovery workflow, so here is guidelines mentioned for how to associate custom tasks from Third Party Library along with standard recovery workflows in Masakari.:

  1. First make sure required Third Party Library is installed on the Masakari engine node. Below is the sample custom task file. For example:

from oslo_log import log as logging
from taskflow import task

LOG = logging.getLogger(__name__)


class Noop(task.Task):

    def __init__(self, novaclient):
        self.novaclient = novaclient
        super(Noop, self).__init__()

    def execute(self, **kwargs):
        LOG.info("Custom task executed successfully..!!")
        return

  1. Configure custom task in Third Party Library’s setup.cfg as below:

For example, Third Party Library’s setup.cfg will have following entry points

masakari.task_flow.tasks =
    custom_pre_task = <custom_task_class_path_from_third_party_library>
    custom_main_task = <custom_task_class_path_from_third_party_library>
    custom_post_task = <custom_task_class_path_from_third_party_library>

Note: The entry point in the third-party library’s setup.cfg should use the same key as the masakari.task_flow.tasks table in Masakari’s pyproject.toml for the respective failure recovery.

  1. Configure the custom task in Masakari’s custom-recovery-methods.conf with the same name given in the third-party library’s entry point to locate its class path. For example(custom task added in host auto failure config option):

host_auto_failure_recovery_tasks = {
'pre': ['disable_compute_service_task', 'custom_pre_task'],
'main': ['custom_main_task', 'prepare_HA_enabled_instances_task'],
'post': ['evacuate_instances_task', 'custom_post_task']}

  1. If there are any configuration parameters required for custom task, then add them into custom-recovery-methods.conf under the same group/section where they are registered in Third Party Library. All config parameters related to recovery method customization should be part of newly added conf file. Operator will be responsible to generate masakari.conf and related configuration files by themselves.

  2. Operator should ensure output of each task should be made available to the next tasks needing them.