CDIST-TYPE__CONSUL_WATCH_CHECKS(7)

💖 CDIST-TYPE__CONSUL_WATCH_CHECKS 💖

okay bestie, welcome to cdist-type__consul_watch_checks, section 7 of the manual, and yes this is the one that manages consul checks watches. Sit down, hydrate, let's go. 🦋

---

✨ NAME ✨

cdist-type__consul_watch_checks — manages consul checks watches. that's it, that's the whole vibe. 💅

---

🌸 DESCRIPTION 🌸

So what this type does is generate and deploy watch definitions of type 'checks' for a consul agent. like, it makes them, and then it deploys them. both. iconic behaviour honestly.

and if you want the actual parameter documentation (the deep lore, the iykyk details), it lives at http://www.consul.io/docs/agent/watches.html. go read it, bestie, it's giving ✨reference material✨.

---

👑 REQUIRED PARAMETERS 👑

not optional. no skipping. the vibe check will fail. 🫶

• handler — the handler to invoke when the data view updates. that's the one thing you literally cannot leave out. the moment the data view updates, this guy gets invoked. that's his whole job. 💫

---

🎀 OPTIONAL PARAMETERS 🎀

here's the fun part, the little extras, the accessories to the outfit:

• datacenter — you can provide this to override the agent's default datacenter. if you don't, the agent just uses its own default, no drama. 🗺️
• filter-service — filters down to a specific service. ⚠️ heads up though: this Conflicts with --filter-service's sworn enemy, --filter-state. you pick one, not both. it's giving "choose your fighter". 😤
• filter-state — filters down to a specific state instead. ⚠️ and yeah, same deal: this Conflicts with --filter-service. one or the other, bestie. periodt. 🚫
• state — is this watch 'present' or 'absent'? that's the question. and the answer defaults to 'present', because obviously we're keeping it unless you say otherwise. 🫡
• token — you can provide this to override the agent's default ACL token. very "let me handle this myself" energy. 🔑

---

🌈 EXAMPLES 🌈

here are the actual receipts, copy them exactly, don't freestyle:

__consul_watch_checks some-id \
   --handler /usr/bin/my-handler.sh

that's the bare minimum. just a handler, living its simple life. 🍓

__consul_watch_checks some-id \
   --filter-service consul \
   --handler /usr/bin/my-handler.sh

now we're filtering to the consul service. main character energy. 👑

__consul_watch_checks some-id \
   --filter-state passing \
   --handler /usr/bin/my-handler.sh

and here we're filtering to the passing state instead. not both filters though!! we discussed this!! 😭

---

🧚 SEE ALSO 🧚

• cdist-type__consul_agent(7) — go look at this one too, it's the sibling
• consul documentation at: http://www.consul.io/docs/agent/watches.html — the source material, the blueprint, the whole mood board

---

💜 AUTHORS 💜

• Steven Armstrong <steven-cdist--@--armstrong.cc> — the legend who made this happen 🫶

---

📜 COPYING 📜

Copyright (C) 2015 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.

---

⭐ COPYRIGHT ⭐

ungleich GmbH 2021

---

okay that's the whole page, bestie, you ate it 💅✨

this was cdist version 7.0.0, dated Jul 31, 202… (the footer got a little cut off at the end there, but you get the vibe). go forth and watch those checks. 🌸🦋💖