CDIST-TYPE__CONSUL_WATCH_KEY(7)

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

💅 cdist-type__consul_watch_key — the manual page, bestie edition

okay so this is cdist-type__consul_watch_key(7), a page from the cdist manual set, and it's literally all about making consul key watches happen for you. no cap. 🎀

✨ NAME ✨

cdist-type__consul_watch_key — manages consul key watches 🦋

🌸 DESCRIPTION 🌸

Generate and deploy watch definitions of type 'key' for a consul agent.

That's the whole vibe. This type does the generating, it does the deploying, and it does it for the 'key' watch type specifically. 🔥

For all the parameter documentation deets, go peek at http://www.consul.io/docs/agent/watches.html — the original page says so, and we respect the source. ✨

👑 REQUIRED PARAMETERS 👑

these ones? mandatory. you cannot skip them. the type will simply not be serving looks without them. 💅

  • handler — the handler to invoke when the data view updates. like, when the data changes, this is the thing that gets called. periodt. 🫶
  • key — the key to watch for changes. the actual thing you're keeping eyes on. 👀

🎀 OPTIONAL PARAMETERS 🎀

these ones are the little extras, the accessories to the fit. cute but not required. 🌈

  • datacenter — can be provided to override the agent's default datacenter. you wanna switch it up? go off. ⭐
  • state — if this watch is 'present' or 'absent'. Defaults to 'present'. so if you say nothing, it's present, and that's just the default behaviour, no cap. 🧚
  • token — can be provided to override the agent's default ACL token. another little override situation. 💜

🍓 EXAMPLES 🍓

here's how you actually use it, bestie. look at this gorgeous invocation:

__consul_watch_key some-id \
   --key foo/bar/baz \
   --handler /usr/bin/my-key-handler.sh

see how some-id is the id, then --key says what to watch, and --handler says who to call? chef's kiss. ate. 🔥💖

🌈 SEE ALSO 🌈

💜 AUTHORS 💜

Steven Armstrong <steven-cdist--@--armstrong.cc> — the icon who wrote this. 👑

📜 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, the license paragraph, exactly as it must be. legal girlies stay legal. 💅)

ungleich GmbH 2021

okay so real talk — this page came out of cdist 7.0.0, dated Jul 31, 2022, and that's the whole thing. go watch some keys, bestie. 💖✨🎀🦋🌸
📦 where this page comes from