From 1ce65274db45a4ac844c87e8b84efdb0a14f2cde Mon Sep 17 00:00:00 2001 From: Nico Schottelius Date: Sat, 2 Apr 2011 01:26:01 +0200 Subject: [PATCH] cdist update --- software/cdist.mdwn | 2 +- software/cdist/man/cdist-reference.html | 324 ++++++++++++++++++++++++ 2 files changed, 325 insertions(+), 1 deletion(-) create mode 100644 software/cdist/man/cdist-reference.html diff --git a/software/cdist.mdwn b/software/cdist.mdwn index 1fd28ffd..18352d5a 100644 --- a/software/cdist.mdwn +++ b/software/cdist.mdwn @@ -230,7 +230,7 @@ Yes, I'm actually eating my own dogfood and currently managing * [xfce](http://www.xfce.org/) (lightweight desktop environment) * [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 [ETH Zurich](http://www.ethz.ch) as well at home. diff --git a/software/cdist/man/cdist-reference.html b/software/cdist/man/cdist-reference.html new file mode 100644 index 00000000..4a019f10 --- /dev/null +++ b/software/cdist/man/cdist-reference.html @@ -0,0 +1,324 @@ + + +cdist-reference(7)

cdist-reference(7)

Nico Schottelius

Table of Contents

1. NAME
2. DESCRIPTION
3. PATHS
4. TYPES
5. VARIABLES
6. SEE ALSO
7. COPYING

1. NAME

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

2. DESCRIPTION

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.

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 very 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 (nequired 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. + See cdist-config(1). +

4. TYPES

The following types are available:

  • +__addifnosuchline +
  • +__addifnosuchline.html +
  • +__addifnosuchline.text +
  • +__apt_ppa +
  • +__apt_ppa.html +
  • +__apt_ppa.text +
  • +__directory +
  • +__directory.html +
  • +__directory.text +
  • +__file +
  • +__file.html +
  • +__file.text +
  • +__group +
  • +__group.html +
  • +__group.text +
  • +__issue +
  • +__issue.html +
  • +__issue.text +
  • +__key_value +
  • +__key_value.html +
  • +__key_value.text +
  • +__link +
  • +__link.html +
  • +__link.text +
  • +__motd +
  • +__motd.html +
  • +__motd.text +
  • +__package +
  • +__package_apt +
  • +__package_apt.html +
  • +__package_apt.text +
  • +__package.html +
  • +__package_pacman +
  • +__package_pacman.html +
  • +__package_pacman.text +
  • +__package.text +
  • +__process +
  • +__process.html +
  • +__process.text +
  • +__removeline +
  • +__removeline.html +
  • +__removeline.text +
  • +__user +
  • +__user.html +
  • +__user.text +

5. VARIABLES

+__explorer +
+ Directory that contains all 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 explorer, type codegen +
+__object +
+ Directory that contains the current object. + Available for: type manifest, type explorer, type codegen +
+__object_id +
+ The type unique object id. + Available for: type manifest, type explorer, type codegen +
+__self +
+ The full qualified name of the current object. + Available for: type manifest, type explorer, type codegen +
+__target_host +
+ The host we are deploying to. + Available for: initial manifest, type manifest, type codegen +
+__target_user +
+ User to use for authentication on remote host. + Currently static in core. +
+__type +
+ Path to the current type. + Available for: type manifest +
+__type_explorers +
+ Directory that contains the type explorers. + Available for: type explorer +

6. SEE ALSO

  • +cdist(7) +
  • +cdist-type__addifnosuchline(7) +
  • +cdist-type__addifnosuchline.html(7) +
  • +cdist-type__addifnosuchline.text(7) +
  • +cdist-type__apt_ppa(7) +
  • +cdist-type__apt_ppa.html(7) +
  • +cdist-type__apt_ppa.text(7) +
  • +cdist-type__directory(7) +
  • +cdist-type__directory.html(7) +
  • +cdist-type__directory.text(7) +
  • +cdist-type__file(7) +
  • +cdist-type__file.html(7) +
  • +cdist-type__file.text(7) +
  • +cdist-type__group(7) +
  • +cdist-type__group.html(7) +
  • +cdist-type__group.text(7) +
  • +cdist-type__issue(7) +
  • +cdist-type__issue.html(7) +
  • +cdist-type__issue.text(7) +
  • +cdist-type__key_value(7) +
  • +cdist-type__key_value.html(7) +
  • +cdist-type__key_value.text(7) +
  • +cdist-type__link(7) +
  • +cdist-type__link.html(7) +
  • +cdist-type__link.text(7) +
  • +cdist-type__motd(7) +
  • +cdist-type__motd.html(7) +
  • +cdist-type__motd.text(7) +
  • +cdist-type__package(7) +
  • +cdist-type__package_apt(7) +
  • +cdist-type__package_apt.html(7) +
  • +cdist-type__package_apt.text(7) +
  • +cdist-type__package.html(7) +
  • +cdist-type__package_pacman(7) +
  • +cdist-type__package_pacman.html(7) +
  • +cdist-type__package_pacman.text(7) +
  • +cdist-type__package.text(7) +
  • +cdist-type__process(7) +
  • +cdist-type__process.html(7) +
  • +cdist-type__process.text(7) +
  • +cdist-type__removeline(7) +
  • +cdist-type__removeline.html(7) +
  • +cdist-type__removeline.text(7) +
  • +cdist-type__user(7) +
  • +cdist-type__user.html(7) +
  • +cdist-type__user.text(7) +

7. COPYING

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