Files

Lars Kellogg-Stedman 1345a6a11d Fix hook documentation on entry_points config

The syntax suggested for adding hooks to nova via setup.py entrypoints is:

    entry_points = {
        'nova.hooks': [
            'resize_hook': your_package.hooks.YourHookClass,
        ]
    },

But this is incorrect. The proper syntax for an entry_points entry is:

    entry_points = {
        'nova.hooks': [
            'resize_hook=your_package.hooks:YourHookClass',
        ]
    },

Change-Id: Id7bc6891dc542d4317e82e15300c7293eb0d17a0
Closes-bug: #1374666

2014-09-28 09:29:39 -04:00

1.5 KiB

Raw Blame History

Hooks

Hooks provide a mechanism to extend Nova with custom code through a plugin mechanism.

Named hooks are added to nova code via a decorator that will lazily load plugin code matching the name. The loading works via setuptools entry points.

What are hooks good for?

Hooks are good for anchoring your custom code to Nova internal APIs.

What are hooks NOT good for?

Hooks should not be used when API stability is a key factor. Internal APIs may change. Consider using a notification driver if this is important to you.

Declaring hooks in the Nova codebase

The following example declares a resize_hook around the resize_instance method:

from nova import hooks

@hooks.add_hook("resize_hook")
def resize_instance(self, context, instance, a=1, b=2):
    ...

Hook objects can now be attached via entry points to the resize_hook.

Adding hook object code

Setup a Python package with a setup.py file.

Add the following to the setup.py setup call:

entry_points = {
    'nova.hooks': [
        'resize_hook=your_package.hooks:YourHookClass',
    ]
},

YourHookClass should be an object with pre and/or post methods:

class YourHookClass(object):

    def pre(self, *args, **kwargs):
        ....

    def post(self, rv, *args, **kwargs):
        ....

1.5 KiB Raw Blame History