ansible-collections / ansible-consul

:satellite: Ansible role for Hashicorp Consul clusters
https://galaxy.ansible.com/ansible-community/consul/
BSD 2-Clause "Simplified" License
452 stars 313 forks source link

What is the purpose of the consul_iface variable #510

Open dcarbone opened 1 year ago

dcarbone commented 1 year ago

I'm looking to uplift my currently manually updated homelab consul cluster to ansible using this project.

That said, I don't understand the purpose of the consul_iface var. It isn't actually used anywhere in this codebase outside of tests, the changelog, and the readme, as evidenced by this search, and consul itself doesn't look for a CONSUL_IFACE environment variable.

The other "address" variables are all wired up as I would expect. For example, consul_bind_address and consul_client_address are referenced, at a minimum, within the j2 template. This leads me to believe the consul_iface variable is a hold out from a previous iteration of this repo, and is now entirely defunct.

It also doesn't really make sense, as even in my home setup I have the servers communicate over one interface, and client traffic communicate over another, which is a totally valid configuration, thus negating the utility of a config var that ostensibly defines a singular interface to be used for consul traffic.

I'm no ansible expert, so perhaps there is somewhere outside this codebase that consul_iface is used, at which point I can make a PR to update the doc to provide a clearer description of what this var is supposed to be doing. IMO, though, it should simply be removed.