how to add custom jinja filters

Hi,

Is there a good example how to extend ansible with custom jinja filters?

I have added this, but my filter is not found
http://docs.ansible.com/intro_configuration.html#filter-plugins

Adding the function to core.py works, but it just looks wrong

As it turns out, I played around a bit with this just a couple of weeks
ago, and it's quite simple.

The easiest way is to simply create a directory where your top-level
playbook is (site.yml?) called filter_plugins. Within that directory
you simply put .py files with content similar to (----%---- is just to
show where file begins/ends, don't copy that :):

----%----
def uppercase_all(arg):
    return arg.upper()

class FilterModule(object):
    def filters(self):
        return {'uppercase_all': uppercase_all}
----%----

With the above in place, you can simply use the filter uppercase_all
within your playbooks, roles etc. Note that you don't necessarily need
to have the same name for function and filter, but it's probably better
to do it that way.

If you look at the page you posted, it will direct you to
http://docs.ansible.com/developing_plugins.html which describes most of
I wrote (although, in a bit of a less verbose way, and without
examples).

I hope this helps.

Best regards

Hi Branko,

Thanks for the reply, I got it working.

What was different in my case is that the folder was named “filters”.
I renamed it to “filter_plugins” and it works fine now.

I also noticed that the setting http://docs.ansible.com/intro_configuration.html#filter-plugins

in the config file has no effect. I may open issue on github.

Regards,

ilin

If that path is not taking on the 1.8.X series, please do. Thanks!

the approach outlined below doesn’t seem to be working, Ansible can’t find existing filters anymore after I add this in?