Module creation guide

This guide explains how to create a module. For detailed documentation see: module.yml and setup.cfg.

Create a new source module

For a v1 module:

pip install cookiecutter
cookiecutter --checkout v1 gh:inmanta/inmanta-module-template

For a v2 module:

pip install cookiecutter
cookiecutter gh:inmanta/inmanta-module-template

Note

The cookiecutter template also sets up git for the new module. This is a best practice to version control your infrastructure code.

Inside the module the compiler expects a module.yml file (for v1) or a setup.cfg file (for v2) that defines metadata about the module. module.yml and setup.cfg provide an overview about the supported metadata attributes.