276 lines
No EOL
11 KiB
HTML
276 lines
No EOL
11 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-reference</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="refentry" lang="en"><a id="idm140616174124560"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>cdist-reference — Variable, path and type reference for cdist</p></div><div class="refsect1"><a id="_explorers"></a><h2>EXPLORERS</h2><p>The following global explorers are available:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
|
|
hostname
|
|
</li><li class="listitem">
|
|
interfaces
|
|
</li><li class="listitem">
|
|
lsb_codename
|
|
</li><li class="listitem">
|
|
lsb_description
|
|
</li><li class="listitem">
|
|
lsb_id
|
|
</li><li class="listitem">
|
|
lsb_release
|
|
</li><li class="listitem">
|
|
machine
|
|
</li><li class="listitem">
|
|
os
|
|
</li><li class="listitem">
|
|
os_version
|
|
</li><li class="listitem">
|
|
runlevel
|
|
</li></ul></div></div><div class="refsect1"><a id="_paths"></a><h2>PATHS</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term">
|
|
$HOME/.cdist
|
|
</span></dt><dd>
|
|
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><span class="term">
|
|
cdist/conf/
|
|
</span></dt><dd>
|
|
The distribution configuration directory
|
|
This contains types and explorers to be used
|
|
</dd><dt><span class="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><span class="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><span class="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><span class="term">
|
|
confdir/explorer/<name>
|
|
</span></dt><dd>
|
|
Contains explorers to be run on the target hosts, see cdist-explorer(7).
|
|
</dd><dt><span class="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><span class="term">
|
|
confdir/type/<name>/
|
|
</span></dt><dd>
|
|
Home of the type <name>.
|
|
This directory is referenced by the variable __type (see below).
|
|
</dd><dt><span class="term">
|
|
confdir/type/<name>/man.text
|
|
</span></dt><dd>
|
|
Manpage in Asciidoc format (required for inclusion into upstream)
|
|
</dd><dt><span class="term">
|
|
confdir/type/<name>/manifest
|
|
</span></dt><dd>
|
|
Used to generate additional objects from a type.
|
|
</dd><dt><span class="term">
|
|
confdir/type/<name>/gencode-local
|
|
</span></dt><dd>
|
|
Used to generate code to be executed on the source host
|
|
</dd><dt><span class="term">
|
|
confdir/type/<name>/gencode-remote
|
|
</span></dt><dd>
|
|
Used to generate code to be executed on the target host
|
|
</dd><dt><span class="term">
|
|
confdir/type/<name>/parameter/required
|
|
</span></dt><dd>
|
|
Parameters required by type, \n seperated list.
|
|
</dd><dt><span class="term">
|
|
confdir/type/<name>/parameter/optional
|
|
</span></dt><dd>
|
|
Parameters optionally accepted by type, \n seperated list.
|
|
</dd><dt><span class="term">
|
|
confdir/type/<name>/parameter/boolean
|
|
</span></dt><dd>
|
|
Boolean parameters accepted by type, \n seperated list.
|
|
</dd><dt><span class="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><span class="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><span class="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><span class="term">
|
|
out/explorer
|
|
</span></dt><dd>
|
|
Output of general explorers.
|
|
</dd><dt><span class="term">
|
|
out/object
|
|
</span></dt><dd>
|
|
Objects created for the host.
|
|
</dd><dt><span class="term">
|
|
out/object/<object>
|
|
</span></dt><dd>
|
|
Contains all object specific information.
|
|
This directory is referenced by the variable __object (see below).
|
|
</dd><dt><span class="term">
|
|
out/object/<object>/explorers
|
|
</span></dt><dd>
|
|
Output of type specific explorers, per object.
|
|
</dd></dl></div></div><div class="refsect1"><a id="_types"></a><h2>TYPES</h2><p>The following types are available:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
|
|
__apt_ppa (cdist-type__apt_ppa(7))
|
|
</li><li class="listitem">
|
|
__apt_update_index (cdist-type__apt_update_index(7))
|
|
</li><li class="listitem">
|
|
__cdist (cdist-type__cdist(7))
|
|
</li><li class="listitem">
|
|
__cdistmarker (cdist-type__cdistmarker(7))
|
|
</li><li class="listitem">
|
|
__cron (cdist-type__cron(7))
|
|
</li><li class="listitem">
|
|
__debconf_set_selections (cdist-type__debconf_set_selections(7))
|
|
</li><li class="listitem">
|
|
__directory (cdist-type__directory(7))
|
|
</li><li class="listitem">
|
|
__file (cdist-type__file(7))
|
|
</li><li class="listitem">
|
|
__git (cdist-type__git(7))
|
|
</li><li class="listitem">
|
|
__group (cdist-type__group(7))
|
|
</li><li class="listitem">
|
|
__issue (cdist-type__issue(7))
|
|
</li><li class="listitem">
|
|
__jail (cdist-type__jail(7))
|
|
</li><li class="listitem">
|
|
__key_value (cdist-type__key_value(7))
|
|
</li><li class="listitem">
|
|
__line (cdist-type__line(7))
|
|
</li><li class="listitem">
|
|
__link (cdist-type__link(7))
|
|
</li><li class="listitem">
|
|
__motd (cdist-type__motd(7))
|
|
</li><li class="listitem">
|
|
__mysql_database (cdist-type__mysql_database(7))
|
|
</li><li class="listitem">
|
|
__package (cdist-type__package(7))
|
|
</li><li class="listitem">
|
|
__package_apt (cdist-type__package_apt(7))
|
|
</li><li class="listitem">
|
|
__package_luarocks (cdist-type__package_luarocks(7))
|
|
</li><li class="listitem">
|
|
__package_opkg (cdist-type__package_opkg(7))
|
|
</li><li class="listitem">
|
|
__package_pacman (cdist-type__package_pacman(7))
|
|
</li><li class="listitem">
|
|
__package_pip (cdist-type__package_pip(7))
|
|
</li><li class="listitem">
|
|
__package_pkg_freebsd (cdist-type__package_pkg_freebsd(7))
|
|
</li><li class="listitem">
|
|
__package_pkg_openbsd (cdist-type__package_pkg_openbsd(7))
|
|
</li><li class="listitem">
|
|
__package_rubygem (cdist-type__package_rubygem(7))
|
|
</li><li class="listitem">
|
|
__package_yum (cdist-type__package_yum(7))
|
|
</li><li class="listitem">
|
|
__package_zypper (cdist-type__package_zypper(7))
|
|
</li><li class="listitem">
|
|
__pf_apply (cdist-type__pf_apply(7))
|
|
</li><li class="listitem">
|
|
__pf_ruleset (cdist-type__pf_ruleset(7))
|
|
</li><li class="listitem">
|
|
__postgres_database (cdist-type__postgres_database(7))
|
|
</li><li class="listitem">
|
|
__postgres_role (cdist-type__postgres_role(7))
|
|
</li><li class="listitem">
|
|
__process (cdist-type__process(7))
|
|
</li><li class="listitem">
|
|
__qemu_img (cdist-type__qemu_img(7))
|
|
</li><li class="listitem">
|
|
__rvm (cdist-type__rvm(7))
|
|
</li><li class="listitem">
|
|
__rvm_gem (cdist-type__rvm_gem(7))
|
|
</li><li class="listitem">
|
|
__rvm_gemset (cdist-type__rvm_gemset(7))
|
|
</li><li class="listitem">
|
|
__rvm_ruby (cdist-type__rvm_ruby(7))
|
|
</li><li class="listitem">
|
|
__ssh_authorized_keys (cdist-type__ssh_authorized_keys(7))
|
|
</li><li class="listitem">
|
|
__start_on_boot (cdist-type__start_on_boot(7))
|
|
</li><li class="listitem">
|
|
__timezone (cdist-type__timezone(7))
|
|
</li><li class="listitem">
|
|
__update_alternatives (cdist-type__update_alternatives(7))
|
|
</li><li class="listitem">
|
|
__user (cdist-type__user(7))
|
|
</li><li class="listitem">
|
|
__user_groups (cdist-type__user_groups(7))
|
|
</li></ul></div></div><div class="refsect1"><a id="_objects"></a><h2>OBJECTS</h2><p>For object to object communication and tests, the following paths are
|
|
usable within a object directory:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">
|
|
changed
|
|
</span></dt><dd>
|
|
This empty file exists in an object directory, if the object has
|
|
code to be excuted (either remote or local)
|
|
</dd></dl></div></div><div class="refsect1"><a id="_environment_variables"></a><h2>ENVIRONMENT VARIABLES</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term">
|
|
__explorer
|
|
</span></dt><dd>
|
|
Directory that contains all global explorers.
|
|
Available for: initial manifest, explorer, type explorer
|
|
</dd><dt><span class="term">
|
|
__manifest
|
|
</span></dt><dd>
|
|
Directory that contains the initial manifest.
|
|
Available for: initial manifest, type manifest
|
|
</dd><dt><span class="term">
|
|
__global
|
|
</span></dt><dd>
|
|
Directory that contains generic output like explorer.
|
|
Available for: initial manifest, type manifest, type gencode
|
|
</dd><dt><span class="term">
|
|
__object
|
|
</span></dt><dd>
|
|
Directory that contains the current object.
|
|
Available for: type manifest, type explorer, type gencode
|
|
</dd><dt><span class="term">
|
|
__object_id
|
|
</span></dt><dd>
|
|
The type unique object id.
|
|
Available for: type manifest, type explorer, type gencode
|
|
Note: The leading and the trailing "/" will always be stripped (caused by
|
|
the filesystem database and ensured by the core).
|
|
Note: Double slashes ("//") will not be fixed and result in an error.
|
|
</dd><dt><span class="term">
|
|
__object_name
|
|
</span></dt><dd>
|
|
The full qualified name of the current object.
|
|
Available for: type manifest, type explorer, type gencode
|
|
</dd><dt><span class="term">
|
|
__target_host
|
|
</span></dt><dd>
|
|
The host we are deploying to.
|
|
Available for: explorer, initial manifest, type explorer, type manifest, type gencode
|
|
</dd><dt><span class="term">
|
|
__type
|
|
</span></dt><dd>
|
|
Path to the current type.
|
|
Available for: type manifest, type gencode
|
|
</dd><dt><span class="term">
|
|
__type_explorer
|
|
</span></dt><dd>
|
|
Directory that contains the type explorers.
|
|
Available for: type explorer
|
|
</dd></dl></div></div><div class="refsect1"><a id="_see_also"></a><h2>SEE ALSO</h2><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
|
|
cdist(1)
|
|
</li></ul></div></div><div class="refsect1"><a id="_copying"></a><h2>COPYING</h2><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> |