community.general.consul_kv 查询 – 从 Consul 键值存储中获取元数据。

注意

此查找插件是 community.general 集合 (版本 10.1.0) 的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install community.general。您需要其他要求才能使用此查找插件，有关详细信息，请参阅 要求。

要在 playbook 中使用它，请指定： community.general.consul_kv。

概要

  • 从 Consul 集群中的键值存储中查找 playbook 的元数据。可以使用简单的 REST 命令轻松地在 kv 存储中设置值

  • curl -X PUT -d 'some-value' https://127.0.0.1:8500/v1/kv/ansible/somedata

要求

以下要求是在执行此查找的本地控制器节点上所需的。

关键字参数

此部分描述了查找的关键字参数。这些是在以下示例中的值 key1=value1，key2=value2 等： lookup('community.general.consul_kv', key1=value1, key2=value2, ...) 和 query('community.general.consul_kv', key1=value1, key2=value2, ...)

参数

注释

_raw

列表 / 元素=字符串

要检索的键列表。

client_cert

字符串

用于验证 TLS 连接的客户端证书。

配置

datacenter

字符串

从consul主机默认值以外的consul数据中心检索密钥。

host

字符串

要连接的目标，必须是可解析的地址。

如果设置了 ANSIBLE_CONSUL_URL，则将从此处确定。

默认值： "localhost"

配置

  • INI 条目

    [lookup_consul]
host = localhost

index

整数

如果密钥具有指定索引的值，则返回此值，从而允许访问历史值。

port

整数

要连接到的目标主机的端口。

如果您使用 ANSIBLE_CONSUL_URL，则将从此处使用此值。

默认值： 8500

recurse

布尔值

如果为真，将检索所有以给定键为前缀的值。

选项

  • false ← (默认)

  • true

scheme

字符串

是否使用 http 或 https。

如果您使用 ANSIBLE_CONSUL_URL，则将从此处使用此值。

默认值： "http"

token

字符串

允许访问受限值的 acl 令牌。

url

字符串

在 community.general 1.0.0 中添加

要连接到的目标。

应如下所示： https://my.consul.server:8500。

配置

validate_certs

布尔值

是否验证TLS连接。

选项

  • false

  • true ← (默认)

配置

示例

- ansible.builtin.debug:
    msg: 'key contains {{item}}'
  with_community.general.consul_kv:
    - 'key/to/retrieve'

- name: Parameters can be provided after the key be more specific about what to retrieve
  ansible.builtin.debug:
    msg: 'key contains {{item}}'
  with_community.general.consul_kv:
    - 'key/to recurse=true token=E6C060A9-26FB-407A-B83E-12DDAFCB4D98'

- name: retrieving a KV from a remote cluster on non default port
  ansible.builtin.debug:
    msg: "{{ lookup('community.general.consul_kv', 'my/key', host='10.10.10.10', port=2000) }}"

返回值

键

描述

返回值

字典

存储在Consul中的值。

返回：成功

作者

  • 未知

提示

每个条目类型的配置项具有从低到高的优先级顺序。例如，列表中较低的变量将覆盖较高的变量。