JinjaTurtle

JinjaTurtle is a command-line tool to help you generate Jinja2 templates and Ansible defaults/main.yml files from a native configuration file of a piece of software.

How it works

The config file is examined
Parameter key names are generated based on the parameter names in the config file. In keeping with Ansible best practices, you pass a prefix for the key names, which should typically match the name of your Ansible role.
A Jinja2 file is generated from the file with those parameter key names injected as the {{ variable }} names.
A defaults/main.yml is generated with those key names and the values taken from the original config file as the defaults.

By default, the Jinja2 template and the defaults/main.yml are printed to stdout. However, it is possible to output the results to new files.

What sort of config files can it handle?

TOML, YAML, INI and JSON style config files should be okay. There are always going to be some edge cases in very complex files that are difficult to work with, though, so you may still find that you need to tweak the results.

The goal here is really to speed up converting files into Ansible/Jinja2, but not necessarily to make it perfect.

How to install it

From PyPi

pip install jinjaturtle

From this git repository

Clone the repo and then run inside the clone:

poetry install

AppImage

Download the AppImage from the Releases and make it executable, and put it on your $PATH.

How to run it

Say you have a php.ini file and you are in a directory structure like an Ansible role (with subfolders defaults and templates):

jinjaturtle php.ini \
  --role-name php \
  --defaults-output defaults/main.yml \
  --template-output templates/php.ini.j2

Full usage info

usage: jinjaturtle [-h] -r ROLE_NAME [-f {json,ini,toml,yaml}] [-d DEFAULTS_OUTPUT] [-t TEMPLATE_OUTPUT] config

Convert a config file into an Ansible defaults file and Jinja2 template.

positional arguments:
  config                Path to the source configuration file (TOML or INI-style).

options:
  -h, --help            show this help message and exit
  -r, --role-name ROLE_NAME
                        Ansible role name, used as variable prefix (e.g. cometbft).
  -f, --format {ini,toml}
                        Force config format instead of auto-detecting from filename.
  -d, --defaults-output DEFAULTS_OUTPUT
                        Path to write defaults/main.yml. If omitted, defaults YAML is printed to stdout.
  -t, --template-output TEMPLATE_OUTPUT
                        Path to write the Jinja2 config template. If omitted, template is printed to stdout.

Found a bug, have a suggestion?

You can e-mail me (see the pyproject.toml for details) or contact me on the Fediverse:

https://goto.mig5.net/@mig5

3 KiB Raw Blame History