.\" Man page generated from reStructuredText.
.
.TH "CDIST-TYPE__CONSUL_TEMPLATE" "7" "Jun 23, 2019" "5.1.2" "cdist"
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH NAME
.sp
cdist\-type__consul_template \- Manage the consul\-template service
.SH DESCRIPTION
.sp
Downloads and installs the consul\-template binary from
\fI\%https://github.com/hashicorp/consul\-template/releases/download/\fP\&.
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.
.SH REQUIRED PARAMETERS
.sp
None.
.SH OPTIONAL PARAMETERS
.INDENT 0.0
.TP
.B auth\-username
specify a username for basic authentication.
.TP
.B auth\-password
specify a password for basic authentication.
.TP
.B batch\-size
the size of the batch when polling multiple dependencies.
.TP
.B consul
the location of the Consul instance to query (may be an IP address or FQDN) with port.
Defaults to \(aqlocalhost:8500\(aq.
.TP
.B 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".
.TP
.B max\-stale
the maximum staleness of a query. If specified, Consul will distribute work among all
servers instead of just the leader.
.TP
.B retry
the amount of time to wait if Consul returns an error when communicating
with the API.
.TP
.B state
either \(aqpresent\(aq or \(aqabsent\(aq. Defaults to \(aqpresent\(aq
.TP
.B 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.
.TP
.B 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.
.TP
.B syslog\-facility
The facility to use when sending to syslog. This requires the use of \-\-syslog.
The default value is LOCAL0.
.TP
.B token
the Consul API token.
.TP
.B vault\-address
the location of the Vault instance to query (may be an IP address or FQDN) with port.
.TP
.B vault\-token
the Vault API token.
.TP
.B vault\-ssl\-cert
Path to an SSL client certificate to use to authenticate to the vault server.
.TP
.B 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.
.TP
.B version
which version of consul\-template to install. See ./files/versions for a list of
supported versions. Defaults to the latest known version.
.TP
.B 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.
.UNINDENT
.SH BOOLEAN PARAMETERS
.INDENT 0.0
.TP
.B ssl
use HTTPS while talking to Consul. Requires the Consul server to be configured to serve secure connections.
.TP
.B ssl\-no\-verify
ignore certificate warnings. Only used if ssl is enabled.
.TP
.B syslog
Send log output to syslog (in addition to stdout and stderr).
.TP
.B vault\-ssl
use HTTPS while talking to Vault. Requires the Vault server to be configured to serve secure connections.
.TP
.B vault\-ssl\-no\-verify
ignore certificate warnings. Only used if vault is enabled.
.UNINDENT
.SH EXAMPLES
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
__consul_template \e
   \-\-consul consul.service.consul:8500 \e
   \-\-retry 30s

# specific version
__consul_template \e
   \-\-version 0.6.5 \e
   \-\-retry 30s
.ft P
.fi
.UNINDENT
.UNINDENT
.SH SEE ALSO
.sp
consul documentation at: <\fI\%https://github.com/hashicorp/consul\-template\fP>.
.SH AUTHORS
.sp
Steven Armstrong <\fI\%steven\-cdist\-\-@\-\-armstrong.cc\fP>
.SH COPYING
.sp
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.
.SH COPYRIGHT
ungleich GmbH 2019
.\" Generated by docutils manpage writer.
.