72 lines
9.3 KiB
HTML
72 lines
9.3 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-manifest(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-manifest(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp25204064"></a>cdist-manifest(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></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="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_initial_and_type_manifests">3. INITIAL AND TYPE MANIFESTS</a></span></dt><dt><span class="section"><a href="#_define_state_in_the_initial_manifest">4. DEFINE STATE IN THE INITIAL MANIFEST</a></span></dt><dt><span class="section"><a href="#_splitting_up_the_initial_manifest">5. SPLITTING UP THE INITIAL MANIFEST</a></span></dt><dt><span class="section"><a href="#_dependencies">6. DEPENDENCIES</a></span></dt><dt><span class="section"><a href="#_examples">7. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">8. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">9. 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-manifest - (Re-)Use types</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Manifests are used to define which objects to create.
|
||
Objects are instances of <span class="strong"><strong>types</strong></span>, like in object orientated programming languages.
|
||
An object is represented by the combination of
|
||
<span class="strong"><strong>type + slash + object name</strong></span>: <span class="strong"><strong><span class="emphasis"><em>file/etc/cdist-configured</em></span> is an
|
||
object of the type <span class="strong"><strong><span class="strong"><strong></strong></span>file</strong></span></strong></span> with the name <span class="strong"><strong><span class="strong"><strong>etc/cdist-configured</strong></span></strong></span>.</p><p>All available types can be found in the <span class="strong"><strong>conf/type/</strong></span> directory,
|
||
use <span class="strong"><strong>ls conf/type</strong></span> to get the list of available types. If you have
|
||
setup the MANPATH correctly, you can use <span class="strong"><strong>man cdist-reference</strong></span> to access
|
||
the reference with pointers to the manpages.</p><p>Types in manifests are used like normal command line tools. Let’s have a look
|
||
at an example:</p><pre class="screen"># Create object of type __package with the parameter state = removed
|
||
__package apache2 --state removed
|
||
|
||
# Same with the __directory type
|
||
__directory /tmp/cdist --state present</pre><p>These two lines create objects, which will later be used to realise the
|
||
configuration on the target host.</p><p>Manifests are executed locally as a shell script using <span class="strong"><strong>/bin/sh -e</strong></span>.
|
||
The resulting objects are stored in an internal database.</p><p>The same object can be redefined in multiple different manifests as long as
|
||
the parameters are exactly the same.</p><p>In general, manifests are used to define which types are used depending
|
||
on given conditions.</p></div><div class="section" title="3. INITIAL AND TYPE MANIFESTS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_initial_and_type_manifests"></a>3. INITIAL AND TYPE MANIFESTS</h2></div></div></div><p>Cdist knows about two types of manifests: The initial manifest and type
|
||
manifests. The initial manifest is used to define, which configurations
|
||
to apply to which hosts. The type manifests are used to create objects
|
||
from types. More about manifests in types can be found in cdist-type(7).</p></div><div class="section" title="4. DEFINE STATE IN THE INITIAL MANIFEST"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_define_state_in_the_initial_manifest"></a>4. DEFINE STATE IN THE INITIAL MANIFEST</h2></div></div></div><p>The <span class="strong"><strong>initial manifest</strong></span> is the entry point for cdist to find out, which
|
||
<span class="strong"><strong>objects</strong></span> to configure on the selected host.
|
||
Cdist searches for the initial manifest at <span class="strong"><strong>conf/manifest/init</strong></span>.</p><p>Within this initial manifest, you define, which objects should be
|
||
created on which host. To distinguish between hosts, you can use the
|
||
environment variable <span class="strong"><strong>__target_host</strong></span>. Let’s have a look at a simple
|
||
example:</p><pre class="screen">__cdistmarker
|
||
|
||
case "$__target_host" in
|
||
localhost)
|
||
__directory /home/services/kvm-vm --parents yes
|
||
;;
|
||
esac</pre><p>This manifest says: Independent of the host, always use the type
|
||
<span class="strong"><strong><span class="strong"><strong>__cdistmarker</strong></span></strong></span>, which creates the file <span class="strong"><strong>/etc/cdist-configured</strong></span>,
|
||
with the timestamp as content.
|
||
The directory <span class="strong"><strong><span class="strong"><strong>/home/services/kvm-vm</strong></span></strong></span>, including all parent directories,
|
||
is only created on the host <span class="strong"><strong><span class="strong"><strong>localhost</strong></span></strong></span>.</p><p>As you can see, there is no magic involved, the manifest is simple shell code that
|
||
utilises cdist types. Every available type can be executed like a normal
|
||
command.</p></div><div class="section" title="5. SPLITTING UP THE INITIAL MANIFEST"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_splitting_up_the_initial_manifest"></a>5. SPLITTING UP THE INITIAL MANIFEST</h2></div></div></div><p>If you want to split up your initial manifest, you can create other shell
|
||
scripts in <span class="strong"><strong>conf/manifest/</strong></span> and include them in <span class="strong"><strong>conf/manifest/init</strong></span>.
|
||
Cdist provides the environment variable <span class="strong"><strong><span class="strong"><strong>__manifest</strong></span></strong></span> to reference to
|
||
the directory containing the initial manifest (see cdist-reference(7)).</p><p>The following example would include every file with a <span class="strong"><strong>.sh</strong></span> suffix:</p><pre class="screen"># Include *.sh
|
||
for manifest in $__manifest/*.sh; do
|
||
# And source scripts into our shell environment
|
||
. "$manifest"
|
||
done</pre></div><div class="section" title="6. DEPENDENCIES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_dependencies"></a>6. DEPENDENCIES</h2></div></div></div><p>If you want to describe that something requires something else, just
|
||
setup the variable "require" to contain the requirements. Multiple
|
||
requirements can be added white space seperated.</p><pre class="screen"># No dependency
|
||
__file /etc/cdist-configured
|
||
|
||
# Require above object
|
||
require="__file/etc/cdist-configured" __link /tmp/cdist-testfile \
|
||
--source /etc/cdist-configured --type symbolic
|
||
|
||
# Require two objects
|
||
require="__file/etc/cdist-configured __link/tmp/cdist-testfile" \
|
||
__file /tmp/cdist-another-testfile</pre><p>All objects that are created in a type manifest are automatically required
|
||
from the type that is calling them. This is called "autorequirement" in
|
||
cdist jargon.</p></div><div class="section" title="7. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>7. EXAMPLES</h2></div></div></div><p>The initial manifest may for instance contain the following code:</p><pre class="screen"># Always create this file, so other sysadmins know cdist is used.
|
||
__file /etc/cdist-configured --type file
|
||
|
||
case "$__target_host" in
|
||
my.server.name)
|
||
__file /root/bin/ --type directory
|
||
__file /etc/issue.net --type file --source "$__manifest/issue.net
|
||
;;
|
||
esac</pre><p>The manifest of the type "nologin" may look like this:</p><pre class="screen">__file /etc/nologin --type file --source "$__type/files/default.nologin"</pre></div><div class="section" title="8. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>8. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||
cdist-tutorial(7)
|
||
</li><li class="listitem">
|
||
cdist-type(7)
|
||
</li></ul></div></div><div class="section" title="9. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>9. COPYING</h2></div></div></div><p>Copyright (C) 2010-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>
|