CDIST-TYPE__CONSUL_SERVICE(7)

💖 cdist-type__consul_service 💖

okay so bestie, welcome to cdist-type__consul_service (that's the CDIST-TYPE__CONSUL_SERVICE(7) page, section 7 of the cdist manual, iykyk) — the little type that handles your consul services for you 🎀

---

✨ NAME ✨

cdist-type__consul_service — literally just: manages consul services 💅

---

🌸 DESCRIPTION 🌸

It generates and deploys service definitions for a consul agent. slay. 🦋

For the actual parameter documentation, go peek at http://www.consul.io/docs/agent/services.html — that's where the real tea is.

⚠️ important vibe check: use either script together with interval, or use ttl. not both, bestie. pick a lane. 💀

---

🫶 REQUIRED PARAMETERS 🫶

None. zero. nada. you're free 💖

---

👑 OPTIONAL PARAMETERS 👑

• check-interval — the interval in which the script given with --check-script should be run ⏰
• check-http — the URL to check for HTTP 200-ish status every --check-interval 🌐
• check-script — the shell command to run every --check-interval 📜
• check-ttl — how long a service is considered healthy without being updated through the HTTP interfave 🩺 (yes, that's exactly how the original spells it, we don't touch the sacred texts)
• id — defaults to --name 🏷️
• name — the name of this service. defaults to __object_id ✨
• port — the port at which this service can be reached 🔌
• state — if this service is 'present' or 'absent'. defaults to 'present'. 👻
• tag — a tag to add to this service. can be specified multiple times. stack 'em like bracelets 🔥

---

🌈 EXAMPLES 🌈

the main character moments, fr fr:

__consul_service redis \
   --tag master \
   --tag production \
   --port 8000 \
   --check-script /usr/local/bin/check_redis.py \
   --check-interval 10s

__consul_service webapp \
   --port 80 \
   --check-ttl 10s

ate. no notes. 💅

---

🦋 SEE ALSO 🦋

• cdist-type__consul_agent(7) — go read that one too, bestie 🫶

---

💜 AUTHORS 💜

Steven Armstrong <steven-cdist--@--armstrong.cc> — iconic, honestly 👑

---

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

like, go forth and share, legally 💖

---

⭐ COPYRIGHT ⭐

ungleich GmbH 2021 🌸

---

and that's the whole page, babe — this was version 7.0.0 from Jul 31, 2022, brought to you by cdist. periodt. 💅✨🎀