Skip to main content

Collections

Installing Collections from a requirements.yml file​

Example of how to specify roles and collection dependencies in a single requirements.yml file.

---
roles:
  - src: https://github.com/dreamteam-gg/ansible-victoriametrics-role
    version: v0.0.1
    name: victoria-metrics

collections:
  - name: community.general
    version: "1.2.0"

Documenting Collections​

ansible-docs displays documentation from docstrings in the python file which implements the Ansible Module or Plugin. https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_documenting.html describes the expected format for the docstrings.

While the documentation states "...Any parsing errors will be obvious - you can view details by adding -vvv to the command.", my experience differs.

The guidelines require adding # -*- coding: utf-8 -*- which I'm not a fan of as Python3 sets this by default, however if you are open-sourcing a Collection it must still be compatible with Python2. https://realpython.com/python-encodings-guide/#python-3-all-in-on-unicode

Testing module documentation​

See https://docs.ansible.com/ansible/latest/dev_guide/testing_documentation.html#testing-module-documentation

Modules and Plugins​

A Module runs on the remote system, a Plugin runs on the Ansible Control node. See https://docs.ansible.com/ansible/latest/dev_guide/developing_locally.html#modules-and-plugins-what-s-the-difference

Troubleshooting​

'AnsibleSequence' object has no attribute 'get'​

I've hit this error a few times when developing a module or plugin for a collection. The errors in my case were related to incorrect indentation in the DOCUMENTATION string in the module or plugin source, which was not immediately apparent from the error message.