ansible / ansible.builtin / v2.9.27 / module / consul Add, modify & delete services within a consul cluster. | "added in version" 2.0 of ansible.builtin" Authors: Steve Gargan (@sgargan) preview | supported by communityansible.builtin.consul (v2.9.27) — module
pip
Install with pip install ansible==2.9.27
Registers services and checks for an agent with a consul cluster. A service is some process running on the agent node that should be advertised by consul's discovery mechanism. It may optionally supply a check definition, a periodic service test to notify the consul cluster of service's health.
Checks may also be registered per node e.g. disk usage, or cpu usage and notify the health of the entire node to the cluster. Service level checks do not require a check name or id as these are derived by Consul from the Service name and id respectively by appending 'service:' Node level checks require a I(check_name) and optionally a I(check_id).
Currently, there is no complete way to retrieve the script, interval or ttl metadata for a registered check. Without this metadata it is not possible to tell if the data supplied with ansible represents a change to a check. As a result this does not attempt to determine changes and will always report a changed occurred. An API method is planned to supply this metadata so at that stage change management will be added.
See U(http://consul.io) for more details.
- name: register nginx service with the local consul agent consul: service_name: nginx service_port: 80
- name: register nginx service with curl check consul: service_name: nginx service_port: 80 script: curl http://localhost interval: 60s
- name: register nginx with an http check 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 consul: service_name: nginx service_port: 80 service_address: 10.1.5.23
- name: register nginx with some service tags consul: service_name: nginx service_port: 80 tags: - prod - webservers
- name: remove nginx service consul: service_name: nginx state: absent
- name: register celery worker service consul: service_name: celery-worker tags: - prod - worker
- name: create a node level check to test disk usage 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 consul: check_name: nginx-check2 check_id: nginx-check2 service_id: nginx interval: 60s http: http://localhost:80/morestatus
ttl: description: - checks can be registered with a ttl instead of a I(script) and I(interval) this means that the service will check in with the agent before the ttl expires. If it doesn't the check will be considered failed. Required if registering a check and the script an interval are missing Similar to the interval this is a number with a s or m suffix to signify the units of seconds or minutes e.g C(15s) or C(1m). If no suffix is supplied, C(m) will be used by default e.g. C(1) will be C(1m) type: str host: default: localhost description: - host of the consul agent defaults to localhost type: str http: description: - checks can be registered with an HTTP endpoint. This means that consul will check that the http endpoint returns a successful HTTP status. I(interval) must also be provided with this option. type: str version_added: '2.0' version_added_collection: ansible.builtin port: default: 8500 description: - the port on which the consul agent is running type: int tags: description: - tags that will be attached to the service registration. type: list notes: description: - Notes to attach to check when registering it. type: str state: choices: - present - absent default: present description: - register or deregister the consul service, defaults to present token: description: - the token key identifying an ACL rule set. May be required to register services. type: str scheme: default: http description: - the protocol scheme on which the consul agent is running type: str version_added: '2.1' version_added_collection: ansible.builtin script: description: - the script/command that will be run periodically to check the health of the service. Scripts require I(interval) and vice versa. type: str timeout: description: - A custom HTTP check timeout. The consul default is 10 seconds. Similar to the interval this is a number with a C(s) or C(m) suffix to signify the units of seconds or minutes, e.g. C(15s) or C(1m). type: str version_added: '2.0' version_added_collection: ansible.builtin check_id: description: - an ID for the service check. If I(state=absent), defaults to I(check_name). Ignored if part of a service definition. type: str interval: description: - the interval at which the service check will be run. This is a number with a s or m suffix to signify the units of seconds or minutes e.g C(15s) or C(1m). If no suffix is supplied, m will be used by default e.g. C(1) will be C(1m). Required if the I(script) parameter is specified. type: str check_name: description: - a name for the service check. Required if standalone, ignored if part of service definition. type: str service_id: description: - the ID for the service, must be unique per node. If I(state=absent), defaults to the service name if supplied. type: str service_name: description: - Unique name for the service on a node, must be unique per node, required if registering a service. May be omitted if registering a node level check type: str service_port: description: - the port on which the service is listening. Can optionally be supplied for registration of a service, i.e. if I(service_name) or I(service_id) is set type: int validate_certs: default: 'yes' description: - whether to verify the TLS certificate of the consul agent type: bool version_added: '2.1' version_added_collection: ansible.builtin service_address: description: - the address to advertise that the service will be listening on. This value will be passed as the I(address) parameter to Consul's U(/v1/agent/service/register) API method, so refer to the Consul API documentation for further details. type: str version_added: '2.1' version_added_collection: ansible.builtin