45 lines
4.6 KiB
HTML
45 lines
4.6 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_check(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="idm140679102497600"></a>cdist-type__consul_check(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_check - manages consul checks</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 check definitions for a consul agent.
|
||
See <a class="ulink" href="http://www.consul.io/docs/agent/checks.html" target="_top">http://www.consul.io/docs/agent/checks.html</a> for parameter documentation.</p><p>Use either script toghether with interval, or use ttl.</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><p>None.</p></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">
|
||
interval
|
||
</span></dt><dd>
|
||
the interval in which the script given with --script should be run
|
||
</dd><dt><span class="term">
|
||
script
|
||
</span></dt><dd>
|
||
the shell command to run every --interval
|
||
</dd><dt><span class="term">
|
||
ttl
|
||
</span></dt><dd>
|
||
how long a check is considered healthy without being updated through the
|
||
HTTP interfave
|
||
</dd><dt><span class="term">
|
||
id
|
||
</span></dt><dd>
|
||
Defaults to --name
|
||
</dd><dt><span class="term">
|
||
name
|
||
</span></dt><dd>
|
||
The name of this check. Defaults to __object_id
|
||
</dd><dt><span class="term">
|
||
notes
|
||
</span></dt><dd>
|
||
human readable description
|
||
</dd><dt><span class="term">
|
||
state
|
||
</span></dt><dd>
|
||
if this check 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">__consul_check redis \
|
||
--script /usr/local/bin/check_redis.py \
|
||
--interval 10s
|
||
|
||
__consul_check some-object-id \
|
||
--id web-app \
|
||
--name "Web App Status" \
|
||
--notes "Web app does a curl internally every 10 seconds" \
|
||
--ttl 30s</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_agent.html">cdist-type__consul_agent(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> |