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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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"`
http строка	Проверки можно зарегистрировать для конечной точки HTTP. В этом случае Consul проверяет, возвращает ли конечная точка HTTP успешный статус. Требуется указать `interval`. Взаимоисключающий параметр с `args`, `ttl` и `tcp`.
id строка	Задает уникальный идентификатор этой проверки на узле. По умолчанию используется параметр `name`, но для обеспечения уникальности может потребоваться указать идентификатор. Это значение возвращается в ответе как `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 секунд. Как и интервал, это число с суффиксом `s` или `m`, обозначающим единицы измерения — секунды или минуты, например `15s` или `1m`. Если суффикс не указан, по умолчанию используется `s`; например, `10` эквивалентно `10s`.
token строка	Токен для авторизации.
ttl строка	Проверки можно зарегистрировать с TTL вместо `args` и `interval`; в этом случае служба должна отчитаться агенту до истечения TTL. В противном случае проверка считается не пройденной. Обязателен при регистрации проверки, если не заданы скрипт и интервал. Как и интервал, это число с суффиксом `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 словарь	Проверка в том виде, в котором ее возвращает HTTP API Consul. Возвращается: всегда Пример: `{"CheckID": "nginx_check", "Interval": "30s", "Notes": "Nginx Check", "ServiceID": "nginx", "Type": "http"}`
operation строка	Выполненная операция. Возвращается: при изменении Пример: `"update"`

Авторы

Michael Ilg (@Ilgmi)

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

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