Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[4.0] Create event hook infrastructure #1313

Merged
merged 1 commit into from
Aug 30, 2017

Conversation

scottwulf
Copy link
Contributor

@scottwulf scottwulf commented Aug 30, 2017

Rebase of PR #952 but only including the new infrastructure class

For usage examples, see:
#952
crowbar/crowbar-ha#171
crowbar/crowbar-openstack#717

There are several cases where we have events that should trigger some
activity in some other part of Crowbar. For instance:

  • when the public name of a node is saved, it may impact the endpoint
    of an OpenStack service
  • when the public name of the VIP of haproxy is changed, it impacts the
    endpoint of OpenStack services
  • when the keystone proposal is applied, we may want to reapply all
    proposals that depend on keystone

What we need for this is the ability to notify about the events in the
rails application and then dispatch the notifications to hooks which
listen for them and decide if some action should be triggered.

The main reason we didn't have this in the past is that we likely don't
want to do that in the foreground of the rails application. But now that
we have delayed_job, we can send the notifications and run the hooks in
the background.

In this commit, we add the simple infrastructure about notifications and
hooks:

  • the events are defined with a name and a hash that contains the
    details of the event. The structure of the hash depends on the event.

  • a simple dispatcher exists that simply connects the hooks to the
    events.

  • the hooks only exist for service objects for the time being; a
    service object simply needs to have a event_hook method to register
    the hook, and will need to filter for the events it cares about. The
    signature of event_hook is as follows:
    def event_hook(role, event, details)

It could be argued that the hooks should be registered for some specific
events (hence moving the filter to the event dispatcher), but it's not
worth the complexity for now.

Rebase of PR crowbar#952 but only including the new infrastructure class

For usage examples, see:
crowbar#952
crowbar/crowbar-ha#171
crowbar/crowbar-openstack#717

There are several cases where we have events that should trigger some
activity in some other part of Crowbar. For instance:

 - when the public name of a node is saved, it may impact the endpoint
   of an OpenStack service
 - when the public name of the VIP of haproxy is changed, it impacts the
   endpoint of OpenStack services
 - when the keystone proposal is applied, we may want to reapply all
   proposals that depend on keystone

What we need for this is the ability to notify about the events in the
rails application and then dispatch the notifications to hooks which
listen for them and decide if some action should be triggered.

The main reason we didn't have this in the past is that we likely don't
want to do that in the foreground of the rails application. But now that
we have delayed_job, we can send the notifications and run the hooks in
the background.

In this commit, we add the simple infrastructure about notifications and
hooks:

 - the events are defined with a name and a hash that contains the
   details of the event. The structure of the hash depends on the event.

 - a simple dispatcher exists that simply connects the hooks to the
   events.

 - the hooks only exist for service objects for the time being; a
   service object simply needs to have a event_hook method to register
   the hook, and will need to filter for the events it cares about. The
   signature of event_hook is as follows:
     def event_hook(role, event, details)

It could be argued that the hooks should be registered for some specific
events (hence moving the filter to the event dispatcher), but it's not
worth the complexity for now.
@scottwulf scottwulf requested a review from matelakat August 30, 2017 11:00
@Itxaka
Copy link
Member

Itxaka commented Aug 30, 2017

@Itxaka Itxaka changed the title Create event hook infrastructure [4.0] Create event hook infrastructure Aug 30, 2017
@Itxaka
Copy link
Member

Itxaka commented Aug 30, 2017

FYI @scottwulf we set the title to [VERSION] TITLE when backporting, so its easier to see :)

@scottwulf scottwulf merged commit ef9d5b2 into crowbar:stable/4.0 Aug 30, 2017
@scottwulf scottwulf deleted the event-hooks branch August 30, 2017 14:56
Copy link
Contributor

@matelakat matelakat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved from me

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants