46 lines
5.1 KiB
HTML
46 lines
5.1 KiB
HTML
<?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_template(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /></head><body><div xml:lang="en" class="article" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idm140713534379360"></a>cdist-type__consul_template_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"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><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="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section"><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_template - manage consul-template templates</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Generate and deploy template definitions for a consul-template.
|
||
See <a class="ulink" href="https://github.com/hashicorp/consul-template#examples" target="_top">https://github.com/hashicorp/consul-template#examples</a> for documentation.
|
||
Templates are written in the Go template format.
|
||
Either the --source or the --source-file parameter must be given.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">
|
||
destination
|
||
</span></dt><dd>
|
||
the destination where the generated file should go.
|
||
</dd></dl></div></div><div class="section"><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 class="variablelist"><dt><span class="term">
|
||
command
|
||
</span></dt><dd>
|
||
an optional command to run after rendering the template to its destination.
|
||
</dd><dt><span class="term">
|
||
source
|
||
</span></dt><dd>
|
||
path to the template source. Conflicts --source-file.
|
||
</dd><dt><span class="term">
|
||
source-file
|
||
</span></dt><dd>
|
||
path to a local file which is uploaded using the __file type and configured
|
||
as the source.
|
||
If source is <span class="emphasis"><em>-</em></span> (dash), take what was written to stdin as the file content.
|
||
Conflicts --source.
|
||
</dd><dt><span class="term">
|
||
state
|
||
</span></dt><dd>
|
||
if this template is <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></dl></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen"># configure template on the target
|
||
__consul_template_template nginx \
|
||
--source /etc/my-consul-templates/nginx.ctmpl \
|
||
--destination /etc/nginx/nginx.conf \
|
||
--command 'service nginx restart'
|
||
|
||
|
||
# upload a local file to the target and configure it
|
||
__consul_template_template nginx \
|
||
--source-file "$__manifest/files/nginx.ctmpl" \
|
||
--destination /etc/nginx/nginx.conf \
|
||
--command 'service nginx restart'</pre></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
|
||
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||
</li><li class="listitem">
|
||
<a href="../man7/cdist-type__consul_template.html">cdist-type__consul_template(7)</a>
|
||
</li><li class="listitem">
|
||
<a href="../man7/cdist-type__consul_template_config.html">cdist-type__consul_template_config(7)</a>
|
||
</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. 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> |