cdist-backup/doc/man/cdist-config-layout.text

cdist-config-layout(7)
======================
Nico Schottelius <nico-cdist--@--schottelius.org>


NAME
----
cdist-config-layout - Usage of paths in cdist


DESCRIPTION
-----------
If not otherwise specified, all paths are relative to the configuration
directory, which is normally /etc/cdist (but can be changed using environment
variables, see cdist-environment(7)).

- manifests/init:
   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 for 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.

- manifests/*: All other files in this directory
   Cdist does not use them directly, 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.

- explorers/<name>
   Contains explorers to be run on the target hosts, see cdist-explorers(7).

- types/
   Contains all available types, which are used to provide
   some kind of functionality. See cdist-stages(7).

- types/<name>/init:
   Used to generate additional objects from a type.
   See cdist-stages(7), cdist-types(7).

- types/<name>/gencode:
   Used to generate code to be executed on the client.
   See cdist-types(7).

- types/<name>/parameters/required:
   Parameters required by type, \n seperated list.
   See cdist-types(7).

- types/<name>/parameters/required:
   Parameters optionally accepted by type, \n seperated list.
   See cdist-types(7).

- types/<name>/explorers:
   Location of the type specific explorers.
   See cdist-explorers(7).

- /output-tree/
   This directory contains output of cdist and is mirrored into the
   cache after a successful run. This directory may be placed below
   the tmpdir or at any other location.

- /output-tree/hosts/:
   Contains output of hosts.

- /output-tree/hosts/<name>:
   Contains cache of the specific host.

- /output-tree/hosts/<name>/explorers:
   Output of general explorers.

- /output-tree/hosts/<name>/objects:
   Objects created during last run for the host.

- /output-tree/hosts/<name>/objects/<object>/explorers:
   Output of type specific explorers, per object.

- tmpdir: Temporary storage
   A tempdir and a tempfile is provided by cdist-config(1), which
   will be removed when the scripts ends automatically.

FUTURE
------
The following functionality may be implemented in the next release (or so).

- tmpdir/cache/: New cache
   This directory contains elements for the new cache of the host.
   If all stages are completed successfully, the new cache is used
   to replace the previous one.

- cache/
   The cache contains the cconfig output tree from previous runs, which
   may also be used in types to gather information about other hosts
   (like ssh-keys).


AUTHOR
------
Nico Schottelius <mailto:nico-cdist--@--schottelius.org[]>


RESOURCES
---------
Main web site: http://www.nico.schottelius.org/cdist/[]


COPYING
-------
Copyright \(C) 2010-2011 Nico Schottelius. Free use of this software is
granted under the terms of the GNU General Public License version 3 (GPLv3).