Man page - cdist-type__consul_template(7)
Packages contas this manual
- cdist-type__golang_from_vendor(7)
- cdist-type__install_config(7)
- cdist-dump(1)
- cdist-type__sed(7)
- cdist-type__download(7)
- cdist-type__sensible_editor(7)
- cdist-type__consul_service(7)
- cdist-type__cron(7)
- cdist-type__consul_watch_checks(7)
- cdist-type__install_mount(7)
- cdist-type__key_value(7)
- cdist-type__git(7)
- cdist-type__docker_compose(7)
- cdist-type__line(7)
- cdist-type__install_mkfs(7)
- cdist-type__apt_ppa(7)
- cdist-type__package_luarocks(7)
- cdist-type__docker_secret(7)
- cdist-type__locale(7)
- cdist-type__mysql_privileges(7)
- cdist-type__install_fstab(7)
- cdist-type__install_reset_disk(7)
- cdist-type__ccollect_source(7)
- cdist-type__consul_watch_nodes(7)
- cdist-type__pacman_conf(7)
- cdist-type__install_reboot(7)
- cdist-type__package_yum(7)
- cdist-type__iptables_rule(7)
- cdist-type__haproxy_dualstack(7)
- cdist-type__user(7)
- cdist-type__snakeoil_cert(7)
- cdist-type__package_emerge_dependencies(7)
- cdist-type__letsencrypt_cert(7)
- cdist-type__prometheus_server(7)
- cdist-type__update_alternatives(7)
- cdist-type__rvm_gem(7)
- cdist-type__zypper_repo(7)
- cdist-type__apt_update_index(7)
- cdist-type__motd(7)
- cdist-type__install_partition_msdos(7)
- cdist-type__rbenv(7)
- cdist-type__openldap_server(7)
- cdist-type__start_on_boot(7)
- cdist-type__install_chroot_mount(7)
- cdist-type__filesystem(7)
- cdist-type__rvm_ruby(7)
- cdist-type__install_stage(7)
- cdist-type__consul_template(7)
- cdist-type__mysql_database(7)
- cdist-type__package_apt(7)
- cdist-type__apt_source(7)
- cdist-type__package(7)
- cdist-type__unpack(7)
- cdist-type__docker(7)
- cdist-type__block(7)
- cdist-type__postgres_database(7)
- cdist-type__pyvenv(7)
- cdist-type__consul_watch_service(7)
- cdist-type__iptables_apply(7)
- cdist-type__apt_default_release(7)
- cdist-type__install_umount(7)
- cdist-type__clean_path(7)
- cdist-type__systemd_service(7)
- cdist-type__staged_file(7)
- cdist-type__apt_key_uri(7)
- cdist-type__chroot_umount(7)
- cdist-type__localedef(7)
- cdist-type__systemd_unit(7)
- cdist-type__consul_check(7)
- cdist-type__hostname(7)
- cdist-type__xymon_server(7)
- cdist-type__daemontools(7)
- cdist-type__group(7)
- cdist-type__firewalld_rule(7)
- cdist-type__consul_watch_event(7)
- cdist-type__postgres_extension(7)
- cdist-type__apt_norecommends(7)
- cdist-new-type(1)
- cdist-type__consul_reload(7)
- cdist-type__package_pkg_freebsd(7)
- cdist-type__package_dpkg(7)
- cdist-type__link(7)
- cdist-type__consul_agent(7)
- cdist-type__postfix(7)
- cdist-type__package_zypper(7)
- cdist-type__pf_apply_anchor(7)
- cdist-type__pf_ruleset(7)
- cdist-type__package_update_index(7)
- cdist-type__xymon_client(7)
- cdist-type__postfix_postconf(7)
- cdist-type__ssh_authorized_key(7)
- cdist-type__dot_file(7)
- cdist-type__uci_section(7)
- cdist-type__postfix_master(7)
- cdist-type__process(7)
- cdist-type__consul_watch_keyprefix(7)
- cdist-type__consul_watch_key(7)
- cdist-type__package_pip(7)
- cdist(1)
- cdist-type__rvm_gemset(7)
- cdist-type__apt_mark(7)
- cdist-type__prometheus_exporter(7)
- cdist-type__postfix_postmap(7)
- cdist-type__postgres_role(7)
- cdist-type__docker_config(7)
- cdist-type__ufw(7)
- cdist-type__install_bootloader_grub(7)
- cdist-type__dpkg_architecture(7)
- cdist-type__ping(7)
- cdist-type__consul_watch_services(7)
- cdist-type__debconf_set_selections(7)
- cdist-type__config_file(7)
- cdist-type__firewalld_start(7)
- cdist-type__consul_template_template(7)
- cdist-type__uci(7)
- cdist-type__jail_freebsd9(7)
- cdist-type__docker_swarm(7)
- cdist-type__ssh_authorized_keys(7)
- cdist-type__install_chroot_umount(7)
- cdist-type__ssh_dot_ssh(7)
- cdist-type__zypper_service(7)
- cdist-type__acl(7)
- cdist-type__docker_stack(7)
- cdist-type__rvm(7)
- cdist-type__daemontools_service(7)
- cdist-type__ufw_rule(7)
- cdist-type__cdistmarker(7)
- cdist-type__qemu_img(7)
- cdist-type__jail(7)
- cdist-type__package_apk(7)
- cdist-type__issue(7)
- cdist-type__install_coreos(7)
- cdist-type__prometheus_alertmanager(7)
- cdist-type__apt_backports(7)
- cdist-type__mysql_user(7)
- cdist-type__yum_repo(7)
- cdist-type__package_upgrade_all(7)
- cdist-type__postgres_conf(7)
- cdist-type__keyboard(7)
- cdist-type__sshd_config(7)
- cdist-type__hosts(7)
- cdist-type__sysctl(7)
- cdist-type__xymon_config(7)
- cdist-type__user_groups(7)
- cdist-type__directory(7)
- cdist-type__package_pacman(7)
- cdist-type__consul(7)
- cdist-type__xymon_apache(7)
- cdist-type__package_pkg_openbsd(7)
- cdist-type__package_emerge(7)
- cdist-type__mount(7)
- cdist-type__rsync(7)
- cdist-type__file(7)
- cdist-type__apt_pin(7)
- cdist-type__package_rubygem(7)
- cdist-type__chroot_mount(7)
- cdist-type__cdist(7)
- cdist-type__install_directory(7)
- cdist-type__package_opkg(7)
- cdist-type__timezone(7)
- cdist-type__locale_system(7)
- cdist-type__go_get(7)
- cdist-type__check_messages(7)
- cdist-type__hwclock(7)
- cdist-type__install_file(7)
- cdist-type__postfix_reload(7)
- cdist-type__dog_vdi(7)
- cdist-type__apt_unattended_upgrades(7)
- cdist-type__install_generate_fstab(7)
- cdist-type__apt_key(7)
- cdist-type__grafana_dashboard(7)
- cdist-type__jail_freebsd10(7)
- cdist-type__pacman_conf_integrate(7)
- cdist-type__package_pkgng_freebsd(7)
- cdist-type__service(7)
- cdist-type__install_partition_msdos_apply(7)
apt-get install cdist
Manual
| CDIST-TYPE__CONSUL_TEMPLATE(7) | cdist | CDIST-TYPE__CONSUL_TEMPLATE(7) |
NAME
cdist-type__consul_template - Manage the consul-template service
DESCRIPTION
Downloads and installs the consul-template binary from https://github.com/hashicorp/consul-template/releases/download/. Generates a global config file and creates directory for per template config files. Note that the consul-template binary is downloaded on the server (the machine running cdist) and then deployed to the target host using the __file type.
REQUIRED PARAMETERS
None.
OPTIONAL PARAMETERS
- 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". The 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. The 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
- 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
__consul_template \
--consul consul.service.consul:8500 \
--retry 30s # specific version __consul_template \
--version 0.6.5 \
--retry 30s
SEE ALSO
consul documentation at: <https://github.com/hashicorp/consul-template>.
AUTHORS
Steven Armstrong <steven-cdist--@--armstrong.cc>
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
| September 11, 2024 | 7.0.0 |