mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-23 12:33:59 -07:00
8f8a0e1d7c
Some checks are pending
EOL CI / EOL Sanity (Ⓐ2.17) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.17+py3.10) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.17+py3.12) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.17+py3.7) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+alpine319+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+alpine319+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+alpine319+py:azp/posix/3/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+fedora39+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+fedora39+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+fedora39+py:azp/posix/3/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+ubuntu2004+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+ubuntu2004+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+ubuntu2004+py:azp/posix/3/) (push) Waiting to run
nox / Run extra sanity tests (push) Waiting to run
* Adjust all __future__ imports: for i in $(grep -REl "__future__.*absolute_import" plugins/ tests/); do sed -e 's/from __future__ import .*/from __future__ import annotations/g' -i $i; done * Remove all UTF-8 encoding specifications for Python source files: for i in $(grep -REl '[-][*]- coding: utf-8 -[*]-' plugins/ tests/); do sed -e '/^# -\*- coding: utf-8 -\*-/d' -i $i; done * Remove __metaclass__ = type: for i in $(grep -REl '__metaclass__ = type' plugins/ tests/); do sed -e '/^__metaclass__ = type/d' -i $i; done
117 lines
3.3 KiB
Python
117 lines
3.3 KiB
Python
# Copyright (c) 2012, Jan-Piet Mens <jpmens(at)gmail.com>
|
|
# Copyright (c) 2017 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
|
|
from __future__ import annotations
|
|
|
|
DOCUMENTATION = r"""
|
|
name: redis
|
|
author:
|
|
- Jan-Piet Mens (@jpmens) <jpmens(at)gmail.com>
|
|
- Ansible Core Team
|
|
short_description: Fetch data from Redis
|
|
description:
|
|
- This lookup returns a list of results from a Redis DB corresponding to a list of items given to it.
|
|
requirements:
|
|
- redis (python library https://github.com/andymccurdy/redis-py/)
|
|
options:
|
|
_terms:
|
|
description: List of keys to query.
|
|
type: list
|
|
elements: string
|
|
host:
|
|
description: Location of Redis host.
|
|
type: string
|
|
default: '127.0.0.1'
|
|
env:
|
|
- name: ANSIBLE_REDIS_HOST
|
|
ini:
|
|
- section: lookup_redis
|
|
key: host
|
|
port:
|
|
description: Port on which Redis is listening on.
|
|
default: 6379
|
|
type: int
|
|
env:
|
|
- name: ANSIBLE_REDIS_PORT
|
|
ini:
|
|
- section: lookup_redis
|
|
key: port
|
|
socket:
|
|
description: Path to socket on which to query Redis, this option overrides host and port options when set.
|
|
type: path
|
|
env:
|
|
- name: ANSIBLE_REDIS_SOCKET
|
|
ini:
|
|
- section: lookup_redis
|
|
key: socket
|
|
"""
|
|
|
|
EXAMPLES = r"""
|
|
- name: query redis for somekey (default or configured settings used)
|
|
ansible.builtin.debug:
|
|
msg: "{{ lookup('community.general.redis', 'somekey') }}"
|
|
|
|
- name: query redis for list of keys and non-default host and port
|
|
ansible.builtin.debug:
|
|
msg: "{{ lookup('community.general.redis', item, host='myredis.internal.com', port=2121) }}"
|
|
loop: '{{list_of_redis_keys}}'
|
|
|
|
- name: use list directly
|
|
ansible.builtin.debug:
|
|
msg: "{{ lookup('community.general.redis', 'key1', 'key2', 'key3') }}"
|
|
|
|
- name: use list directly with a socket
|
|
ansible.builtin.debug:
|
|
msg: "{{ lookup('community.general.redis', 'key1', 'key2', socket='/var/tmp/redis.sock') }}"
|
|
"""
|
|
|
|
RETURN = r"""
|
|
_raw:
|
|
description: Value(s) stored in Redis.
|
|
type: list
|
|
elements: str
|
|
"""
|
|
|
|
HAVE_REDIS = False
|
|
try:
|
|
import redis
|
|
HAVE_REDIS = True
|
|
except ImportError:
|
|
pass
|
|
|
|
from ansible.module_utils.common.text.converters import to_text
|
|
from ansible.errors import AnsibleError
|
|
from ansible.plugins.lookup import LookupBase
|
|
|
|
|
|
class LookupModule(LookupBase):
|
|
|
|
def run(self, terms, variables, **kwargs):
|
|
|
|
if not HAVE_REDIS:
|
|
raise AnsibleError("Can't LOOKUP(redis_kv): module redis is not installed")
|
|
|
|
# get options
|
|
self.set_options(direct=kwargs)
|
|
|
|
# setup connection
|
|
host = self.get_option('host')
|
|
port = self.get_option('port')
|
|
socket = self.get_option('socket')
|
|
if socket is None:
|
|
conn = redis.Redis(host=host, port=port)
|
|
else:
|
|
conn = redis.Redis(unix_socket_path=socket)
|
|
|
|
ret = []
|
|
for term in terms:
|
|
try:
|
|
res = conn.get(term)
|
|
if res is None:
|
|
res = ""
|
|
ret.append(to_text(res))
|
|
except Exception as e:
|
|
# connection failed or key not found
|
|
raise AnsibleError(f'Encountered exception while fetching {term}: {e}')
|
|
return ret
|