community.general.consul_agent_check модуль — Добавление, изменение и удаление проверок в кластере consul

Примечание

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

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

Для её установки используйте: ansible-galaxy collection install community.general.

Для использования в плейбуке укажите: community.general.consul_agent_check.

Добавлена в community.general 9.1.0

Описание
Параметры
Атрибуты
Примеры
Возвращаемые значения

Описание

Позволяет добавлять, изменять и удалять проверки в кластере consul через агент. Для более подробной информации об использовании и настройке проверок см. https://developer.hashicorp.com/consul/api-docs/agent/check.
В настоящее время нет полного способа получить метаданные сценария, интервала или TTL для зарегистрированной проверки. Без этих метаданных невозможно определить, представляют ли данные, предоставленные ansible, изменения в проверке. В результате модуль всегда будет сообщать о произошедших изменениях. Планируется добавить API-метод для предоставления этих метаданных, после чего будет реализована система управления изменениями.

Параметры

Параметр	Комментарии
args список / элементы=строка	Указывает аргументы команды для запуска с целью обновления статуса проверки. Требуется `interval`. Исключающие параметры: `ttl`, `tcp` и `http`.
ca_path строка	Файл сертификатов CA для использования в https-соединениях
host строка	Хост агента consul, по умолчанию `localhost`. По умолчанию: `"localhost"`
http строка	Проверки могут быть зарегистрированы с помощью HTTP-эндпоинта. Это означает, что consul будет проверять, возвращает ли HTTP-эндпоинт успешный HTTP-статус. Требуется `interval`. Исключающие параметры: `args`, `ttl` и `tcp`.
id строка	Указывает уникальный идентификатор этой проверки на узле. По умолчанию используется параметр `name`, но может потребоваться указать ID для уникальности. Это значение вернётся в ответе как «CheckId».
interval строка	Интервал, с которым будет выполняться проверка сервиса. Это число с суффиксом `s` или `m` для обозначения единиц измерения в секундах или минутах, например `15s` или `1m`. Если суффикс не указан, по умолчанию используется `s`, например `10` будет `10s`. Требуется, если указан один из параметров `args`, `http`, или `tcp`.
name строка	Требуемое имя для проверки сервиса.
notes строка	Примечания, которые нужно добавить к проверке при её регистрации.
port целое число	Порт, на котором работает агент consul. По умолчанию: `8500`
scheme строка	Схема протокола, на котором работает агент consul. По умолчанию `http`, может быть установлена в `https` для защищённых соединений. По умолчанию: `"http"`
service_id строка	Идентификатор сервиса, должен быть уникальным для каждого узла. Если `state=absent`, по умолчанию используется имя сервиса, если оно указано.
state строка	Указывает, должна ли проверка быть присутствующей или отсутствующей. Варианты: `"present"` ← (по умолчанию) `"absent"`
tcp строка добавлен в community.general 1.3.0	Проверки могут быть зарегистрированы с TCP-портом. Это означает, что consul проверит, успешно ли подключение к этому порту (то есть порт в настоящее время принимает соединения). Формат: `host:port`, например `localhost:80`. Требуется `interval`. Исключающие параметры: `args`, `ttl` и `http`.
timeout строка	Настройка времени ожидания HTTP-проверки. Значение по умолчанию в consul — 10 секунд. Аналогично параметру interval, это число с суффиксом `s` или `m` для обозначения единиц измерения в секундах или минутах, например `15s` или `1m`. Если суффикс не указан, по умолчанию используется `s`, например `10` будет `10s`.
token строка	Токен для авторизации.
ttl строка	Проверки могут быть зарегистрированы с TTL вместо `args` и `interval`. Это означает, что сервис будет проверять подключение с агентом до истечения TTL. Если это не произойдёт, проверка считается проваленной. Требуется при регистрации проверки, если отсутствуют параметры интервала и сценария. Аналогично параметру interval, это число с суффиксом `s` или `m` для обозначения единиц измерения в секундах или минутах, например `15s` или `1m`. Если суффикс не указан, по умолчанию используется `s`, например `10` будет `10s`. Исключающие параметры: `args`, `tcp` и `http`.
validate_certs логическое значение	Проверять ли TLS-сертификат агента consul. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.general.consul	Используйте `group/community.general.consul` в `module_defaults` для установки значений по умолчанию для данного модуля.
check_mode	Поддержка: полная Результат — объект, как он определен в параметрах модуля, а не структура объекта API Consul. Для лучшего представления структуры объекта обратитесь к https://developer.hashicorp.com/consul/api-docs/agent/check#list-checks.	Может работать в режиме `check_mode` и возвращать прогноз изменения статуса без модификации целевого объекта.
diff_mode	Поддержка: частичная В режиме проверки разница будет отображать объект так, как он определен в параметрах модуля, а не как структура объекта API Consul.	Возвращает подробности о том, что изменилось (или, возможно, требует изменения в `check_mode`), при работе в режиме сравнения.

Примеры

- name: Register tcp check for service 'nginx'
  community.general.consul_agent_check:
    name: nginx_tcp_check
    service_id: nginx
    interval: 60s
    tcp: localhost:80
    notes: "Nginx Check"

- name: Register http check for service 'nginx'
  community.general.consul_agent_check:
    name: nginx_http_check
    service_id: nginx
    interval: 60s
    http: http://localhost:80/status
    notes: "Nginx Check"

- name: Remove check for service 'nginx'
  community.general.consul_agent_check:
    state: absent
    id: nginx_http_check
    service_id: "{{ nginx_service.ID }}"

Значения возврата

Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
check словарь	Проверка, возвращаемая API Consul по HTTP. Возвращается: всегда Пример: `{"CheckID": "nginx_check", "Interval": "30s", "Notes": "Nginx Check", "ServiceID": "nginx", "Type": "http"}`
operation строка	Выполненная операция. Возвращается: изменено Пример: `"update"`

Авторы

Михаил Ильг (@Ilgmi)

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

© 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_agent_check_module.html