ungleich-public/cdist-web
ungleich-public
/
cdist-web
6
0
Fork 1
Code Issues 1 Pull Requests Projects Releases Wiki Activity
cdist-web/src/extra/manual/4.0.0/man7/cdist-type__consul_template...

124 lines
8.1 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__consul_template(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__consul_template(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64734288"></a>cdist-type__consul_template(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email">&lt;<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>&gt;</code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_boolean_parameters">5. BOOLEAN PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">6. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">7. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">8. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__consul_template - manage the consul-template service</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Downloads and installs the consul-template binary from
<a class="ulink" href="https://github.com/hashicorp/consul-template/releases/download/" target="_top">https://github.com/hashicorp/consul-template/releases/download/</a>.
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.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None.</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
auth-username
</span></dt><dd>
specify a username for basic authentication.
</dd><dt><span class="term">
auth-password
</span></dt><dd>
specify a password for basic authentication.
</dd><dt><span class="term">
batch-size
</span></dt><dd>
the size of the batch when polling multiple dependencies.
</dd><dt><span class="term">
consul
</span></dt><dd>
the location of the Consul instance to query (may be an IP address or FQDN) with port.
Defaults to <span class="emphasis"><em>localhost:8500</em></span>.
</dd><dt><span class="term">
log-level
</span></dt><dd>
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".
</dd><dt><span class="term">
max-stale
</span></dt><dd>
the maximum staleness of a query. If specified, Consul will distribute work among all
servers instead of just the leader.
</dd><dt><span class="term">
retry
</span></dt><dd>
the amount of time to wait if Consul returns an error when communicating
with the API.
</dd><dt><span class="term">
state
</span></dt><dd>
either <span class="emphasis"><em>present</em></span> or <span class="emphasis"><em>absent</em></span>. Defaults to <span class="emphasis"><em>present</em></span>
</dd><dt><span class="term">
ssl-cert
</span></dt><dd>
Path to an SSL client certificate to use to authenticate to the consul server.
Useful if the consul server "verify_incoming" option is set.
</dd><dt><span class="term">
ssl-ca-cert
</span></dt><dd>
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.
</dd><dt><span class="term">
syslog-facility
</span></dt><dd>
The facility to use when sending to syslog. This requires the use of --syslog.
The default value is LOCAL0.
</dd><dt><span class="term">
token
</span></dt><dd>
the Consul API token.
</dd><dt><span class="term">
vault-address
</span></dt><dd>
the location of the Vault instance to query (may be an IP address or FQDN) with port.
</dd><dt><span class="term">
vault-token
</span></dt><dd>
the Vault API token.
</dd><dt><span class="term">
vault-ssl-cert
</span></dt><dd>
Path to an SSL client certificate to use to authenticate to the vault server.
</dd><dt><span class="term">
vault-ssl-ca-cert
</span></dt><dd>
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.
</dd><dt><span class="term">
version
</span></dt><dd>
which version of consul-template to install. See ./files/versions for a list of
supported versions. Defaults to the latest known version.
</dd><dt><span class="term">
wait
</span></dt><dd>
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.
</dd></dl></div></div><div class="section" title="5. BOOLEAN PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_boolean_parameters"></a>5. BOOLEAN PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
ssl
</span></dt><dd>
use HTTPS while talking to Consul. Requires the Consul server to be configured to serve secure connections.
</dd><dt><span class="term">
ssl-no-verify
</span></dt><dd>
ignore certificate warnings. Only used if ssl is enabled.
</dd><dt><span class="term">
syslog
</span></dt><dd>
Send log output to syslog (in addition to stdout and stderr).
</dd><dt><span class="term">
vault-ssl
</span></dt><dd>
use HTTPS while talking to Vault. Requires the Vault server to be configured to serve secure connections.
</dd><dt><span class="term">
vault-ssl-no-verify
</span></dt><dd>
ignore certificate warnings. Only used if vault is enabled.
</dd></dl></div></div><div class="section" title="6. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>6. EXAMPLES</h2></div></div></div><pre class="screen">__consul_template \
--consul consul.service.consul:8500 \
--retry 30s
# specific version
__consul_template \
--version 0.6.5 \
--retry 30s</pre></div><div class="section" title="7. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>7. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
<a href="../man7/cdist-type.html">cdist-type(7)</a>
</li><li class="listitem">
<a class="ulink" href="https://github.com/hashicorp/consul-template" target="_top">https://github.com/hashicorp/consul-template</a>
</li></ul></div></div><div class="section" title="8. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>8. COPYING</h2></div></div></div><p>Copyright (C) 2015 Steven Armstrong. Free use of this software is
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
Reference in New Issue View Git Blame Copy Permalink