cdist-type__consul_template(7)

1CDIST-TYPE__CONSUL_TEMPLATE(7)       cdist      CDIST-TYPE__CONSUL_TEMPLATE(7)
2
3
4

NAME

6       cdist-type__consul_template - Manage the consul-template service
7

DESCRIPTION

9       Downloads    and    installs    the    consul-template    binary   from
10       https://github.com/hashicorp/consul-template/releases/download/.   Gen‐
11       erates a global config file and creates directory for per template con‐
12       fig files.  Note that the consul-template binary is downloaded  on  the
13       server (the machine running cdist) and then deployed to the target host
14       using the __file type.
15

REQUIRED PARAMETERS

17       None.
18

OPTIONAL PARAMETERS

20       auth-username
21              specify a username for basic authentication.
22
23       auth-password
24              specify a password for basic authentication.
25
26       batch-size
27              the size of the batch when polling multiple dependencies.
28
29       consul the location of the Consul instance to query (may be an  IP  ad‐
30              dress or FQDN) with port.  Defaults to 'localhost:8500'.
31
32       log-level
33              The log level for output. This applies to the stdout/stderr log‐
34              ging as well as syslog logging (if enabled).  Valid  values  are
35              "debug", "info", "warn", and "err". The default value is "warn".
36
37       max-stale
38              the maximum staleness of a query. If specified, Consul will dis‐
39              tribute work among all servers instead of just the leader.
40
41       retry  the amount of time to wait if Consul returns an error when  com‐
42              municating with the API.
43
44       state  either 'present' or 'absent'. Defaults to 'present'
45
46       ssl-cert
47              Path  to an SSL client certificate to use to authenticate to the
48              consul server.  Useful if the  consul  server  "verify_incoming"
49              option is set.
50
51       ssl-ca-cert
52              Path  to  a  CA certificate file, containing one or more CA cer‐
53              tificates to use to validate the certificate sent by the  consul
54              server   to   us.   This  is  a  handy  alternative  to  setting
55              --ssl-no-verify if you are using your own CA.
56
57       syslog-facility
58              The facility to use when sending to syslog.  This  requires  the
59              use of --syslog.  The default value is LOCAL0.
60
61       token  the Consul API token.
62
63       vault-address
64              the  location  of  the Vault instance to query (may be an IP ad‐
65              dress or FQDN) with port.
66
67       vault-token
68              the Vault API token.
69
70       vault-ssl-cert
71              Path to an SSL client certificate to use to authenticate to  the
72              vault server.
73
74       vault-ssl-ca-cert
75              Path  to  a  CA certificate file, containing one or more CA cer‐
76              tificates to use to validate the certificate sent by  the  vault
77              server to us.
78
79       version
80              which  version  of  consul-template to install. See ./files/ver‐
81              sions for a list of supported versions. Defaults to  the  latest
82              known version.
83
84       wait   the minimum(:maximum) to wait before rendering a new template to
85              disk and triggering a command, separated by a colon (:). If  the
86              optional  maximum  value  is omitted, it is assumed to be 4x the
87              required minimum value.
88

BOOLEAN PARAMETERS

90       ssl    use HTTPS while talking to Consul. Requires the Consul server to
91              be configured to serve secure connections.
92
93       ssl-no-verify
94              ignore certificate warnings. Only used if ssl is enabled.
95
96       syslog Send log output to syslog (in addition to stdout and stderr).
97
98       vault-ssl
99              use  HTTPS  while talking to Vault. Requires the Vault server to
100              be configured to serve secure connections.
101
102       vault-ssl-no-verify
103              ignore certificate warnings. Only used if vault is enabled.
104

EXAMPLES

106          __consul_template \
107             --consul consul.service.consul:8500 \
108             --retry 30s
109
110          # specific version
111          __consul_template \
112             --version 0.6.5 \
113             --retry 30s
114

AUTHORS

120       Steven Armstrong <steven-cdist--@--armstrong.cc>
121

COPYING

123       Copyright  (C)  2015  Steven  Armstrong. You can redistribute it and/or
124       modify it under the terms of the GNU General  Public  License  as  pub‐
125       lished  by  the  Free  Software Foundation, either version 3 of the Li‐
126       cense, or (at your option) any later version.
127

COPYRIGHT

129       ungleich GmbH 2021
130
131
132
133
1346.9.8                            Aug 24, 2021   CDIST-TYPE__CONSUL_TEMPLATE(7)