Модуль community.general.consul_kv — управление записями в хранилище ключей/значений кластера Consul

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля требуются дополнительные компоненты. Подробнее см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: community.general.consul_kv.

Краткое описание
Требования
Параметры
Атрибуты
Примеры

Краткое описание

Позволяет получать, добавлять, изменять и удалять записи «ключ/значение» в кластере Consul с помощью агента. Полное содержимое записи, включая индексы, флаги и сеанс, возвращается как value.
Если key обозначает префикс, обратите внимание: при удалении значения существующее значение, если оно есть, возвращается в составе результатов.
Подробнее см. на странице http://www.consul.io/docs/agent/http.html#kv.

Требования

Следующие требования должны быть выполнены на узле, на котором запускается этот модуль.

py-consul
requests

Параметры

Параметр	Комментарии
ca_path строка добавлено в community.general 12.6.0	Пакет CA-сертификатов для HTTPS-подключений.
cas строка	Используется при получении блокировки с помощью сеанса. Если `cas` равен `0`, Consul добавляет ключ, только если он ещё не существует. Если значение `cas` не равно нулю, ключ задаётся, только если индекс совпадает с ModifyIndex этого ключа.
datacenter строка добавлено в community.general 10.0.0	Имя центра обработки данных, к которому выполняется запрос. Если не указано, запрос выполняется к центру обработки данных агента Consul на `host`.
flags строка	Непрозрачное положительное целое число, которое можно передать при задании значения.
host строка	Узел агента Consul. По умолчанию: `"localhost"`
key строка / обязательный	Ключ, по которому следует сохранить значение.
port целое число	Порт, на котором работает агент Consul. По умолчанию: `8500`
recurse логический	Если ключ обозначает префикс, для получения каждой записи с этим префиксом задайте значение `true`. Варианты: `false` `true`
retrieve логический	Если `state` равен `present` и задан `value`, после установки значения выполняется чтение и возвращается это значение. Варианты: `false` `true` ← (по умолчанию)
scheme строка	Схема протокола, по которой работает агент Consul. По умолчанию: `"http"`
session строка	Сеанс, который следует использовать для получения или снятия блокировки, связанной с парой ключ/значение.
state строка	Действие, которое необходимо выполнить с указанными ключом и значением. Если состояние равно `present` и задан `value`, содержимое ключа устанавливается в указанное значение, а `changed` устанавливается в `true`, только если значение отличается от текущего содержимого. Если состояние равно `present` и `value` не задан, возвращается существующее значение, связанное с ключом. Состояние `absent` используется для удаления пары ключ/значение; `changed` устанавливается в `true`, только если ключ действительно существовал до удаления. Попытаться получить или снять блокировку, связанную с парой ключ/значение, можно с помощью состояний `acquire` и `release` соответственно. Для выполнения попытки необходимо указать действительный сеанс. `changed` равен `true`, если попытка успешна, и `false` в противном случае. Варианты: `"absent"` `"acquire"` `"present"` ← (по умолчанию) `"release"`
token строка	Ключ токена, идентифицирующий набор правил ACL, который управляет доступом к паре ключ/значение.
validate_certs логический	Следует ли проверять TLS-сертификат агента Consul. Вместо того чтобы задавать значение `false`, рассмотрите возможность использовать `ca_path`. Варианты: `false` `true` ← (по умолчанию)
value строка	Значение, связанное с указанным ключом; обязательно, если `state` равно `present`.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Модуль может работать в режиме `check_mode` и возвращать прогноз изменения статуса, не изменяя целевой объект.
diff_mode	Поддержка: нет	В режиме diff возвращает сведения об изменениях (или о возможных изменениях в `check_mode`).

Примеры

# If the key does not exist, the value associated to the "data" property in `retrieved_key` will be `None`
# If the key value is empty string, `retrieved_key["data"]["Value"]` will be `None`
- name: Retrieve a value from the key/value store
  community.general.consul_kv:
    key: somekey
  register: retrieved_key

- name: Add or update the value associated with a key in the key/value store
  community.general.consul_kv:
    key: somekey
    value: somevalue

- name: Remove a key from the store
  community.general.consul_kv:
    key: somekey
    state: absent

- name: Add a node to an arbitrary group using Consul inventory (see consul.ini)
  community.general.consul_kv:
    key: ansible/groups/dc1/somenode
    value: top_secret

- name: Register a key/value pair with an associated session
  community.general.consul_kv:
    key: stg/node/server_birthday
    value: 20160509
    session: "{{ sessionid }}"
    state: acquire

Авторы

Steve Gargan (@sgargan)
Colin Nolan (@colin-nolan)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/consul_kv_module.html