How to write a Custom Action

How to write a Custom Action

  1. Write a class inherited from mistral.actions.base.Action
from mistral.actions import base

class RunnerAction(base.Action):
    def __init__(self, param):
        # store the incoming params
        self.param = param

    def run(self):
        # return your results here
        return {'status': 0}
  1. Publish the class in a namespace (in your setup.cfg)
mistral.actions =
    example.runner = my.mistral_plugins.somefile:RunnerAction
  1. Reinstall Mistral if it was installed in system (not in virtualenv).
  2. Run db-sync tool via either
$ tools/ --config-file <path-to-config>


$ mistral-db-manage --config-file <path-to-config> populate
  1. Now you can call the action example.runner
      action: example.runner
        param: avalue_to_pass_in
Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.