cdist-reference(7)

Nico Schottelius

<nico-cdist--@--schottelius.org>

Table of Contents

1. NAME
2. EXPLORERS
3. PATHS
4. TYPES
5. OBJECTS
6. ENVIRONMENT VARIABLES
7. SEE ALSO
8. COPYING

1. NAME

cdist-reference - Variable, path and type reference for cdist

2. EXPLORERS

The following global explorers are available:

hostname
lsb_codename
lsb_description
lsb_id
lsb_release
machine
os
os_version

3. PATHS

If not specified otherwise, all paths are relative to the checkout directory.

conf/

Contains the (static) configuration like manifests, types and explorers.

conf/manifest/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 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.

conf/manifest/*

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 helpful to have different admins maintain different groups of hosts.

conf/explorer/<name>

Contains explorers to be run on the target hosts, see cdist-explorer(7).

conf/type/

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

conf/type/<name>/

Home of the type <name>.

This directory is referenced by the variable __type (see below).

conf/type/<name>/man.text

Manpage in Asciidoc format (required for inclusion into upstream)

conf/type/<name>/manifest

Used to generate additional objects from a type.

conf/type/<name>/gencode-local

Used to generate code to be executed on the server.

conf/type/<name>/gencode-remote

Used to generate code to be executed on the client.

conf/type/<name>/parameters/required

Parameters required by type, \n seperated list.

conf/type/<name>/parameters/optional

Parameters optionally accepted by type, \n seperated list.

conf/type/<name>/explorer

Location of the type specific explorers. This directory is referenced by the variable __type_explorer (see below). See cdist-explorer(7).

out/

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).

out/explorer

Output of general explorers.

out/object

Objects created for the host.

out/object/<object>

Contains all object specific information. This directory is referenced by the variable __object (see below).

out/object/<object>/explorers

Output of type specific explorers, per object.

tmp_dir

A tempdir and a tempfile is used by cdist internally, which will be removed when the scripts end automatically.

4. TYPES

The following types are available:

_* (cdist-type_*(7))

5. OBJECTS

For object to object communication and tests, the following paths are usable within a object directory:

changed: This empty file exists in an object directory, if the object has code to be excuted (either remote or local)

6. ENVIRONMENT VARIABLES

__explorer

Directory that contains all global explorers. Available for: explorer

__manifest

Directory that contains the initial manifest. Available for: initial manifest

__global

Directory that contains generic output like explorer. Available for: initial manifest, type manifest, type gencode

__object

Directory that contains the current object. Available for: type manifest, type explorer, type gencode

__object_id

The type unique object id. Available for: type manifest, type explorer, type gencode

Note: The leading and the trailing "/" will always be stripped (caused by
the filesystem database and ensured by the core).

    Note: Double slashes ("//") will not be fixed and result in an error.
__self::
    DEPRECATED: Same as __object_name, do not use anymore, use __object_name instead.
    Will be removed in cdist 3.x.
__object_name::
    The full qualified name of the current object.
    Available for: type manifest, type explorer, type gencode
__target_host::
    The host we are deploying to.
    Available for: initial manifest, type manifest, type gencode
__type::
    Path to the current type.
    Available for: type manifest, type gencode
__type_explorer::
    Directory that contains the type explorers.
    Available for: type explorer

7. SEE ALSO

cdist(1)