This Collection is meant to be an addition to the official Ansible Collection by Icinga.
Since Icinga's Collection currently only handles official Icinga components, netways.icinga_contrib aims to fill the gap.
For example, there are Icinga Web 2 modules provided by the community which are used a lot like the Grafana module or the Map module.
This Collection is meant to handle such cases.
Since NETWAYS maintains this Collection contributions are evaluated on a case-by-case basis. See Contributing.
Ansible Galaxy
To install the Collection from Ansible Galaxy:
ansible-galaxy collection install netways.icinga_contrib
Git
To install the Collection's main branch from this repository:
ansible-galaxy collection install git+https://github.com/netways/ansible-collection-icinga_contrib,main
To install a specific tag release:
ansible-galaxy collection install git+https://github.com/netways/ansible-collection-icinga_contrib,1.2.3
To use the collection specify the FQCN of the module, plugin or role you want to use.
- name: Run role netways.icinga_contrib.icingaweb2_modules
hosts: somehost
vars:
icingaweb2_modules:
grafana:
...
roles:
- netways.icinga_contrib.icingaweb2_modules
- netways.icinga_contrib.icingaweb2_modules
This role is used to manage modules for Icinga Web 2 not managed by Icinga's official Collection.
Contributions are welcome!
Since maintaining this repository is work we might reject certain contributions or feature requests.
We also need to have a certain level of trust when it comes to third party code, e.g. Icinga Web 2 modules.
Decisions are made on a case-by-case basis.
If you want to know whether a certain new feature would be welcome, feel free to simply ask and start a discussion.
Also, if you want to contribute to this Collection, please follow these general guidelines:
- Open issues. The more we know the better we can maintain this Collection.
- If you want to work on an open issue, let us know so we can assign it to you and keep track.
- Request new features via an issue.
- If applicable, use one of the provided issue templates.
- Be precise when describing bugs / feature requests.
- Link related issues, especially ones closed by the PR.
- Make sure to provide changelog fragments describing the changes within your PR. For more information see antsibull-changelog.
- If you introduce or change variables, add them to the appropriate README file.
- The Collection is tested using Molecule. If introducing new code, you should also provide new tests if you can.
GPL-3.0-only