mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-05-01 14:51:27 -07:00
f921369445
* Ansible Config part2 - made dump_me nicer, added note this is not prod - moved internal key removal function to vars - carry tracebacks in errors we can now show tracebacks for plugins on vvv - show inventory plugin tracebacks on vvv - minor fixes to cg groups plugin - draft config from plugin docs - made search path warning 'saner' (top level dirs only) - correctly display config entries and others - removed unneeded code - commented out some conn plugin specific from base.yml - also deprecated sudo/su - updated ssh conn docs - shared get option method for connection plugins - note about needing eval for defaults - tailored yaml ext - updated strategy entry - for connection pliugins, options load on plugin load - allow for long types in definitions - better display in ansible-doc - cleaned up/updated source docs and base.yml - added many descriptions - deprecated include toggles as include is - draft backwards compat get_config - fixes to ansible-config, added --only-changed - some code reoorg - small license headers - show default in doc type - pushed module utils details to 5vs - work w/o config file - PEPE ATE! - moved loader to it's own file - fixed rhn_register test - fixed boto requirement in make tests - I ate Pepe - fixed dynamic eval of defaults - better doc code skip ipaddr filter tests when missing netaddr removed devnull string from config better becoem resolution * killed extra space with extreeme prejudice cause its an affront against all that is holy that 2 spaces touch each other! shippable timing out on some images, but merging as it passes most
111 lines
4.2 KiB
Python
111 lines
4.2 KiB
Python
# Copyright 2017 RedHat, inc
|
|
#
|
|
# This file is part of Ansible
|
|
#
|
|
# Ansible is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Ansible is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
#############################################
|
|
'''
|
|
DOCUMENTATION:
|
|
name: constructed_groups
|
|
plugin_type: inventory
|
|
version_added: "2.4"
|
|
short_description: Uses Jinja2 expressions to construct groups.
|
|
description:
|
|
- Uses a YAML configuration file to identify group and the Jinja2 expressions that qualify a host for membership.
|
|
- Only variables already in inventory are available for expressions (no facts).
|
|
- Failed expressions will be ignored (assumes vars were missing).
|
|
EXAMPLES: | # inventory.config file in YAML format
|
|
plugin: constructed_groups
|
|
groups:
|
|
# simple name matching
|
|
webservers: inventory_hostname.startswith('web')
|
|
|
|
# using ec2 'tags' (assumes aws inventory)
|
|
development: "'devel' in (ec2_tags|list)"
|
|
|
|
# using other host properties populated in inventory
|
|
private_only: not (public_dns_name is defined or ip_address is defined)
|
|
|
|
# complex group membership
|
|
multi_group: (group_names|intersection(['alpha', 'beta', 'omega']))|length >= 2
|
|
'''
|
|
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
import os
|
|
|
|
from ansible.errors import AnsibleParserError
|
|
from ansible.plugins.inventory import BaseInventoryPlugin
|
|
from ansible.template import Templar
|
|
from ansible.module_utils._text import to_native
|
|
from ansible.utils.vars import combine_vars
|
|
|
|
|
|
class InventoryModule(BaseInventoryPlugin):
|
|
""" constructs groups using Jinaj2 template expressions """
|
|
|
|
NAME = 'constructed_groups'
|
|
|
|
def __init__(self):
|
|
|
|
super(InventoryModule, self).__init__()
|
|
|
|
def verify_file(self, path):
|
|
|
|
valid = False
|
|
if super(InventoryModule, self).verify_file(path):
|
|
file_name, ext = os.path.splitext(path)
|
|
|
|
if not ext or ext == '.config':
|
|
valid = True
|
|
|
|
return valid
|
|
|
|
def parse(self, inventory, loader, path, cache=False):
|
|
''' parses the inventory file '''
|
|
|
|
super(InventoryModule, self).parse(inventory, loader, path, cache=True)
|
|
|
|
try:
|
|
data = self.loader.load_from_file(path)
|
|
except Exception as e:
|
|
raise AnsibleParserError("Unable to parse %s: %s" % (to_native(path), to_native(e)))
|
|
|
|
if not data or data.get('plugin') != self.NAME:
|
|
raise AnsibleParserError("%s is empty or not a constructed groups config file" % (to_native(path)))
|
|
|
|
try:
|
|
templar = Templar(loader=loader)
|
|
|
|
# Go over hosts (less var copies)
|
|
for host in inventory.hosts:
|
|
|
|
# get available variables to templar
|
|
hostvars = inventory.hosts[host].get_vars()
|
|
if host in inventory.cache: # adds facts if cache is active
|
|
hostvars = combine_vars(hostvars, inventory.cache[host])
|
|
templar.set_available_variables(hostvars)
|
|
|
|
# process each 'group entry'
|
|
for group_name in data.get('groups', {}):
|
|
conditional = u"{%% if %s %%} True {%% else %%} False {%% endif %%}" % data['groups'][group_name]
|
|
result = templar.template(conditional)
|
|
if result and bool(result):
|
|
# ensure group exists
|
|
inventory.add_group(group_name)
|
|
# add host to group
|
|
inventory.add_child(group_name, host)
|
|
except Exception as e:
|
|
raise AnsibleParserError("failed to parse %s: %s " % (to_native(path), to_native(e)))
|