CDIST-TYPE__CONSUL_WATCH_SERVICE(7)

📦
version 7.0.0 · 8 versions
, in fedora 43, fedora 44

💖 cdist-type__consul_watch_service 💖

okay bestie, welcome to the manual page for cdist-type__consul_watch_service — it's a cdist type, it's section 7, and it is literally your new fave. let's get into it 🦋

✨ NAME ✨

cdist-type__consul_watch_service — she manages consul service watches, and she does it flawlessly 👑

🌸 DESCRIPTION 🌸

This type generates and deploys watch definitions of type 'service' for a consul agent. that's the whole vibe. 🎀

for all the parameter documentation, go look at <http://www.consul.io/docs/agent/watches.html> — no cap, it's all there.

💅 REQUIRED PARAMETERS 💅

these ones? not optional. you need them, fr fr.

  • handler — the handler to invoke when the data view updates. like, when the data goes "new info bestie", this is who gets called 🫶
  • service — the service to watch for changes. the main character you're keeping an eye on 👀

🎀 OPTIONAL PARAMETERS 🎀

these are the little extras you can add if you feel like it. slay.

  • datacenter — can be provided to override the agent's default datacenter ✨
  • state — if this watch is 'present' or 'absent'. Defaults to 'present'. 💖
  • token — can be provided to override the agent's default ACL token 🔑
  • tag — filter by tag 🏷️

🌈 BOOLEAN PARAMETERS 🌈

just flip it on, no value needed, iconic behaviour honestly.

  • passingonly — specifies if only hosts passing all checks are displayed ✅

⭐ EXAMPLES ⭐

here's the tea, copy these exactly, don't freestyle:

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

__consul_watch_service some-id \
   --service redis \
   --tag production \
   --handler /usr/bin/my-handler.sh

__consul_watch_service some-id \
   --service redis \
   --tag production \
   --passingonly \
   --handler /usr/bin/my-handler.sh

see how they escalate? consul → redis → redis with --tag production → and then --passingonly joins the party. character development. 💀✨

👑 SEE ALSO 👑

🫶 AUTHORS 🫶

  • Steven Armstrong <steven-cdist--@--armstrong.cc> — thank you for your service, king 🎀

💜 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.

yes bestie, that's the GPL v3-or-later situation, read it, respect it, live it 💅

ungleich GmbH 2021

and that's the whole page!! this was cdist-type__consul_watch_service, from cdist, version 7.0.0, dated Jul 31 — mwah, take care of her, she's precious 🧚💖

📦 where this page comes from