Develop an EDA Integration

Build an Event-Source Plugin

Technology Partners wanting to tightly integrate into Event-Driven Ansible should consider building an Event-Source Plugin. The current plugins found in the ansible.eda collection cover a wide range of mechanisms to send events to Event-Driven Ansible. However, some technologies could integrate further and provide additional benefits through this. An example could be a monitoring application that could use the generic webhook to notify Event-Driven Ansible of an incident. However, building a source plugin could enrich this by allowing source plugin to trigger notification and allow the updating of the incident that occurred.

Partners can start with example event source plugins from Ansible Docs (link). Event source plugins can be stored locally however it is preferred that they are distributed via a collection.

It is strongly recommended that you add comments at the top of the source file. Please describe the purpose of the event source plugin. List all required or optional arguments. Also add an example how to configure the plugin in a rulebook.

There is in-depth documentation on how to create custom event source plugins here.

Last updated