Collection for Event-Driven Ansible

This collection contains event source plugins, event filters and example rulebooks to be used with ansible-rulebook.

Description

The primary purpose of this collection is to reduce manual tasks and deliver more efficient mission-critical workflows. By leveraging this collection, organizations can automate a variety of error-prone and time-consuming tasks and respond to changing conditions in any IT domain across IT environments for better agility and resiliency.

Important: Plugin Migration

Several event sources and event filters have been migrated from this collection to ansible-rulebook as builtins. Users should update their rulebooks to use the eda.builtin namespace.

Migrated Event Sources

• ansible.eda.pg_listener → eda.builtin.pg_listener
• ansible.eda.generic → eda.builtin.generic
• ansible.eda.range → eda.builtin.range
• ansible.eda.webhook → eda.builtin.webhook

Migrated Event Filters

• ansible.eda.insert_hosts_to_meta → eda.builtin.insert_hosts_to_meta
• ansible.eda.json_filter → eda.builtin.json_filter
• ansible.eda.normalize_keys → eda.builtin.normalize_keys
• ansible.eda.dashes_to_underscores → eda.builtin.dashes_to_underscores

Note: For backwards compatibility, these plugins remain available in the ansible.eda namespace and are automatically mapped to eda.builtin. However, they are no longer actively maintained in this collection. Please update your rulebooks to use the eda.builtin versions.

Deprecated Event Sources

• ansible.eda.aws_cloudtrail → amazon.aws.aws_cloudtrail
• ansible.eda.aws_sqs_queue → amazon.aws.aws_sqs_queue
• ansible.eda.azure_service_bus → azure.azcollection.azure_service_bus
• ansible.eda.file → community.eda.file
• ansible.eda.file_watch → community.eda.file_watch
• ansible.eda.journald → community.eda.journald
• ansible.eda.tick → use either eda.builtin.generic or eda.builtin.range
• ansible.eda.url_check → community.eda.url_check

Deprecated Event Filters

• ansible.eda.noop -- no replacement for it, simply stop using it

Requirements

Ansible version compatibility

Tested with the Ansible Core >= 2.15.0 versions, and the current development version of Ansible. Ansible Core versions before 2.15.0 are not supported.

Python version compatibility

This collection requires Python 3.9 or greater.

Additional dependencies

This collection requires ansible-rulebook 1.0.0 or greater.

Installation

The ansible.eda collection can be installed with the Ansible Galaxy command-line tool:

ansible-galaxy collection install ansible.eda

You can also include it in a requirements.yml file and install it with ansible-galaxy collection install -r requirements.yml, using the format:

---
collections:
  - name: ansible.eda

Note that if you install any collections from Ansible Galaxy, they will not be upgraded automatically when you upgrade the Ansible package. To upgrade the collection to the latest available version, run the following command:

ansible-galaxy collection install ansible.eda --upgrade

A specific version of the collection can be installed by using the version keyword in the requirements.yml file:

---
collections:
  - name: ansible.eda
    version: 1.0.0

or using the ansible-galaxy command as follows

ansible-galaxy collection install ansible.eda:==1.0.0

The Python module dependencies are not installed by ansible-galaxy. They must be installed manually using pip:

pip install -r requirements.txt

Refer to the following for more details.

• using Ansible collections for more details.

Use Cases

You can either call modules, rulebooks and playbooks by their Fully Qualified Collection Name (FQCN), such as ansible.eda.activation, or you can call modules by their short name if you list the ansible.eda collection in the playbook's collections keyword:

---
  - name: Create a rulebook activation
    ansible.eda.rulebook_activation:
      name: "Example Activation"
      description: "Example Activation description"
      project: "Example Project"
      rulebook_name: "basic_short.yml"
      decision_environment_name: "Example Decision Environment"
      enabled: False
      awx_token_name: "Example AWX Token"

  - name: Get information about the rulebook activation
    ansible.eda.rulebook_activation_info:
      name: "Example Activation"

  - name: Delete rulebook activation
    ansible.eda.rulebook_activation:
      name: "Example Activation"
      state: absent

Contributing

We welcome community contributions to this collection. If you find problems, please open an issue or create a PR against the Event-Driven Ansible collection repository. See CONTRIBUTING.md for more details.

More information about contributing

• Ansible Community Guide - Details on contributing to Ansible
• Contributing to Collections - How to check out collection git repositories correctly

Support

If you installed this collection from either from Galaxy or GitHub, there may community help available on the Ansible Forum.

Red Hat customers are entitled to support for certified content through Ansible Automation Platform (AAP) using the Create issue button on the top right corner.

Release notes

See Documentation tab on Automation Hub.

Related Information

• Ansible Collection Overview
• Ansible User Guide
• Ansible Developer Guide
• Ansible Collection Developer Guide
• Ansible Community Code of Conduct

License Information

See LICENSE to see the full text.