1CDIST-TYPE__CONSUL_CHECK(7)          cdist         CDIST-TYPE__CONSUL_CHECK(7)
2
3
4

NAME

6       cdist-type__consul_check - Manages consul checks
7

DESCRIPTION

9       Generate  and  deploy  check  definitions  for  a  consul  agent.   See
10       http://www.consul.io/docs/agent/checks.html  for  parameter  documenta‐
11       tion.
12
13       Use either script together with interval, or use ttl.
14

REQUIRED PARAMETERS

16       None.
17

OPTIONAL PARAMETERS

19       docker-container-id
20              the id of the docker container to run
21
22       http   the url to check
23
24       id     The id of this check.
25
26       interval
27              the interval in which the check should run
28
29       name   The name of this check. Defaults to __object_id
30
31       notes  human readable description
32
33       script the shell command to run
34
35       service-id
36              the id of the service this check is bound to
37
38       shell  the shell to run inside the docker container
39
40       state  if this check is 'present' or 'absent'. Defaults to 'present'.
41
42       status specify the initial state of this health check
43
44       tcp    the host and port to check
45
46       timeout
47              after how long to timeout checks which take to long
48
49       token  ACL token to use for interacting with the catalog
50
51       ttl    how long a TTL check is considered healthy without being updated
52              through the HTTP interface
53

EXAMPLES

55          __consul_check redis \
56             --script /usr/local/bin/check_redis.py \
57             --interval 10s
58
59          __consul_check some-object-id \
60             --id web-app \
61             --name "Web App Status" \
62             --notes "Web app does a curl internally every 10 seconds" \
63             --ttl 30s
64

SEE ALSO

66       cdist-type__consul_agent(7)
67

AUTHORS

69       Steven Armstrong <steven-cdist--@--armstrong.cc>
70

COPYING

72       Copyright (C) 2015-2016  Steven  Armstrong.  You  can  redistribute  it
73       and/or  modify  it under the terms of the GNU General Public License as
74       published by the Free Software Foundation, either version 3 of the  Li‐
75       cense, or (at your option) any later version.
76

78       ungleich GmbH 2020
79
80
81
82
836.9.6                            Apr 20, 2021      CDIST-TYPE__CONSUL_CHECK(7)
Impressum