Ubuntu Manpage: cdist-reference - Variable, path and type reference for cdist

NAME

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

EXPLORERS

       The following global explorers are available:

       •   cpu_cores

       •   cpu_sockets

       •   disks

       •   hostname

       •   interfaces

       •   lsb_codename

       •   lsb_description

       •   lsb_id

       •   lsb_release

       •   machine

       •   machine_type

       •   memory

       •   os

       •   os_version

       •   runlevel

PATHS

$HOME/.cdist
The standard cdist configuration directory relative to your home directory This is
usually the place you want to store your site specific configuration

cdist/conf/
The distribution configuration directory This contains types and explorers to be used

confdir
Cdist will use all available configuration directories and create a temporary confdir
containing links to the real configuration directories. This way it is possible to
merge configuration directories. By default it consists of everything in $HOME/.cdist
and cdist/conf/. For more details see cdist(1)

confdir/manifest/init
This is the central entry point. 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. Its intent is to used to define mapping from configurations to
hosts.

confdir/manifest/*
All other files in this directory are not directly used by cdist, but you can separate
configuration mappings, if you have a lot of code in the conf/manifest/init file. This
may also be helpful to have different admins maintain different groups of hosts.

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

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

confdir/type/<name>/
Home of the type <name>. This directory is referenced by the variable __type (see
below).

confdir/type/<name>/man.text
Manpage in Asciidoc format (required for inclusion into upstream)

confdir/type/<name>/manifest
Used to generate additional objects from a type.

confdir/type/<name>/gencode-local
Used to generate code to be executed on the source host

confdir/type/<name>/gencode-remote
Used to generate code to be executed on the target host

confdir/type/<name>/parameter/required
Parameters required by type, \n separated list.

confdir/type/<name>/parameter/optional
Parameters optionally accepted by type, \n separated list.

confdir/type/<name>/parameter/default/*
Default values for optional parameters. Assuming an optional parameter name of foo,
it’s default value would be read from the file
confdir/type/<name>/parameter/default/foo.

confdir/type/<name>/parameter/boolean
Boolean parameters accepted by type, \n separated list.

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

confdir/type/<name>/files
This directory is reserved for user data and will not be used by cdist at any time. It
can be used for storing supplementary files (like scripts to act as a template or
configuration files).

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.

TYPES

       The following types are available:

       •   __apt_key (cdist-type__apt_key(7))

       •   __apt_key_uri (cdist-type__apt_key_uri(7))

       •   __apt_norecommends (cdist-type__apt_norecommends(7))

       •   __apt_ppa (cdist-type__apt_ppa(7))

       •   __apt_source (cdist-type__apt_source(7))

       •   __apt_update_index (cdist-type__apt_update_index(7))

       •   __block (cdist-type__block(7))

       •   __ccollect_source (cdist-type__ccollect_source(7))

       •   __cdist (cdist-type__cdist(7))

       •   __cdistmarker (cdist-type__cdistmarker(7))

       •   __chroot_mount (cdist-type__chroot_mount(7))

       •   __chroot_umount (cdist-type__chroot_umount(7))

       •   __cron (cdist-type__cron(7))

       •   __debconf_set_selections (cdist-type__debconf_set_selections(7))

       •   __directory (cdist-type__directory(7))

       •   __dog_vdi (cdist-type__dog_vdi(7))

       •   __file (cdist-type__file(7))

       •   __git (cdist-type__git(7))

       •   __group (cdist-type__group(7))

       •   __hostname (cdist-type__hostname(7))

       •   __install_bootloader_grub (cdist-type__install_bootloader_grub(7))

       •   __install_chroot_mount (cdist-type__install_chroot_mount(7))

       •   __install_chroot_umount (cdist-type__install_chroot_umount(7))

       •   __install_config (cdist-type__install_config(7))

       •   __install_file (cdist-type__install_file(7))

       •   __install_fstab (cdist-type__install_fstab(7))

       •   __install_generate_fstab (cdist-type__install_generate_fstab(7))

       •   __install_mkfs (cdist-type__install_mkfs(7))

       •   __install_mount (cdist-type__install_mount(7))

       •   __install_partition_msdos (cdist-type__install_partition_msdos(7))

       •   __install_partition_msdos_apply (cdist-type__install_partition_msdos_apply(7))

       •   __install_reboot (cdist-type__install_reboot(7))

       •   __install_reset_disk (cdist-type__install_reset_disk(7))

       •   __install_stage (cdist-type__install_stage(7))

       •   __install_umount (cdist-type__install_umount(7))

       •   __iptables_apply (cdist-type__iptables_apply(7))

       •   __iptables_rule (cdist-type__iptables_rule(7))

       •   __issue (cdist-type__issue(7))

       •   __jail (cdist-type__jail(7))

       •   __key_value (cdist-type__key_value(7))

       •   __line (cdist-type__line(7))

       •   __link (cdist-type__link(7))

       •   __locale (cdist-type__locale(7))

       •   __motd (cdist-type__motd(7))

       •   __mount (cdist-type__mount(7))

       •   __mysql_database (cdist-type__mysql_database(7))

       •   __package (cdist-type__package(7))

       •   __package_apt (cdist-type__package_apt(7))

       •   __package_emerge (cdist-type__package_emerge(7))

       •   __package_emerge_dependencies (cdist-type__package_emerge_dependencies(7))

       •   __package_luarocks (cdist-type__package_luarocks(7))

       •   __package_opkg (cdist-type__package_opkg(7))

       •   __package_pacman (cdist-type__package_pacman(7))

       •   __package_pip (cdist-type__package_pip(7))

       •   __package_pkg_freebsd (cdist-type__package_pkg_freebsd(7))

       •   __package_pkg_openbsd (cdist-type__package_pkg_openbsd(7))

       •   __package_rubygem (cdist-type__package_rubygem(7))

       •   __package_yum (cdist-type__package_yum(7))

       •   __package_zypper (cdist-type__package_zypper(7))

       •   __pf_apply (cdist-type__pf_apply(7))

       •   __pf_ruleset (cdist-type__pf_ruleset(7))

       •   __postfix (cdist-type__postfix(7))

       •   __postfix_master (cdist-type__postfix_master(7))

       •   __postfix_postconf (cdist-type__postfix_postconf(7))

       •   __postfix_postmap (cdist-type__postfix_postmap(7))

       •   __postfix_reload (cdist-type__postfix_reload(7))

       •   __postgres_database (cdist-type__postgres_database(7))

       •   __postgres_role (cdist-type__postgres_role(7))

       •   __process (cdist-type__process(7))

       •   __qemu_img (cdist-type__qemu_img(7))

       •   __rbenv (cdist-type__rbenv(7))

       •   __rvm (cdist-type__rvm(7))

       •   __rvm_gem (cdist-type__rvm_gem(7))

       •   __rvm_gemset (cdist-type__rvm_gemset(7))

       •   __rvm_ruby (cdist-type__rvm_ruby(7))

       •   __ssh_authorized_keys (cdist-type__ssh_authorized_keys(7))

       •   __start_on_boot (cdist-type__start_on_boot(7))

       •   __timezone (cdist-type__timezone(7))

       •   __update_alternatives (cdist-type__update_alternatives(7))

       •   __user (cdist-type__user(7))

       •   __user_groups (cdist-type__user_groups(7))

       •   __yum_repo (cdist-type__yum_repo(7))

       •   __zypper_repo (cdist-type__zypper_repo(7))

       •   __zypper_service (cdist-type__zypper_service(7))

OBJECTS

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

       files
           This directory is reserved for user data and will not be used by cdist at any time. It
           can be used freely by the type (for instance to store template results).

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

       stdin
           This file exists and contains data, if data was provided on stdin when the type was
           called.

ENVIRONMENT VARIABLES (FOR READING)

The following environment variables are exported by cdist:

__explorer
Directory that contains all global explorers. Available for: initial manifest,
explorer, type explorer, shell

__manifest
Directory that contains the initial manifest. Available for: initial manifest, type
manifest, shell

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

__messages_in
File to read messages from Available for: initial manifest, type manifest, type
gencode

__messages_out
File to write messages Available for: initial manifest, type manifest, type gencode

__object
Directory that contains the current object. Available for: type manifest, type
explorer, type gencode and code scripts

__object_id
The type unique object id. Available for: type manifest, type explorer, type gencode
and code scripts 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.

__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: explorer, initial manifest, type
explorer, type manifest, type gencode, shell

__type
Path to the current type. Available for: type manifest, type gencode

__type_explorer
Directory that contains the type explorers. Available for: type explorer

ENVIRONMENT VARIABLES (FOR WRITING)

       The following environment variables influence the behaviour of cdist:

       require
           Setup dependencies between objects (see cdist-manifest(7))

       CDIST_LOCAL_SHELL
           Use this shell locally instead of /bin/sh to execute scripts

       CDIST_REMOTE_SHELL
           Use this shell remotely instead of /bin/sh to execute scripts

       CDIST_OVERRIDE
           Allow overwriting type parameters (see cdist-manifest(7))

       CDIST_ORDER_DEPENDENCY
           Create dependencies based on the execution order (see cdist-manifest(7))

COPYING

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

AUTHOR

       Nico Schottelius <nico-cdist--@--schottelius.org>
           Author.

                                            04/07/2016                         CDIST-REFERENCE(7)