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

Примечание

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

Эта коллекция, возможно, уже установлена, если вы используете пакет 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.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

python-consul
requests

Параметры

Параметр	Комментарии
cas строка	Используется при получении блокировки с помощью сессии. Если `cas` равно `0`, Consul добавит ключ только если он еще не существует. Если `cas` не равно нулю, ключ устанавливается только в том случае, если индекс совпадает с ModifyIndex этого ключа.
flags строка	Непрозрачное положительное целое значение, которое можно передать при установке значения.
host строка	Хост агента Consul. По умолчанию: `"localhost"`
ключ строка / обязательно	Ключ, по которому должно храниться значение.
порт целое число	Порт, на котором работает агент Consul. По умолчанию: `8500`
рекурсия булево	Если ключ представляет собой префикс, каждое вхождение с префиксом можно получить, установив это значение в `true`. Варианты: `false` `true`
получить булево	Если `state` равно `present` и `value` установлено, выполняется чтение после установки значения и возвращается это значение. Варианты: `false` `true` ← (по умолчанию)
схема строка	Протокол, по которому работает агент Consul. По умолчанию: `"http"`
сессия строка	Сессия, которая должна использоваться для получения или освобождения блокировки, связанной с парой ключ/значение.
состояние строка	Действие, которое необходимо выполнить с заданным ключом и значением. Если состояние равно `present` и `value` установлено, содержимое ключа будет установлено в предоставленное значение, и `changed` будет установлено в `true` только в том случае, если значение отличалось от текущего содержимого. Если состояние равно `present` и `value` не установлено, возвращается текущее значение, связанное с ключом. Состояние `absent` удалит пару ключ/значение, а `changed` будет установлено в `true` только если ключ существовал до удаления. Можно попытаться получить или освободить блокировку, связанную с парой ключ/значение, используя состояния `acquire` или `release` соответственно. Для попытки необходима валидная сессия. Измененное значение будет истинным, если попытка успешна, ложным в противном случае. Варианты: `"absent"` `"acquire"` `"present"` ← (по умолчанию) `"release"`
токен строка	Ключ токена, определяющий набор правил ACL, которые контролируют доступ к паре ключ/значение.
проверка_сертификатов булево	Требуется ли проверка TLS-сертификата агента Consul. Варианты: `false` `true` ← (по умолчанию)
значение строка	Значение, которое должно быть связано с заданным ключом. Требуется, если `state` равно `present`.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогнозируемый результат изменения статуса без модификации целевого объекта.
diff_mode	Поддержка: нет	Возвращает детали того, что изменилось (или, возможно, требует изменения в `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 via 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/consul_kv_module.html