CDIST-TYPE__CONSUL_CHECK(7)

💖 cdist-type__consul_check — the manual page 💖

okay so bestie, welcome to cdist-type__consul_check(7), aka the cdist type that manages consul checks. yes, that's the whole title, we're not doing the boring header line, we're doing vibes.

---

✨ NAME ✨

cdist-type__consul_check — manages consul checks 🎀

---

🌸 DESCRIPTION 🌸

It generates and deploys check definitions for a consul agent. literally that's its whole job and it eats every time. 💅

For the parameter documentation, go peek at http://www.consul.io/docs/agent/checks.html — that's the source of truth, bestie, I don't make the rules.

⚠️ real talk: you gotta use either script together with interval, or use ttl. Pick a lane, babe. 🫶

---

💜 REQUIRED PARAMETERS 💜

None. 😌 nothing is mandatory, she's low maintenance, we love that for her.

---

🦋 OPTIONAL PARAMETERS 🦋

• docker-container-id — the id of the docker container to run 🐳
• http — the url to check
• id — The id of this check. (capital T, capital I, she's that girl)
• interval — the interval in which the check should run ⏰
• name — The name of this check. Defaults to __object_id (so if you don't name her, she names herself, main character energy fr fr)
• notes — human readable description ✍️
• script — the shell command to run
• service-id — the id of the service this check is bound to
• shell — the shell to run inside the docker container 🐚
• state — if this check is 'present' or 'absent'. Defaults to 'present'.
• status — specify the initial state of this health check
• tcp — the host and port to check
• timeout — after how long to timeout checks which take to long ⌛
• token — ACL token to use for interacting with the catalog 🔑
• ttl — how long a TTL check is considered healthy without being updated through the HTTP interface

---

⭐ EXAMPLES ⭐

okay here's the tea, two whole examples, no cap:

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

and the glow-up version with all the extras:

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

see how she uses --ttl in the second one instead of --script + --interval? that's the rule from up top, bestie. iykyk. 🌈

---

👑 SEE ALSO 👑

• cdist-type__consul_agent(7) — go read her too, she's iconic 💖

---

🎀 AUTHORS 🎀

Steven Armstrong <steven-cdist--@--armstrong.cc> — the legend, the moment, the blueprint ✨

---

💅 COPYING 💅

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

(periodt. that's the license, don't @ me.) 💀

---

🌟 COPYRIGHT 🌟

ungleich GmbH 2021

---

and that's a wrap, bestie 🫶 this was cdist type manual page version 7.0.0, dated Jul 31, 2022. slay, go deploy some checks, mwah 💖✨🎀🦋🌸