nico/www.nico.schottelius.org
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
www.nico.schottelius.org/software/cdist/man/man7/cdist-reference.html
Nico Schottelius 44afc66670 cdist update
2011-10-16 16:17:48 +02:00

230 lines
11 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-reference(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-reference(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="id374531"></a>cdist-reference(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email">&lt;<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</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="#_explorers">2. EXPLORERS</a></span></dt><dt><span class="section"><a href="#_paths">3. PATHS</a></span></dt><dt><span class="section"><a href="#_types">4. TYPES</a></span></dt><dt><span class="section"><a href="#_objects">5. OBJECTS</a></span></dt><dt><span class="section"><a href="#_environment_variables">6. ENVIRONMENT VARIABLES</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-reference - Variable, path and type reference for cdist</p></div><div class="section" title="2. EXPLORERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_explorers"></a>2. EXPLORERS</h2></div></div></div><p>The following global explores are available:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
hostname
</li><li class="listitem">
machine
</li><li class="listitem">
os
</li><li class="listitem">
os_version
</li></ul></div></div><div class="section" title="3. PATHS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_paths"></a>3. PATHS</h2></div></div></div><p>If not specified otherwise, all paths are relative to the checkout directory.</p><div class="variablelist"><dl><dt><span class="term">
conf/
</span></dt><dd>
Contains the (static) configuration like manifests, types and explorers.
</dd><dt><span class="term">
conf/manifest/init
</span></dt><dd>
This is the central entry point used by cdist-manifest-init(1).
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.
It should be primary used to define mapping from configurations to hosts.
</dd><dt><span class="term">
conf/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
manifest/init file. This may also be very helpful to have different admins
maintain different groups of hosts.
</dd><dt><span class="term">
conf/explorer/&lt;name&gt;
</span></dt><dd>
Contains explorers to be run on the target hosts, see cdist-explorer(7).
</dd><dt><span class="term">
conf/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">
conf/type/&lt;name&gt;/
</span></dt><dd><p class="simpara">
Home of the type &lt;name&gt;.
</p><pre class="literallayout">This directory is referenced by the variable __type (see below).</pre></dd><dt><span class="term">
conf/type/&lt;name&gt;/man.text
</span></dt><dd>
Manpage in Asciidoc format (nequired for inclusion into upstream)
</dd><dt><span class="term">
conf/type/&lt;name&gt;/manifest
</span></dt><dd>
Used to generate additional objects from a type.
</dd><dt><span class="term">
conf/type/&lt;name&gt;/gencode-local
</span></dt><dd>
Used to generate code to be executed on the server.
</dd><dt><span class="term">
conf/type/&lt;name&gt;/gencode-remote
</span></dt><dd>
Used to generate code to be executed on the client.
</dd><dt><span class="term">
conf/type/&lt;name&gt;/parameters/required
</span></dt><dd>
Parameters required by type, \n seperated list.
</dd><dt><span class="term">
conf/type/&lt;name&gt;/parameters/optional
</span></dt><dd>
Parameters optionally accepted by type, \n seperated list.
</dd><dt><span class="term">
conf/type/&lt;name&gt;/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">
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/&lt;object&gt;
</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/&lt;object&gt;/explorers
</span></dt><dd>
Output of type specific explorers, per object.
</dd><dt><span class="term">
tmp_dir
</span></dt><dd>
A tempdir and a tempfile is used by cdist internally,
which will be removed when the scripts end automatically.
See cdist-config(1).
</dd></dl></div></div><div class="section" title="4. TYPES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_types"></a>4. TYPES</h2></div></div></div><p>The following types are available:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
__addifnosuchline (cdist-type__addifnosuchline(7))
</li><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">
__autofs_map (cdist-type__autofs_map(7))
</li><li class="listitem">
__autofs_master (cdist-type__autofs_master(7))
</li><li class="listitem">
__crontab (cdist-type__crontab(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">
__group (cdist-type__group(7))
</li><li class="listitem">
__init_script (cdist-type__init_script(7))
</li><li class="listitem">
__issue (cdist-type__issue(7))
</li><li class="listitem">
__key_value (cdist-type__key_value(7))
</li><li class="listitem">
__link (cdist-type__link(7))
</li><li class="listitem">
__mkfs (cdist-type__mkfs(7))
</li><li class="listitem">
__motd (cdist-type__motd(7))
</li><li class="listitem">
__package_apt (cdist-type__package_apt(7))
</li><li class="listitem">
__package_pacman (cdist-type__package_pacman(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 (cdist-type__package(7))
</li><li class="listitem">
__package_yum (cdist-type__package_yum(7))
</li><li class="listitem">
__partition_msdos_apply (cdist-type__partition_msdos_apply(7))
</li><li class="listitem">
__partition_msdos (cdist-type__partition_msdos(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">
__removeline (cdist-type__removeline(7))
</li><li class="listitem">
__ssh_authorized_key (cdist-type__ssh_authorized_key(7))
</li><li class="listitem">
__timezone (cdist-type__timezone(7))
</li><li class="listitem">
__user (cdist-type__user(7))
</li></ul></div></div><div class="section" title="5. OBJECTS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_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><div class="variablelist"><dl><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="section" title="6. ENVIRONMENT VARIABLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_environment_variables"></a>6. ENVIRONMENT VARIABLES</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
__debug
</span></dt><dd>
If this variable is setup, cdist runs in debug mode.
You can use this information, to only output stuff in debug
mode as well.
Available for: initial manifest, type manifest, gencode, code
</dd><dt><span class="term">
__explorer
</span></dt><dd>
Directory that contains all global explorers.
Available for: explorer
</dd><dt><span class="term">
__manifest
</span></dt><dd>
Directory that contains the initial manifest.
Available for: initial 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
</dd><dt><span class="term">
__object_fq
</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: initial manifest, type manifest, type gencode
</dd><dt><span class="term">
__target_user
</span></dt><dd>
User to use for authentication on remote host.
Currently static in core.
</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="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">
cdist(7)
</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) 2011 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>
Reference in a new issue View git blame Copy permalink