cdist-type__consul

cdist-type__consul_check(7)

Steven Armstrong

<steven-cdist--@--armstrong.cc>

Table of Contents

1. NAME
2. DESCRIPTION
3. REQUIRED PARAMETERS
4. OPTIONAL PARAMETERS
5. EXAMPLES
6. SEE ALSO
7. COPYING

1. NAME

cdist-type__consul_check - manages consul checks

2. DESCRIPTION

Generate and deploy check definitions for a consul agent. See http://www.consul.io/docs/agent/checks.html for parameter documentation.

Use either script toghether with interval, or use ttl.

3. REQUIRED PARAMETERS

None.

4. OPTIONAL PARAMETERS

interval: the interval in which the script given with --script should be run
script: the shell command to run every --interval
ttl: how long a check is considered healthy without being updated through the HTTP interfave
id: Defaults to --name
name: The name of this check. Defaults to __object_id
notes: human readable description
state: if this check is present or absent. Defaults to present.

5. EXAMPLES

__consul_check redis \
   --script /usr/local/bin/check_redis.py \
   --interval 10s

__consul_check some-object-id \
   --id web-app \
   --name "Web App Status" \
   --notes "Web app does a curl internally every 10 seconds" \
   --ttl 30s