2011-04-01 23:26:01 +00:00
<?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">
2011-04-19 20:48:04 +00:00
< 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 = "id389381" > < / 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 = "#_environment_variables" > 5. ENVIRONMENT 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. > < div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" > < a id = "_name" > < / a > 1. < / h2 > < / div > < / div > < / div > < p > cdist-reference - Variable, path and type reference for cdist< / p > < / div > < div class = "section" title = "2. > < div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" > < a id = "_description" > < / a > 2. < / h2 > < / div > < / div > < / div > < p > This reference summarises< / p > < div class = "itemizedlist" > < ul class = "itemizedlist" type = "disc" > < li class = "listitem" >
2011-04-06 17:35:40 +00:00
environment variables
< / li > < li class = "listitem" >
paths
< / li > < li class = "listitem" >
types
< / li > < / ul > < / div > < / div > < div class = "section" title = "3. > < div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" > < a id = "_paths" > < / a > 3. < / 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" >
2011-04-01 23:26:01 +00:00
conf/
< / span > < / dt > < dd >
Contains the (static) configuration like manifests, types and explorers.
< / dd > < dt > < span class = "term" >
conf/manifest/init
2011-04-06 17:35:40 +00:00
< / span > < / dt > < dd >
2011-04-01 23:26:01 +00:00
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.
2011-04-06 17:35:40 +00:00
It should be primary used to define mapping from configurations to hosts.
< / dd > < dt > < span class = "term" >
2011-04-01 23:26:01 +00:00
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
2011-04-06 17:35:40 +00:00
< / span > < / dt > < dd >
2011-04-01 23:26:01 +00:00
Location of the type specific explorers.
2011-04-06 17:35:40 +00:00
This directory is referenced by the variable __type_explorer (see below).
See cdist-explorer(7).
< / dd > < dt > < span class = "term" >
2011-04-01 23:26:01 +00:00
out/
2011-04-06 17:35:40 +00:00
< / span > < / dt > < dd >
2011-04-01 23:26:01 +00:00
This directory contains output of cdist and is usually located
in a temporary directory and thus will be removed after the run.
2011-04-06 17:35:40 +00:00
This directory is referenced by the variable __global (see below).
< / dd > < dt > < span class = "term" >
2011-04-01 23:26:01 +00:00
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>
2011-04-06 17:35:40 +00:00
< / span > < / dt > < dd >
2011-04-01 23:26:01 +00:00
Contains all object specific information.
2011-04-06 17:35:40 +00:00
This directory is referenced by the variable __object (see below).
< / dd > < dt > < span class = "term" >
2011-04-01 23:26:01 +00:00
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).
2011-04-06 17:35:40 +00:00
< / dd > < / dl > < / div > < / div > < div class = "section" title = "4. > < div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" > < a id = "_types" > < / a > 4. < / h2 > < / div > < / div > < / div > < p > The following types are available:< / p > < div class = "itemizedlist" > < ul class = "itemizedlist" type = "disc" > < li class = "listitem" >
2011-04-19 20:48:04 +00:00
< span class = "emphasis" > < em > * (cdist-type< / em > < / span > *(7))
2011-04-06 17:35:40 +00:00
< / li > < / ul > < / div > < / div > < div class = "section" title = "5. > < div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" > < a id = "_environment_variables" > < / a > 5. < / h2 > < / div > < / div > < / div > < div class = "variablelist" > < dl > < dt > < span class = "term" >
2011-04-01 23:26:01 +00:00
__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. > < div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" > < a id = "_see_also" > < / a > 6. < / 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 = "7. > < div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" > < a id = "_copying" > < / a > 7. < / 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 >
