<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><htmlxmlns="http://www.w3.org/1999/xhtml"><head><metahttp-equiv="Content-Type"content="text/html; charset=UTF-8"/><title>cdist-reference(7)</title><linkrel="stylesheet"type="text/css"href="docbook-xsl.css"/><metaname="generator"content="DocBook XSL Stylesheets V1.78.1"/></head><body><divxml:lang="en"class="article"lang="en"><divclass="titlepage"><div><div><h2class="title"><aid="idm140480388258256"></a>cdist-reference(7)</h2></div><div><divclass="author"><h3class="author"><spanclass="firstname">Nico</span><spanclass="surname">Schottelius</span></h3><codeclass="email"><<aclass="email"href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr/></div><divclass="toc"><p><strong>Table of Contents</strong></p><dlclass="toc"><dt><spanclass="section"><ahref="#_name">1. NAME</a></span></dt><dt><spanclass="section"><ahref="#_explorers">2. EXPLORERS</a></span></dt><dt><spanclass="section"><ahref="#_paths">3. PATHS</a></span></dt><dt><spanclass="section"><ahref="#_types">4. TYPES</a></span></dt><dt><spanclass="section"><ahref="#_objects">5. OBJECTS</a></span></dt><dt><spanclass="section"><ahref="#_environment_variables">6. ENVIRONMENT VARIABLES</a></span></dt><dt><spanclass="section"><ahref="#_see_also">7. SEE ALSO</a></span></dt><dt><spanclass="section"><ahref="#_copying">8. COPYING</a></span></dt></dl></div><divclass="section"><divclass="titlepage"><div><div><h2class="title"style="clear: both"><aid="_name"></a>1.NAME</h2></div></div></div><p>cdist-reference - Variable, path and type reference for cdist</p></div><divclass="section"><divclass="titlepage"><div><div><h2class="title"style="clear: both"><aid="_explorers"></a>2.EXPLORERS</h2></div></div></div><p>The following global explorers are available:</p><divclass="itemizedlist"><ulclass="itemizedlist"style="list-style-type: disc; "><liclass="listitem">
The standard cdist configuration directory relative to your home directory
This is usually the place you want to store your site specific configuration
</dd><dt><spanclass="term">
cdist/conf/
</span></dt><dd>
The distribution configuration directory
This contains types and explorers to be used
</dd><dt><spanclass="term">
confdir
</span></dt><dd>
Cdist will use all available configuration directories and create
a temporary confdir containing links to the real configuration directories.
This way it is possible to merge configuration directories.
By default it consists of everything in $HOME/.cdist and cdist/conf/.
For more details see cdist(1)
</dd><dt><spanclass="term">
confdir/manifest/init
</span></dt><dd>
This is the central entry point.
It is an executable (+x bit set) shell script that can use
values from the explorers to decide which configuration to create
for the specified target host.
Its intent is to used to define mapping from configurations to hosts.
</dd><dt><spanclass="term">
confdir/manifest/*
</span></dt><dd>
All other files in this directory are not directly used by cdist, but you
can seperate configuration mappings, if you have a lot of code in the
conf/manifest/init file. This may also be helpful to have different admins
maintain different groups of hosts.
</dd><dt><spanclass="term">
confdir/explorer/<name>
</span></dt><dd>
Contains explorers to be run on the target hosts, see cdist-explorer(7).
</dd><dt><spanclass="term">
confdir/type/
</span></dt><dd>
Contains all available types, which are used to provide
some kind of functionality. See cdist-type(7).
</dd><dt><spanclass="term">
confdir/type/<name>/
</span></dt><dd>
Home of the type <name>.
This directory is referenced by the variable __type (see below).
</dd><dt><spanclass="term">
confdir/type/<name>/man.text
</span></dt><dd>
Manpage in Asciidoc format (required for inclusion into upstream)
</dd><dt><spanclass="term">
confdir/type/<name>/manifest
</span></dt><dd>
Used to generate additional objects from a type.
</dd><dt><spanclass="term">
confdir/type/<name>/gencode-local
</span></dt><dd>
Used to generate code to be executed on the source host
</dd><dt><spanclass="term">
confdir/type/<name>/gencode-remote
</span></dt><dd>
Used to generate code to be executed on the target host
</dd><dt><spanclass="term">
confdir/type/<name>/parameter/required
</span></dt><dd>
Parameters required by type, \n seperated list.
</dd><dt><spanclass="term">
confdir/type/<name>/parameter/optional
</span></dt><dd>
Parameters optionally accepted by type, \n seperated list.
</dd><dt><spanclass="term">
confdir/type/<name>/parameter/boolean
</span></dt><dd>
Boolean parameters accepted by type, \n seperated list.
</dd><dt><spanclass="term">
confdir/type/<name>/explorer
</span></dt><dd>
Location of the type specific explorers.
This directory is referenced by the variable __type_explorer (see below).
See cdist-explorer(7).
</dd><dt><spanclass="term">
confdir/type/<name>/files
</span></dt><dd>
This directory is reserved for user data and will not be used
by cdist at any time
</dd><dt><spanclass="term">
out/
</span></dt><dd>
This directory contains output of cdist and is usually located
in a temporary directory and thus will be removed after the run.
This directory is referenced by the variable __global (see below).
</dd><dt><spanclass="term">
out/explorer
</span></dt><dd>
Output of general explorers.
</dd><dt><spanclass="term">
out/object
</span></dt><dd>
Objects created for the host.
</dd><dt><spanclass="term">
out/object/<object>
</span></dt><dd>
Contains all object specific information.
This directory is referenced by the variable __object (see below).
</dd><dt><spanclass="term">
out/object/<object>/explorers
</span></dt><dd>
Output of type specific explorers, per object.
</dd></dl></div></div><divclass="section"><divclass="titlepage"><div><div><h2class="title"style="clear: both"><aid="_types"></a>4.TYPES</h2></div></div></div><p>The following types are available:</p><divclass="itemizedlist"><ulclass="itemizedlist"style="list-style-type: disc; "><liclass="listitem">
</li></ul></div></div><divclass="section"><divclass="titlepage"><div><div><h2class="title"style="clear: both"><aid="_objects"></a>5.OBJECTS</h2></div></div></div><p>For object to object communication and tests, the following paths are
usable within a object directory:</p><divclass="variablelist"><dlclass="variablelist"><dt><spanclass="term">
changed
</span></dt><dd>
This empty file exists in an object directory, if the object has
</li></ul></div></div><divclass="section"><divclass="titlepage"><div><div><h2class="title"style="clear: both"><aid="_copying"></a>8.COPYING</h2></div></div></div><p>Copyright (C) 2011-2012 Nico Schottelius. Free use of this software is
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
