openstack/manila
Code Issues Proposed changes
4f22d0b19e
manila/doc/source/contributor/share_hooks.rst
Tom Barron 90060722a9 doc migration: new directory layout 
This patch introduces a new directory layout
in doc/source in conformance with the OpenStack
manuals project migration spec [1], moves the
existing content in manila/doc/source into the
new directories, and adjusts index files accordingly.

This is the first step in the migration process
as outlined in the spec.

[1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

Partial-Bug: #1706181
Needed-By: I7924d94b82e7c8d9716bad7a219fc38c57970773
Depends-On: Ifc80fc56648cef74c85464321d1850e8c68449a0
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Change-Id: Ieea33262101a1d2459492c1c8aaac5fe042279f6
2017-08-24 09:16:25 -04:00

3.3 KiB
Raw Blame History

Manila share driver hooks

Manila share driver hooks are designed to provide additional possibilities for each manila-share service; such as any kind of notification and additional actions before and after share driver calls.

Possibilities

  • Perform actions before some share driver method calls.
  • Perform actions after some share driver method calls with results of

    driver call and preceding hook call.

  • Call additional 'periodic' hook each 'N' ticks.
  • Possibility to update results of driver's action by post-running hook.

Features

  • Errors in hook execution can be suppressed.
  • Any hook can be disabled.
  • Any amount of hook instances can be run at once for each manila-share

    service.

Limitations

  • Hooks approach is not asynchronous. That is, if we run hooks, and

    especially, more than one hook instance, then all of them will be executed in one thread.

Implementation in share drivers

Share drivers can [re]define method get_periodic_hook_data that runs with each execution of 'periodic' hook and receives list of shares (as parameter) with existing access rules. So, each share driver, for each of its shares can add/update some information that will be used then in the periodic hook.

What is required for writing new 'hook' implementation?

All implementations of 'hook' interface are expected to be in 'manila/share/hooks'. Each implementation should inherit class 'manila.share.hook:HookBase' and redefine its abstract methods.

How to use 'hook' implementations?

Just set config option 'hook_drivers' in driver's config group. For example:

[MY_DRIVER]
hook_drivers=path.to:FooClass,path.to:BarClass

Then all classes defined above will be initialized. In the same config group, any config option of hook modules can be redefined too.

Note

More info about common config options for hooks can be found in module manila.share.hook

Driver methods that are wrapped with hooks

  • allow_access
  • create_share_instance
  • create_snapshot
  • delete_share_instance
  • delete_share_server
  • delete_snapshot
  • deny_access
  • extend_share
  • init_host
  • manage_share
  • publish_service_capabilities
  • shrink_share
  • unmanage_share
  • create_share_replica
  • promote_share_replica
  • delete_share_replica
  • update_share_replica
  • create_replicated_snapshot
  • delete_replicated_snapshot
  • update_replicated_snapshot

Above list with wrapped methods can be extended in future.

The manila.share.hook.py Module

manila.share.hook