community.general.consul – Добавление, изменение и удаление служб в кластере Consul.

Примечание

Этот плагин входит в коллекцию community.general (версия 2.0.1).

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

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

Обзор
Требования
Параметры
Примеры

Обзор

Регистрирует службы и проверяет наличие агента в кластере Consul. Служба — это какой-либо процесс, работающий на узле агента, который должен быть объявлен механизмом обнаружения Consul. Она может необязательно содержать определение проверки — периодическое тестирование службы, чтобы уведомить кластер Consul о состоянии службы.
Проверки также могут регистрироваться на узел, например, использование диска или процессора, и уведомлять кластер о состоянии всего узла. Проверки на уровне службы не требуют имени или идентификатора проверки, поскольку они выводятся Consul из имени и идентификатора службы соответственно путём добавления «service:». Проверки на уровне узла требуют *check_name* и необязательно *check_id*.
В настоящее время нет полного способа получения метаданных сценария, интервала или ttl для зарегистрированной проверки. Без этих метаданных невозможно определить, представляют ли данные, предоставленные Ansible, изменения в проверке. В результате это не пытается определить изменения и всегда сообщает о произошедших изменениях. Метод API для предоставления этих метаданных запланирован, и на этом этапе будет добавлена система управления изменениями.
Дополнительные сведения см. на странице http://consul.io.

Требования

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

python-consul
requests

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
check_id строка		Идентификатор проверки службы. Если state=absent, по умолчанию используется check_name. Игнорируется, если это часть определения службы.
check_name строка		Имя проверки службы. Требуется, если она автономна; игнорируется, если это часть определения службы.
host строка	По умолчанию: "localhost"	Хост агента consul, по умолчанию localhost
http строка		Проверки могут регистрироваться с HTTP-точкой входа. Это означает, что consul будет проверять, что HTTP-точка входа возвращает успешный HTTP-статус. Также необходимо указать interval.
interval строка		Интервал, с которым будет выполняться проверка службы. Это число с суффиксом s или m, обозначающим секунды или минуты соответственно, например `15s` или `1m`. Если суффикс не указан, по умолчанию используется m, например `1` будет `1m`. Требуется, если указан параметр script.
notes строка		Примечания, которые нужно добавить к проверке при ее регистрации.
port целое число	По умолчанию: 8500	Порт, на котором работает агент consul
scheme строка	По умолчанию: "http"	Схема протокола, по которому работает агент consul
script строка		Сценарий/команда, которая будет выполняться периодически для проверки состояния службы. Для сценариев требуется interval и наоборот.
service_address строка		Адрес, на котором служба будет прослушивать. Это значение будет передано в качестве параметра address в метод API Consul /v1/agent/service/register, поэтому для получения дополнительных сведений обратитесь к документации API Consul.
service_id строка		Идентификатор службы, должен быть уникальным для каждого узла. Если state=absent, по умолчанию используется имя службы, если оно указано.
service_name строка		Уникальное имя службы на узле, должно быть уникальным для каждого узла, требуется при регистрации службы. Может быть опущено при регистрации проверки на уровне узла
service_port целое число		Порт, на котором слушает служба. Можно необязательно указать при регистрации службы, то есть, если задано service_name или service_id
state строка	Варианты: present ← absent	Регистрация или отключение службы consul, по умолчанию present
tags список / элементы=строка		Теги, которые будут добавлены к регистрации службы.
tcp строка добавлен в 1.3.0 community.general		Проверки могут регистрироваться с TCP-портом. Это означает, что consul проверит, является ли попытка подключения к этому порту успешной (то есть, порт в настоящее время принимает подключения). Формат `host:port`, например `localhost:80`. Также необходимо указать interval.
timeout строка		Настройка таймаута HTTP-проверки. По умолчанию consul — 10 секунд. Аналогично интервалу, это число с суффиксом `s` или `m`, обозначающим секунды или минуты, например `15s` или `1m`.
token строка		Ключ токена, определяющий набор правил ACL. Может потребоваться для регистрации служб.
ttl строка		Проверки могут регистрироваться с ttl вместо script и interval, это означает, что служба будет проверяться у агента до истечения срока действия ttl. Если этого не происходит, проверка считается неудачной. Требуется при регистрации проверки, если сценарий и интервал отсутствуют. Аналогично интервалу, это число с суффиксом s или m, обозначающим секунды или минуты, например `15s` или `1m`. Если суффикс не указан, по умолчанию используется `m`, например `1` будет `1m`.
validate_certs логический тип	Варианты: no yes ←	Проверять ли TLS-сертификат агента consul

Примеры

- name: Register nginx service with the local consul agent
  community.general.consul:
    service_name: nginx
    service_port: 80

- name: Register nginx service with curl check
  community.general.consul:
    service_name: nginx
    service_port: 80
    script: curl http://localhost
    interval: 60s

- name: register nginx with a tcp check
  community.general.consul:
    service_name: nginx
    service_port: 80
    interval: 60s
    tcp: localhost:80

- name: Register nginx with an http check
  community.general.consul:
    service_name: nginx
    service_port: 80
    interval: 60s
    http: http://localhost:80/status

- name: Register external service nginx available at 10.1.5.23
  community.general.consul:
    service_name: nginx
    service_port: 80
    service_address: 10.1.5.23

- name: Register nginx with some service tags
  community.general.consul:
    service_name: nginx
    service_port: 80
    tags:
      - prod
      - webservers

- name: Remove nginx service
  community.general.consul:
    service_name: nginx
    state: absent

- name: Register celery worker service
  community.general.consul:
    service_name: celery-worker
    tags:
      - prod
      - worker

- name: Create a node level check to test disk usage
  community.general.consul:
    check_name: Disk usage
    check_id: disk_usage
    script: /opt/disk_usage.py
    interval: 5m

- name: Register an http check against a service that's already registered
  community.general.consul:
    check_name: nginx-check2
    check_id: nginx-check2
    service_id: nginx
    interval: 60s
    http: http://localhost:80/morestatus

Авторы

Steve Gargan (@sgargan)

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