Building network automation solutions

9 module online course

Start now!

New Ansible Data Validation Module(s)

A few months ago I described how you could use JSON Schema to validate your automation data models, host/group variable files, or even Ansible inventory file.

I had to use a weird toolchain to get it done – either ansible-inventory to build a complete data model from various inventory sources, or yq to convert YAML to JSON… and just for the giggles jsonschema CLI command requires the JSON input to reside in a file, so you have to use a temporary file to get the job done.

Obviously I could have used Python, and it wouldn’t be more than a dozen or so lines of code to read YAML and have it validated with jsonschema Python module, but I wanted to keep it as simple as possible and probably failed. What exactly did RFC 6670 say about squashed complexity sausage?

Things got much simpler with the new validate module in ansible.utils collection. You pass the data you want to have validated, the validation criteria (JSON schema describing your data), and the validation engine (currently only jsonschema) to the module and get back a success message or a list of errors. Great job (and thanks for the reference to my article in the announcement blog post ūüôŹ)

A fair warning before you get too excited: the error messages generated by jsonschema could be a bit counter-intuitive. Trust me, I use it in my Git commit hooks, and while I appreciate the all good message every time I get one, trying to decipher what exactly I did wrong from the error message is a bit of a chore (hope you noticed how extremely polite I tried to sound, sometimes it’s a ******* nightmare).

Wrap those error messages in lovely JSON generated by ansible-playbook when a module fails, and you have a perfect puzzle to keep you awake all night when your playbook crashes on bad data at 2AM on a Sunday morning. Make sure you set ANSIBLE_STDOUT_CALLBACK to yaml before you start troubleshooting ;)

2 comments:

  1. Great to see this integration in core, we (NTC) developed near exact capabilities a few years back in our custom modules.

    https://github.com/networktocode/ntc-ansible/blob/master/library/ntc_validate_schema.py

    Eventually we found the solution limiting, and have built our "next-generation" version in https://github.com/networktocode/schema-enforcer.

    I am super excited about our next set of use cases to help with business logic validation which will hopefully be released shortly.

  2. @Ken: blog post about Schema Enforcer was in the to-publish queue before this one appeared ;) Scheduled for early next week. Now you know the minimum queue size ;))

Add comment
Sidebar