diff --git a/README.md b/README.md index 4a8a0d5c..c6ddd8f5 100644 --- a/README.md +++ b/README.md @@ -4,25 +4,106 @@ This collection contains event source plugins, event filters and example ruleboo +## Description + +The primary purpose of this collection is to 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. + ## Requirements -* python >= 3.9 -* ansible-core >= 2.15 +### Ansible version compatibility + +Tested with the Ansible Core >= 2.15.0 versions, and the current development version of Ansible. Ansible Core versions prior to 2.15.0 are not supported. + +### Python version compatibility + +This collection requires Python 3.9 or greater. -## Install +### Additional dependencies -Install the ansible.eda collection with the Ansible Galaxy CLI: +This collection requires ansible-rulebook 1.0.0 or greater. + + +## Installation + +The ansible.eda collection can be installed with Ansible Galaxy command-line tool: ```shell ansible-galaxy collection install ansible.eda ``` -The Python module dependencies are not installed by ansible-galaxy. They must be installed manually using pip: +You can also include it in a `requirements.yml` file and install it with `ansible-galaxy collection install -r requirements.yml`, using the format: + +```yaml +--- +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: + +```yaml +--- +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: ```shell pip install -r requirements.txt ``` +Refer the following for more details. +* [using Ansible collections](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html) for more details. + +## Use Cases + +TBA + +## Testing + +TBA + ## Contributing -Please refer to the [contributing guide](./CONTRIBUTING.md) for information about how you can contribute to the project. +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](https://github.com/ansible/event-driven-ansible). +See [CONTRIBUTING.md](./CONTRIBUTING.md) for more details. + +### More information about contributing + +- [Ansible Community Guide](https://docs.ansible.com/ansible/latest/community/index.html) - Details on contributing to Ansible +- [Contributing to Collections](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#contributing-to-collections) - How to check out collection git repositories correctly + +## Support + +TBA + +## Release notes + +See the [raw generated changelog](https://github.com/ansible/event-driven-ansible/tree/main/CHANGELOG.rst). + +## Related Information + +- [Ansible Collection overview](https://github.com/ansible-collections/overview) +- [Ansible User guide](https://docs.ansible.com/ansible/latest/user_guide/index.html) +- [Ansible Developer guide](https://docs.ansible.com/ansible/latest/dev_guide/index.html) +- [Ansible Collection Developer Guide](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html) +- [Ansible Community code of conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html) + +## License Information + +See [LICENSE](./LICENSE) to see the full text.