DEV Community

Cover image for Maintaining Ansible Collections
XLAB Steampunk
XLAB Steampunk

Posted on

Maintaining Ansible Collections

Integrating your product with Ansible can be overwhelming. Make your life as an Ansible Collection maintainer easier with these tips and tricks:

  1. Run sanity tests as often as possible in order to ensure your module and plugin documentation does not get out-of-sync with the implementation.

  2. Schedule a nightly integration test run that uses latest components (Ansible, your upstream product, helpers, etc.). Detecting incompatibilities early in the development cycle gives you a chance to report and fix bugs before they get into final releases of upstream components.

  3. Think twice before you start autogenerating modules. Instead, treat Ansible content as another abstraction layer for your product’s API that allows you to smoothen some of the rough edges and offer cross-product version compatibility.

  4. Get comfortable using your IRC client (or invest a few bucks for an always-connected solution with a backlog option) since most of the development-related discussions happen in #ansible-devel and #ansible-community freenode IRC channels.

Top comments (0)