You just put the code (inventory_vars.py) in the plugin folder - eg plugins\vars_plugins (where plugins folder is at same level with roles)
The plugin will allow you to have the following structure
While the plugin is basically very close to inventory variables concept, I found the original concept very complicated to maintain due to the inventory file format. Using the plugin will allow to use the regular yml dictionaries. The fact that you can have group vars or host vars per cluster is more of a nice to have for me.
In order to use the plugin you will need to have a folder under cluster_vars with exact same name as the original inventory file name.
Eg. if "qa" is my inventory file name, I can place a cluster with same name under cluster_vars. There are a few print statements to help you with debugging in case you run in trouble, if you are annoyed by them just comment the out.
# (c) 2016, Iulius Hutuleac
import os
import glob
from ansible import errors
from ansible import utils
from ansible.errors import AnsibleUndefinedVariable
from ansible.parsing.dataloader import DataLoader
from ansible.template import Templar
from ansible.utils.vars import combine_vars
import ansible.constants as C
def vars_file_matches(f, name):
# A vars file matches if either:
# - the basename of the file equals the value of 'name'
# - the basename of the file, stripped its extension, equals 'name'
if os.path.basename(f) == name:
return True
elif os.path.basename(f) == '.'.join([name, 'yml']):
return True
elif os.path.basename(f) == '.'.join([name, 'yaml']):
return True
else:
return False
def vars_files(vars_dir, name):
files = []
try:
candidates = [os.path.join(vars_dir, f) for f in os.listdir(vars_dir)]
except OSError:
return files
for f in candidates:
if os.path.isfile(f) and vars_file_matches(f, name):
files.append(f)
elif os.path.isdir(f):
files.extend(vars_files(f, name))
return sorted(files)
class VarsModule(object):
def __init__(self, inventory):
self.inventory = inventory
self.group_cache = {}
def get_group_vars(self, group, vault_password=None):
""" Get group specific variables. """
inventory = self.inventory
inventory_name = os.path.basename(inventory.src())
results = {}
#basedir = os.getcwd()
basedir = os.path.join(inventory.basedir(),"..")
if basedir is None:
# could happen when inventory is passed in via the API
return
inventory_vars_dir = os.path.join(basedir, "cluster_vars", inventory_name, "group_vars")
inventory_vars_files = vars_files(inventory_vars_dir, group.name)
print("Files for group ", group.name, ":", inventory_vars_files)
if len(inventory_vars_files) > 1:
raise errors.AnsibleError("Found more than one file for host '%s': %s"
% (group.name, inventory_vars_files))
dl = DataLoader()
for path in inventory_vars_files:
data = dict()
data.update( dl.load_from_file(path) )
if type(data) != dict:
raise errors.AnsibleError("%s must be stored as a dictionary/hash" % path)
if C.DEFAULT_HASH_BEHAVIOUR == "merge":
# let data content override results if needed
results = utils.merge_hash(results, data)
else:
results.update(data)
return results
def run(self, host, vault_password=None):
print("Requested files for host ", host)
return {}
def get_host_vars(self, host, vault_password=None):
""" Get group specific variables. """
inventory = self.inventory
inventory_name = os.path.basename(inventory.src())
results = {}
#basedir = os.getcwd()
basedir = os.path.join(inventory.basedir(),"..")
if basedir is None:
# could happen when inventory is passed in via the API
return
inventory_vars_dir = os.path.join(basedir, "cluster_vars", inventory_name, "host_vars")
inventory_vars_files = vars_files(inventory_vars_dir, host)
print("Files for host ", host, ":", inventory_vars_files)
if len(inventory_vars_files) > 1:
raise errors.AnsibleError("Found more than one file for host '%s': %s"
% (host, inventory_vars_files))
dl = DataLoader()
for path in inventory_vars_files:
data = dict()
data.update( dl.load_from_file(path) )
if type(data) != dict:
raise errors.AnsibleError("%s must be stored as a dictionary/hash" % path)
if C.DEFAULT_HASH_BEHAVIOUR == "merge":
# let data content override results if needed
results = utils.merge_hash(results, data)
else:
results.update(data)
return results
