1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
community.general/plugins/lookup/hiera.py

95 lines
2.9 KiB
Python
Raw Normal View History

2021-08-07 15:02:21 +02:00
# -*- coding: utf-8 -*-
# Copyright (c) 2017, Juan Manuel Parrilla <jparrill@redhat.com>
# Copyright (c) 2012-17 Ansible Project
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
2020-03-09 10:11:07 +01:00
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
DOCUMENTATION = '''
author:
- Juan Manuel Parrilla (@jparrill)
2021-01-12 07:12:03 +01:00
name: hiera
2020-03-09 10:11:07 +01:00
short_description: get info from hiera data
requirements:
- hiera (command line utility)
description:
- Retrieves data from an Puppetmaster node using Hiera as ENC.
2020-03-09 10:11:07 +01:00
options:
_terms:
2020-03-09 10:11:07 +01:00
description:
- The list of keys to lookup on the Puppetmaster.
2020-03-09 10:11:07 +01:00
type: list
elements: string
2022-09-06 20:42:17 +02:00
required: true
executable:
2020-03-09 10:11:07 +01:00
description:
- Binary file to execute Hiera.
type: string
2020-03-09 10:11:07 +01:00
default: '/usr/bin/hiera'
env:
- name: ANSIBLE_HIERA_BIN
config_file:
2020-03-09 10:11:07 +01:00
description:
- File that describes the hierarchy of Hiera.
type: string
2020-03-09 10:11:07 +01:00
default: '/etc/hiera.yaml'
env:
- name: ANSIBLE_HIERA_CFG
# FIXME: incomplete options .. _terms? environment/fqdn?
'''
EXAMPLES = """
# All this examples depends on hiera.yml that describes the hierarchy
- name: "a value from Hiera 'DB'"
ansible.builtin.debug:
msg: "{{ lookup('community.general.hiera', 'foo') }}"
2020-03-09 10:11:07 +01:00
- name: "a value from a Hiera 'DB' on other environment"
ansible.builtin.debug:
msg: "{{ lookup('community.general.hiera', 'foo environment=production') }}"
2020-03-09 10:11:07 +01:00
- name: "a value from a Hiera 'DB' for a concrete node"
ansible.builtin.debug:
msg: "{{ lookup('community.general.hiera', 'foo fqdn=puppet01.localdomain') }}"
2020-03-09 10:11:07 +01:00
"""
RETURN = """
_raw:
description:
- a value associated with input key
type: list
elements: str
2020-03-09 10:11:07 +01:00
"""
from ansible.plugins.lookup import LookupBase
from ansible.utils.cmd_functions import run_cmd
from ansible.module_utils.common.text.converters import to_text
2020-03-09 10:11:07 +01:00
class Hiera(object):
def __init__(self, hiera_cfg, hiera_bin):
self.hiera_cfg = hiera_cfg
self.hiera_bin = hiera_bin
2020-03-09 10:11:07 +01:00
def get(self, hiera_key):
pargs = [self.hiera_bin]
pargs.extend(['-c', self.hiera_cfg])
2020-03-09 10:11:07 +01:00
pargs.extend(hiera_key)
rc, output, err = run_cmd("{0} -c {1} {2}".format(
self.hiera_bin, self.hiera_cfg, hiera_key[0]))
2020-03-09 10:11:07 +01:00
return to_text(output.strip())
2020-03-09 10:11:07 +01:00
class LookupModule(LookupBase):
def run(self, terms, variables=None, **kwargs):
self.set_options(var_options=variables, direct=kwargs)
hiera = Hiera(self.get_option('config_file'), self.get_option('executable'))
ret = [hiera.get(terms)]
2020-03-09 10:11:07 +01:00
return ret