cdist update
This commit is contained in:
Nico Schottelius
parent
36027b847a
commit
1ce65274db
2 changed files with 325 additions and 1 deletions
|
|
@ -230,7 +230,7 @@ Yes, I'm actually eating my own dogfood and currently managing
|
||||||
* [xfce](http://www.xfce.org/) (lightweight desktop environment)
|
* [xfce](http://www.xfce.org/) (lightweight desktop environment)
|
||||||
* [slim](http://slim.berlios.de/) (graphical login manager for X11)
|
* [slim](http://slim.berlios.de/) (graphical login manager for X11)
|
||||||
|
|
||||||
with cdist on a total of **9** production machines of the
|
with cdist on a total of **20** production machines of the
|
||||||
[Systems Group](http://www.systems.ethz.ch) at the
|
[Systems Group](http://www.systems.ethz.ch) at the
|
||||||
[ETH Zurich](http://www.ethz.ch) as well at home.
|
[ETH Zurich](http://www.ethz.ch) as well at home.
|
||||||
|
|
||||||
|
|
|
||||||
324
software/cdist/man/cdist-reference.html
Normal file
324
software/cdist/man/cdist-reference.html
Normal file
|
|
@ -0,0 +1,324 @@
|
||||||
|
<?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="id444302"></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"><<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="#_paths">3. PATHS</a></span></dt><dt><span class="section"><a href="#_types">4. TYPES</a></span></dt><dt><span class="section"><a href="#_variables">5. VARIABLES</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" 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. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Various scripts which are not in the core need information on how
|
||||||
|
to find information. This manpage summarises the available environment
|
||||||
|
variables, types and paths and clearifies with part may access which variables.</p></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><p class="simpara">
|
||||||
|
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.
|
||||||
|
</p><pre class="literallayout">It should be primary used to define mapping from configurations to hosts.</pre></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/<name>
|
||||||
|
</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/<name>/
|
||||||
|
</span></dt><dd><p class="simpara">
|
||||||
|
Home of the type <name>.
|
||||||
|
</p><pre class="literallayout">This directory is referenced by the variable __type (see below).</pre></dd><dt><span class="term">
|
||||||
|
conf/type/<name>/man.text
|
||||||
|
</span></dt><dd>
|
||||||
|
Manpage in Asciidoc format (nequired for inclusion into upstream)
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
conf/type/<name>/manifest
|
||||||
|
</span></dt><dd>
|
||||||
|
Used to generate additional objects from a type.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
conf/type/<name>/gencode-local
|
||||||
|
</span></dt><dd>
|
||||||
|
Used to generate code to be executed on the server.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
conf/type/<name>/gencode-remote
|
||||||
|
</span></dt><dd>
|
||||||
|
Used to generate code to be executed on the client.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
conf/type/<name>/parameters/required
|
||||||
|
</span></dt><dd>
|
||||||
|
Parameters required by type, \n seperated list.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
conf/type/<name>/parameters/optional
|
||||||
|
</span></dt><dd>
|
||||||
|
Parameters optionally accepted by type, \n seperated list.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
conf/type/<name>/explorer
|
||||||
|
</span></dt><dd><p class="simpara">
|
||||||
|
Location of the type specific explorers.
|
||||||
|
</p><pre class="literallayout">This directory is referenced by the variable __type_explorer (see below).</pre><pre class="literallayout">See cdist-explorer(7).</pre></dd><dt><span class="term">
|
||||||
|
out/
|
||||||
|
</span></dt><dd><p class="simpara">
|
||||||
|
This directory contains output of cdist and is usually located
|
||||||
|
in a temporary directory and thus will be removed after the run.
|
||||||
|
</p><pre class="literallayout">This directory is referenced by the variable __global (see below).</pre></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><p class="simpara">
|
||||||
|
Contains all object specific information.
|
||||||
|
</p><pre class="literallayout">This directory is referenced by the variable __object (see below).</pre></dd><dt><span class="term">
|
||||||
|
out/object/<object>/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
|
||||||
|
</li><li class="listitem">
|
||||||
|
__addifnosuchline.html
|
||||||
|
</li><li class="listitem">
|
||||||
|
__addifnosuchline.text
|
||||||
|
</li><li class="listitem">
|
||||||
|
__apt_ppa
|
||||||
|
</li><li class="listitem">
|
||||||
|
__apt_ppa.html
|
||||||
|
</li><li class="listitem">
|
||||||
|
__apt_ppa.text
|
||||||
|
</li><li class="listitem">
|
||||||
|
__directory
|
||||||
|
</li><li class="listitem">
|
||||||
|
__directory.html
|
||||||
|
</li><li class="listitem">
|
||||||
|
__directory.text
|
||||||
|
</li><li class="listitem">
|
||||||
|
__file
|
||||||
|
</li><li class="listitem">
|
||||||
|
__file.html
|
||||||
|
</li><li class="listitem">
|
||||||
|
__file.text
|
||||||
|
</li><li class="listitem">
|
||||||
|
__group
|
||||||
|
</li><li class="listitem">
|
||||||
|
__group.html
|
||||||
|
</li><li class="listitem">
|
||||||
|
__group.text
|
||||||
|
</li><li class="listitem">
|
||||||
|
__issue
|
||||||
|
</li><li class="listitem">
|
||||||
|
__issue.html
|
||||||
|
</li><li class="listitem">
|
||||||
|
__issue.text
|
||||||
|
</li><li class="listitem">
|
||||||
|
__key_value
|
||||||
|
</li><li class="listitem">
|
||||||
|
__key_value.html
|
||||||
|
</li><li class="listitem">
|
||||||
|
__key_value.text
|
||||||
|
</li><li class="listitem">
|
||||||
|
__link
|
||||||
|
</li><li class="listitem">
|
||||||
|
__link.html
|
||||||
|
</li><li class="listitem">
|
||||||
|
__link.text
|
||||||
|
</li><li class="listitem">
|
||||||
|
__motd
|
||||||
|
</li><li class="listitem">
|
||||||
|
__motd.html
|
||||||
|
</li><li class="listitem">
|
||||||
|
__motd.text
|
||||||
|
</li><li class="listitem">
|
||||||
|
__package
|
||||||
|
</li><li class="listitem">
|
||||||
|
__package_apt
|
||||||
|
</li><li class="listitem">
|
||||||
|
__package_apt.html
|
||||||
|
</li><li class="listitem">
|
||||||
|
__package_apt.text
|
||||||
|
</li><li class="listitem">
|
||||||
|
__package.html
|
||||||
|
</li><li class="listitem">
|
||||||
|
__package_pacman
|
||||||
|
</li><li class="listitem">
|
||||||
|
__package_pacman.html
|
||||||
|
</li><li class="listitem">
|
||||||
|
__package_pacman.text
|
||||||
|
</li><li class="listitem">
|
||||||
|
__package.text
|
||||||
|
</li><li class="listitem">
|
||||||
|
__process
|
||||||
|
</li><li class="listitem">
|
||||||
|
__process.html
|
||||||
|
</li><li class="listitem">
|
||||||
|
__process.text
|
||||||
|
</li><li class="listitem">
|
||||||
|
__removeline
|
||||||
|
</li><li class="listitem">
|
||||||
|
__removeline.html
|
||||||
|
</li><li class="listitem">
|
||||||
|
__removeline.text
|
||||||
|
</li><li class="listitem">
|
||||||
|
__user
|
||||||
|
</li><li class="listitem">
|
||||||
|
__user.html
|
||||||
|
</li><li class="listitem">
|
||||||
|
__user.text
|
||||||
|
</li></ul></div></div><div class="section" title="5. VARIABLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_variables"></a>5. VARIABLES</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
__explorer
|
||||||
|
</span></dt><dd>
|
||||||
|
Directory that contains all 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 explorer, type codegen
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
__object
|
||||||
|
</span></dt><dd>
|
||||||
|
Directory that contains the current object.
|
||||||
|
Available for: type manifest, type explorer, type codegen
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
__object_id
|
||||||
|
</span></dt><dd>
|
||||||
|
The type unique object id.
|
||||||
|
Available for: type manifest, type explorer, type codegen
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
__self
|
||||||
|
</span></dt><dd>
|
||||||
|
The full qualified name of the current object.
|
||||||
|
Available for: type manifest, type explorer, type codegen
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
__target_host
|
||||||
|
</span></dt><dd>
|
||||||
|
The host we are deploying to.
|
||||||
|
Available for: initial manifest, type manifest, type codegen
|
||||||
|
</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
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
__type_explorers
|
||||||
|
</span></dt><dd>
|
||||||
|
Directory that contains the type explorers.
|
||||||
|
Available for: type explorer
|
||||||
|
</dd></dl></div></div><div class="section" title="6. SEE ALSO"><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" type="disc"><li class="listitem">
|
||||||
|
cdist(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__addifnosuchline(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__addifnosuchline.html(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__addifnosuchline.text(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__apt_ppa(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__apt_ppa.html(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__apt_ppa.text(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__directory(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__directory.html(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__directory.text(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__file(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__file.html(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__file.text(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__group(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__group.html(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__group.text(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__issue(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__issue.html(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__issue.text(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__key_value(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__key_value.html(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__key_value.text(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__link(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__link.html(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__link.text(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__motd(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__motd.html(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__motd.text(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__package(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__package_apt(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__package_apt.html(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__package_apt.text(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__package.html(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__package_pacman(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__package_pacman.html(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__package_pacman.text(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__package.text(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__process(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__process.html(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__process.text(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__removeline(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__removeline.html(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__removeline.text(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__user(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__user.html(7)
|
||||||
|
</li><li class="listitem">
|
||||||
|
cdist-type__user.text(7)
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. 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>
|
||||||
Loading…
Reference in a new issue