CDIST-TYPE__CONSUL_TEMPLATE(7)

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

💖 CDIST-TYPE__CONSUL_TEMPLATE 💖

okay bestie, welcome to cdist-type__consul_template(7) — yes it's a section 7 manual page, yes it's from cdist, and yes we are about to make your whole consul-template situation flawless. grab a strawberry 🍓 and let's go.

✨ NAME ✨

cdist-type__consul_template — manage the consul-template service. that's the whole vibe. one job, done gorgeously. 💅

🌸 DESCRIPTION 🌸

so what does this icon actually do? two things, and it does them with main character energy:

and here's the lil detail that matters, no cap: the consul-template binary gets downloaded on the server (that's the machine running cdist, not your target) and then it's deployed to the target host using the __file type. so the download happens over there, the delivery happens over here. cute, right? 🎀

🫶 REQUIRED PARAMETERS 🫶

None. literally zero. nothing is mandatory. you're free, bestie. 🦋

👑 OPTIONAL PARAMETERS 👑

these are the levers you can pull. all optional, all iconic:

  • auth-username — specify a username for basic authentication.
  • auth-password — specify a password for basic authentication.
  • batch-size — the size of the batch when polling multiple dependencies.
  • consul — the location of the Consul instance to query (may be an IP address or FQDN) with port. defaults to 'localhost:8500'.
  • log-level — the log level for output. this applies to the stdout/stderr logging as well as syslog logging (if enabled). valid values are "debug", "info", "warn", and "err". default value is "warn".
  • max-stale — the maximum staleness of a query. if specified, Consul will distribute work among all servers instead of just the leader.
  • retry — the amount of time to wait if Consul returns an error when communicating with the API.
  • state — either 'present' or 'absent'. defaults to 'present'.
  • ssl-cert — path to an SSL client certificate to use to authenticate to the consul server. useful if the consul server "verify_incoming" option is set.
  • ssl-ca-cert — path to a CA certificate file, containing one or more CA certificates to use to validate the certificate sent by the consul server to us. this is a handy alternative to setting --ssl-no-verify if you are using your own CA.
  • syslog-facility — the facility to use when sending to syslog. this requires the use of --syslog. default value is LOCAL0.
  • token — the Consul API token.
  • vault-address — the location of the Vault instance to query (may be an IP address or FQDN) with port.
  • vault-token — the Vault API token.
  • vault-ssl-cert — path to an SSL client certificate to use to authenticate to the vault server.
  • vault-ssl-ca-cert — path to a CA certificate file, containing one or more CA certificates to use to validate the certificate sent by the vault server to us.
  • version — which version of consul-template to install. see ./files/versions for a list of supported versions. defaults to the latest known version.
  • wait — the minimum(:maximum) to wait before rendering a new template to disk and triggering a command, separated by a colon (:). if the optional maximum value is omitted, it is assumed to be 4x the required minimum value.

💅 BOOLEAN PARAMETERS 💅

these ones are just on or off. no in-between, no situationship:

  • ssl — use HTTPS while talking to Consul. requires the Consul server to be configured to serve secure connections.
  • ssl-no-verify — ignore certificate warnings. only used if ssl is enabled.
  • syslog — send log output to syslog (in addition to stdout and stderr).
  • vault-ssl — use HTTPS while talking to Vault. requires the Vault server to be configured to serve secure connections.
  • vault-ssl-no-verify — ignore certificate warnings. only used if vault is enabled.

🌈 EXAMPLES 🌈

here's how it looks in the wild. copy, paste, slay:

__consul_template \
   --consul consul.service.consul:8500 \
   --retry 30s

and if you're feeling picky about versions (valid):

# specific version
__consul_template \
   --version 0.6.5 \
   --retry 30s

🔥 SEE ALSO 🔥

consul documentation at: <https://github.com/hashicorp/consul-template>.

go read it, iykyk. 📖✨

🎀 AUTHORS 🎀

Steven Armstrong <steven-cdist--@--armstrong.cc> — the legend 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.

ungleich GmbH 2021

okay that's the whole page, bestie!! 🫶 this was cdist 7.0.0, dated Jul 31, 2022, and yes it's the cdist-type__consul_template(7) manual. go configure something gorgeous. periodt. 💖✨

📦 where this page comes from