Cdist-config is sourced by cdist programs and provides hints on where to find +
Cdist-config is sourced by cdist programs and provides hints on where to find types, manifests, etc. Generally speaking, it’s just usable from within the core and is only of interest for cdist-developers.
The following list contains environment variables that are known to be changed by users in various situations. To change the variable, diff --git a/software/cdist/man/man1/cdist-env.html b/software/cdist/man/man1/cdist-env.html index f739bde2..30bfff07 100644 --- a/software/cdist/man/man1/cdist-env.html +++ b/software/cdist/man/man1/cdist-env.html @@ -1,6 +1,6 @@ -
Table of Contents
cdist-env outputs two strings suitable for usage in your current shell, +
Table of Contents
cdist-env outputs two strings suitable for usage in your current shell, so you can use cdist from the checkout. cdist-env essentially helps you to easily setup PATH and MANPATH.
If you’ve multiple checkouts of cdist and run cdist-env from the various checkouts, a new run will prepend the last directory, thus ensures you diff --git a/software/cdist/man/man1/cdist-quickstart.html b/software/cdist/man/man1/cdist-quickstart.html index a08b7504..65fd7557 100644 --- a/software/cdist/man/man1/cdist-quickstart.html +++ b/software/cdist/man/man1/cdist-quickstart.html @@ -1,6 +1,6 @@ -
Table of Contents
cdist-quickstart is an interactive guide to cdist. It should be one +
Table of Contents
cdist-quickstart is an interactive guide to cdist. It should be one of the first tools you use when you begin with cdist.
To use cdist-quickstart, add the bin directory to your PATH, execute cdist-quickstart and enjoy cdist:
# Bourne shell example export PATH=$(pwd -P)/bin:$PATH diff --git a/software/cdist/man/man1/cdist-type-emulator.html b/software/cdist/man/man1/cdist-type-emulator.html index 50dff8a1..e2e4039c 100644 --- a/software/cdist/man/man1/cdist-type-emulator.html +++ b/software/cdist/man/man1/cdist-type-emulator.html @@ -1,6 +1,6 @@ -cdist-type-emulator(1) Table of Contents
cdist-type-emulator is normally called through a link to it of the +
cdist-type-emulator(1) Table of Contents
cdist-type-emulator is normally called through a link to it of the name of a specifc type. It saves the given parameters into a parameters directory and the requirements into a require file.
It checks whether the parameters are valid:
- are required parameter given? diff --git a/software/cdist/man/man1/cdist.html b/software/cdist/man/man1/cdist.html index 7f71cee7..5e10ca91 100644 --- a/software/cdist/man/man1/cdist.html +++ b/software/cdist/man/man1/cdist.html @@ -1,6 +1,6 @@ -
cdist(1) Table of Contents
cdist [-h] [-V]
cdist banner
cdist config [-h] [-d] [-V] [-c CDIST_HOME] [-i MANIFEST] [-p] [-s] host [host …]
cdist is the frontend executable to the cdist configuration management. +
cdist(1) Table of Contents
cdist [-h] [-V]
cdist banner
cdist config [-h] [-d] [-V] [-c CDIST_HOME] [-i MANIFEST] [-p] [-s] host [host …]
cdist is the frontend executable to the cdist configuration management. cdist supports different as explained below. The options to the main program are:
- -h, --help diff --git a/software/cdist/man/man7/cdist-best-practice.html b/software/cdist/man/man7/cdist-best-practice.html index 673e6f59..ce91d4a2 100644 --- a/software/cdist/man/man7/cdist-best-practice.html +++ b/software/cdist/man/man7/cdist-best-practice.html @@ -1,6 +1,6 @@ -
cdist-best-practice(7) Table of Contents
It is recommended to run cdist with public key authentication. +
cdist-best-practice(7) Table of Contents
It is recommended to run cdist with public key authentication. This requires a private/public key pair and the entry "PermitRootLogin without-password" in the sshd server. See sshd_config(5) and ssh-keygen(1).
When connecting to a new host, the initial delay with ssh connections diff --git a/software/cdist/man/man7/cdist-explorer.html b/software/cdist/man/man7/cdist-explorer.html index 2171e47c..caa6491d 100644 --- a/software/cdist/man/man7/cdist-explorer.html +++ b/software/cdist/man/man7/cdist-explorer.html @@ -1,6 +1,6 @@ -
cdist-explorer(7) Table of Contents
Explorer are small shell scripts, which will be executed on the target +
cdist-explorer(7) Table of Contents
Explorer are small shell scripts, which will be executed on the target host. The aim of the explorer is to give hints to types on how to act on the target system. An explorer outputs the result to stdout, which is usually a one liner, but may be empty or multi line especially in the case of diff --git a/software/cdist/man/man7/cdist-hacker.html b/software/cdist/man/man7/cdist-hacker.html index 55531a96..b2dcbfee 100644 --- a/software/cdist/man/man7/cdist-hacker.html +++ b/software/cdist/man/man7/cdist-hacker.html @@ -1,6 +1,6 @@ -
cdist-hacker(7) Table of Contents
Welcome dear hacker! I invite you to a tour of pointers to +
cdist-hacker(7) Table of Contents
Welcome dear hacker! I invite you to a tour of pointers to get into the usable configuration mangament system, cdist.
The first thing to know is probably that cdist is brought to you by people who care about how code looks like and who think twice before merging or implementing a feature: Less features diff --git a/software/cdist/man/man7/cdist-manifest.html b/software/cdist/man/man7/cdist-manifest.html index 775b0887..337690b4 100644 --- a/software/cdist/man/man7/cdist-manifest.html +++ b/software/cdist/man/man7/cdist-manifest.html @@ -1,6 +1,6 @@ -
cdist-manifest(7) Table of Contents
Manifests exist to define which configurations should be applied to a specific +
cdist-manifest(7) Table of Contents
Manifests exist to define which configurations should be applied to a specific host as well as to define which configurations should be applied within a type. Manifests are executed locally and the resulting objects are stored in an internal database.
The same object can be redefined in multiple different manifests as long as diff --git a/software/cdist/man/man7/cdist-reference.html b/software/cdist/man/man7/cdist-reference.html index 5c81447c..21828443 100644 --- a/software/cdist/man/man7/cdist-reference.html +++ b/software/cdist/man/man7/cdist-reference.html @@ -1,6 +1,6 @@ -
cdist-reference(7) Table of Contents
The following global explores are available:
- +
cdist-reference(7) Table of Contents
The following global explores are available:
- hostname
- machine diff --git a/software/cdist/man/man7/cdist-stages.html b/software/cdist/man/man7/cdist-stages.html index af33626e..a242b5da 100644 --- a/software/cdist/man/man7/cdist-stages.html +++ b/software/cdist/man/man7/cdist-stages.html @@ -1,6 +1,6 @@ -
cdist-stages(7) Table of Contents
- 1. NAME
- 2. DESCRIPTION
- 3. STAGE 0: INTERNAL PREPERATION
- 4. STAGE 1: TARGET INFORMATION RETRIEVAL
- 5. STAGE 2: RUN THE INITIAL MANIFEST
- 6. STAGE 3: OBJECT INFORMATION RETRIEVAL
- 7. STAGE 4: RUN THE OBJECT MANIFEST
- 8. STAGE 5: CODE GENERATION
- 9. STAGE 6: CODE EXECUTION
- 10. STAGE 7: CACHE
- 11. SUMMARY
- 12. SEE ALSO
- 13. COPYING
Starting the execution of deployment with cdist-deploy-to(1), cdist passes +
cdist-stages(7) Table of Contents
- 1. NAME
- 2. DESCRIPTION
- 3. STAGE 0: INTERNAL PREPERATION
- 4. STAGE 1: TARGET INFORMATION RETRIEVAL
- 5. STAGE 2: RUN THE INITIAL MANIFEST
- 6. STAGE 3: OBJECT INFORMATION RETRIEVAL
- 7. STAGE 4: RUN THE OBJECT MANIFEST
- 8. STAGE 5: CODE GENERATION
- 9. STAGE 6: CODE EXECUTION
- 10. STAGE 7: CACHE
- 11. SUMMARY
- 12. SEE ALSO
- 13. COPYING
Starting the execution of deployment with cdist-deploy-to(1), cdist passes through different stages, each can be triggered and debugged on its own. Reading the source of the cdist-deploy-to executable shows the scripts responsible for each stage.
Before running the user facing stages, cdist prepares the target host diff --git a/software/cdist/man/man7/cdist-tutorial.html b/software/cdist/man/man7/cdist-tutorial.html index 18b54bcf..25a8cc7b 100644 --- a/software/cdist/man/man7/cdist-tutorial.html +++ b/software/cdist/man/man7/cdist-tutorial.html @@ -1,6 +1,6 @@ -
cdist-tutorial(7) Table of Contents
This tutorial is aimed at people learning cdist and shows +
cdist-tutorial(7) Table of Contents
This tutorial is aimed at people learning cdist and shows typical approaches as well as gives an easy start into the world of configuration management.
This tutorial assumes you are configuring localhost, because it is always available. Just repace localhost with your target diff --git a/software/cdist/man/man7/cdist-type.html b/software/cdist/man/man7/cdist-type.html index aa42db3a..74fdf3aa 100644 --- a/software/cdist/man/man7/cdist-type.html +++ b/software/cdist/man/man7/cdist-type.html @@ -1,6 +1,6 @@ -
cdist-type(7) Table of Contents
- 1. NAME
- 2. SYNOPSIS
- 3. DESCRIPTION
- 4. HOW TO USE A TYPE
- 5. SINGLETON TYPES
- 6. HOW TO WRITE A NEW TYPE
- 7. DEFINING PARAMETERS
- 8. WRITING THE MANIFEST
- 9. SINGLETON - ONLY INSTANCE ONLY
- 10. THE TYPE EXPLORERS
- 11. WRITING THE GENCODE SCRIPT
- 12. HINTS FOR TYPEWRITERS
- 13. HOW TO INCLUDE A TYPE INTO UPSTREAM CDIST
- 14. SEE ALSO
- 15. COPYING
__TYPE ID --parameter value [--parameter value …]
__TYPE --parameter value [--parameter value …] (for singletons)
Types are the main component of cdist and define functionality. If you +
cdist-type(7) Table of Contents
- 1. NAME
- 2. SYNOPSIS
- 3. DESCRIPTION
- 4. HOW TO USE A TYPE
- 5. SINGLETON TYPES
- 6. HOW TO WRITE A NEW TYPE
- 7. DEFINING PARAMETERS
- 8. WRITING THE MANIFEST
- 9. SINGLETON - ONLY INSTANCE ONLY
- 10. THE TYPE EXPLORERS
- 11. WRITING THE GENCODE SCRIPT
- 12. HINTS FOR TYPEWRITERS
- 13. HOW TO INCLUDE A TYPE INTO UPSTREAM CDIST
- 14. SEE ALSO
- 15. COPYING
__TYPE ID --parameter value [--parameter value …]
__TYPE --parameter value [--parameter value …] (for singletons)
Types are the main component of cdist and define functionality. If you use cdist, you’ll write a type for every functionality you would like to use.
You can use types from the initial manifest or the type manifest like a normal command:
# Creates empty file /etc/cdist-configured diff --git a/software/cdist/man/man7/cdist-type__addifnosuchline.html b/software/cdist/man/man7/cdist-type__addifnosuchline.html index ca509957..0a8cd66e 100644 --- a/software/cdist/man/man7/cdist-type__addifnosuchline.html +++ b/software/cdist/man/man7/cdist-type__addifnosuchline.html @@ -1,6 +1,6 @@ -cdist-type__addifnosuchline(7) Table of Contents
This type can be used to check a file for existence of a +
cdist-type__addifnosuchline(7) Table of Contents
This type can be used to check a file for existence of a specific line and adding it, if it was not found.
- line
- diff --git a/software/cdist/man/man7/cdist-type__apt_ppa.html b/software/cdist/man/man7/cdist-type__apt_ppa.html index 74636cc2..afd546e8 100644 --- a/software/cdist/man/man7/cdist-type__apt_ppa.html +++ b/software/cdist/man/man7/cdist-type__apt_ppa.html @@ -1,6 +1,6 @@ -
cdist-type__apt_ppa(7) Table of Contents
- +
cdist-type__apt_ppa(7) Table of Contents
- state
- The state the ppa should be in, either "enabled" or "disabled". diff --git a/software/cdist/man/man7/cdist-type__apt_update_index.html b/software/cdist/man/man7/cdist-type__apt_update_index.html index 1a0e3385..ff67251c 100644 --- a/software/cdist/man/man7/cdist-type__apt_update_index.html +++ b/software/cdist/man/man7/cdist-type__apt_update_index.html @@ -1,6 +1,6 @@ -
cdist-type__apt_update_index(7) Table of Contents
- +
cdist-type__apt_update_index(7) diff --git a/software/cdist/man/man7/cdist-type__autofs_map.html b/software/cdist/man/man7/cdist-type__autofs_map.html index fa7146d2..0f1a01c5 100644 --- a/software/cdist/man/man7/cdist-type__autofs_map.html +++ b/software/cdist/man/man7/cdist-type__autofs_map.html @@ -1,6 +1,6 @@ -Table of Contents
cdist-type__autofs_map(7) Table of Contents
- +
cdist-type__autofs_map(7) Table of Contents
- map
- Name of the map to use. See auto.master(5). diff --git a/software/cdist/man/man7/cdist-type__autofs_master.html b/software/cdist/man/man7/cdist-type__autofs_master.html index 07e4b01e..e56058d7 100644 --- a/software/cdist/man/man7/cdist-type__autofs_master.html +++ b/software/cdist/man/man7/cdist-type__autofs_master.html @@ -1,6 +1,6 @@ -
cdist-type__autofs_master(7) Table of Contents
This cdist type generates a auto.master configuration from given autofs_map +
cdist-type__autofs_master(7) Table of Contents
This cdist type generates a auto.master configuration from given autofs_map definitions. See cdist-typeauto_map(7).
- header
- diff --git a/software/cdist/man/man7/cdist-type__debconf_set_selections.html b/software/cdist/man/man7/cdist-type__debconf_set_selections.html index 1d5afe50..1a6c028a 100644 --- a/software/cdist/man/man7/cdist-type__debconf_set_selections.html +++ b/software/cdist/man/man7/cdist-type__debconf_set_selections.html @@ -1,6 +1,6 @@ -
cdist-type__debconf_set_selections(7) On Debian and alike systems debconf-set-selections(1) can be used +
cdist-type__debconf_set_selections(7) On Debian and alike systems debconf-set-selections(1) can be used to setup configuration parameters.
- file
- diff --git a/software/cdist/man/man7/cdist-type__directory.html b/software/cdist/man/man7/cdist-type__directory.html index 23904d8e..fadf9bf8 100644 --- a/software/cdist/man/man7/cdist-type__directory.html +++ b/software/cdist/man/man7/cdist-type__directory.html @@ -1,6 +1,6 @@ -
cdist-type__directory(7) Table of Contents
- +
cdist-type__directory(7) Table of Contents
- group
- Group to chgrp to. diff --git a/software/cdist/man/man7/cdist-type__file.html b/software/cdist/man/man7/cdist-type__file.html index ffdf7827..39d22c84 100644 --- a/software/cdist/man/man7/cdist-type__file.html +++ b/software/cdist/man/man7/cdist-type__file.html @@ -1,6 +1,6 @@ -
cdist-type__file(7) Table of Contents
- +
cdist-type__file(7) Table of Contents
- group
- Group to chgrp to. diff --git a/software/cdist/man/man7/cdist-type__group.html b/software/cdist/man/man7/cdist-type__group.html index a736d558..0852c713 100644 --- a/software/cdist/man/man7/cdist-type__group.html +++ b/software/cdist/man/man7/cdist-type__group.html @@ -1,6 +1,6 @@ -
cdist-type__group(7) Table of Contents
- +
cdist-type__group(7) Table of Contents
- gid
- see groupmod(8) diff --git a/software/cdist/man/man7/cdist-type__issue.html b/software/cdist/man/man7/cdist-type__issue.html index 74866c11..2b144b56 100644 --- a/software/cdist/man/man7/cdist-type__issue.html +++ b/software/cdist/man/man7/cdist-type__issue.html @@ -1,6 +1,6 @@ -
cdist-type__issue(7) Table of Contents
- +
cdist-type__issue(7) Table of Contents
- source
- If supplied, use this file as /etc/issue instead of default. diff --git a/software/cdist/man/man7/cdist-type__key_value.html b/software/cdist/man/man7/cdist-type__key_value.html index e4f333c4..cba173ea 100644 --- a/software/cdist/man/man7/cdist-type__key_value.html +++ b/software/cdist/man/man7/cdist-type__key_value.html @@ -1,6 +1,6 @@ -
cdist-type__key_value(7) Table of Contents
This cdist type allows you to change values in a key value based config +
cdist-type__key_value(7) Table of Contents
- value
- diff --git a/software/cdist/man/man7/cdist-type__link.html b/software/cdist/man/man7/cdist-type__link.html index 1fb8c1dc..c23437c1 100644 --- a/software/cdist/man/man7/cdist-type__link.html +++ b/software/cdist/man/man7/cdist-type__link.html @@ -1,6 +1,6 @@ -
cdist-type__link(7) Table of Contents
This cdist type allows you to hard and symoblic links. The given +
cdist-type__link(7) Table of Contents
This cdist type allows you to hard and symoblic links. The given object id is the destination for the link.
- source
- diff --git a/software/cdist/man/man7/cdist-type__motd.html b/software/cdist/man/man7/cdist-type__motd.html index fd403155..36b763fa 100644 --- a/software/cdist/man/man7/cdist-type__motd.html +++ b/software/cdist/man/man7/cdist-type__motd.html @@ -1,6 +1,6 @@ -
cdist-type__motd(7) Table of Contents
- +
cdist-type__motd(7) Table of Contents
- source
- If supplied, copy this file from the host running cdist to the target. diff --git a/software/cdist/man/man7/cdist-type__package.html b/software/cdist/man/man7/cdist-type__package.html index f4f9f82a..97b8c90a 100644 --- a/software/cdist/man/man7/cdist-type__package.html +++ b/software/cdist/man/man7/cdist-type__package.html @@ -1,6 +1,6 @@ -
cdist-type__user(7) Table of Contents
This cdist type allows you to install or uninstall packages on the target. +
cdist-type__user(7) Table of Contents
This cdist type allows you to install or uninstall packages on the target. It dispatches the actual work to the package system dependant types.
- state
- diff --git a/software/cdist/man/man7/cdist-type__package_apt.html b/software/cdist/man/man7/cdist-type__package_apt.html index e08b2485..3d3eebe7 100644 --- a/software/cdist/man/man7/cdist-type__package_apt.html +++ b/software/cdist/man/man7/cdist-type__package_apt.html @@ -1,6 +1,6 @@ -
cdist-type__package_apt(7) Table of Contents
apt-get is usually used on Debian and variants (like Ubuntu) to +
cdist-type__package_apt(7) Table of Contents
- state
- diff --git a/software/cdist/man/man7/cdist-type__package_pacman.html b/software/cdist/man/man7/cdist-type__package_pacman.html index 6d8deec6..60d3fcc6 100644 --- a/software/cdist/man/man7/cdist-type__package_pacman.html +++ b/software/cdist/man/man7/cdist-type__package_pacman.html @@ -1,6 +1,6 @@ -
cdist-type__package_pacman(7) Table of Contents
Pacman is usually used on the Archlinux distribution to manage +
cdist-type__package_pacman(7) Table of Contents
- state
- diff --git a/software/cdist/man/man7/cdist-type__package_pkg_openbsd.html b/software/cdist/man/man7/cdist-type__package_pkg_openbsd.html index a16256ce..160d7296 100644 --- a/software/cdist/man/man7/cdist-type__package_pkg_openbsd.html +++ b/software/cdist/man/man7/cdist-type__package_pkg_openbsd.html @@ -1,6 +1,6 @@ -
cdist-type__package_pkg(7) Table of Contents
- +
cdist-type__package_pkg(7) Table of Contents
- state
- Either "installed" or "removed". diff --git a/software/cdist/man/man7/cdist-type__package_rubygem.html b/software/cdist/man/man7/cdist-type__package_rubygem.html index 68a05ae7..aebb4844 100644 --- a/software/cdist/man/man7/cdist-type__package_rubygem.html +++ b/software/cdist/man/man7/cdist-type__package_rubygem.html @@ -1,6 +1,6 @@ -
cdist-type__package_rubygem(7) Table of Contents
- +
cdist-type__package_rubygem(7) Table of Contents
- state
- Either "installed" or "removed". diff --git a/software/cdist/man/man7/cdist-type__package_yum.html b/software/cdist/man/man7/cdist-type__package_yum.html index 08a4aae4..3afe0237 100644 --- a/software/cdist/man/man7/cdist-type__package_yum.html +++ b/software/cdist/man/man7/cdist-type__package_yum.html @@ -1,6 +1,6 @@ -
cdist-type__package_yum(7) Table of Contents
Yum is usually used on the Fedora distribution to manage packages. +
cdist-type__package_yum(7) Table of Contents
Yum is usually used on the Fedora distribution to manage packages. If you specify an unknown package, yum will display the slightly confusing error message "Error: Nothing to do".
- state diff --git a/software/cdist/man/man7/cdist-type__partition_msdos.html b/software/cdist/man/man7/cdist-type__partition_msdos.html index ff01f37f..ecbd6f28 100644 --- a/software/cdist/man/man7/cdist-type__partition_msdos.html +++ b/software/cdist/man/man7/cdist-type__partition_msdos.html @@ -1,6 +1,6 @@ -
cdist-type__partition_msdos(7) Table of Contents
- +
cdist-type__partition_msdos(7) Table of Contents
- type
- the partition type used in fdisk (such as 82 or 83) or "extended" diff --git a/software/cdist/man/man7/cdist-type__partition_msdos_apply.html b/software/cdist/man/man7/cdist-type__partition_msdos_apply.html index 5542e617..265d0669 100644 --- a/software/cdist/man/man7/cdist-type__partition_msdos_apply.html +++ b/software/cdist/man/man7/cdist-type__partition_msdos_apply.html @@ -1,6 +1,6 @@ -
cdist-type__partition_msdos_apply(7)