ungleich-public/cdist-web
ungleich-public
/
cdist-web
6
0
Fork 1
Code Issues Pull Requests Projects Releases Wiki Activity

Update cdist beta docs

This commit is contained in:
Darko Poljak 2020-06-17 12:20:44 +02:00
parent 1b6cad787c
commit a559101180
215 changed files with 18452 additions and 9379 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/extra/manual/beta/_sources/cdist-bootstrap.rst.txt
View File

@ -25,7 +25,7 @@ people, have a look at `cdist best practice <cdist-best-practice.html>`_.
Setup working directory and branch
----------------------------------
I assume you have a fresh copy of the cdist tree in ~/cdist, cloned from
one of the official urls (see `cdist quickstart <cdist-quickstart.html>`_ if you don't).
one of the official URLs (see `cdist quickstart <cdist-quickstart.html>`_ if you don't).
Entering the command "git branch" should show you "* master", which indicates
you are on the **master** branch.

2
src/extra/manual/beta/_sources/cdist-cache.rst.txt
View File

@ -59,7 +59,7 @@ typeorder
Object cache overview
~~~~~~~~~~~~~~~~~~~~~
Each object under :strong:`object` directory has its own structurue.
Each object under :strong:`object` directory has its own structure.
code-local
code generated from gencode-local, present only if something is

2
src/extra/manual/beta/_sources/cdist-configuration.rst.txt
View File

@ -21,7 +21,7 @@ precedence. Configuration option value read from source with higher
precedence will overwrite option value, if exists, read from source with
lower precedence. That means that command-line option wins them all.
Users can decide on the local conifguration file location. It can be either
Users can decide on the local configuration file location. It can be either
~/.cdist.cfg or $XDG_CONFIG_HOME/cdist/cdist.cfg. Note that, if both exist,
then ~/.cdist.cfg is used.

6
src/extra/manual/beta/_sources/cdist-install.rst.txt
View File

@ -9,15 +9,15 @@ Source Host
This is the machine from which you will configure target hosts.
* /bin/sh: A posix like shell (for instance bash, dash, zsh)
* Python >= 3.2
* /bin/sh: A POSIX like shell (for instance bash, dash, zsh)
* Python >= 3.5
* SSH client
* sphinx (for building html docs and/or the man pages)
Target Hosts
~~~~~~~~~~~~
* /bin/sh: A posix like shell (for instance bash, dash, zsh)
* /bin/sh: A POSIX like shell (for instance bash, dash, zsh)
* SSH server
Install cdist

4
src/extra/manual/beta/_sources/cdist-real-world.rst.txt
View File

@ -198,7 +198,7 @@ We require package uWSGI present in order to create **/etc/uwsgi/apps-enabled/$u
Installation of uWSGI also creates configuration layout: **/etc/uwsgi/apps-enabled**.
If this directory does not exist then **__file** type would error.
We also use stdin as file content source. For details see `Input from stdin <cdist-type.html#input-from-stdin>`_.
For feading stdin we use here-document (**<<** operator). It allows redirection of subsequent
For feeding stdin we use here-document (**<<** operator). It allows redirection of subsequent
lines read by the shell to the input of a command until a line containing only the delimiter
and a newline, with no blank characters in between (EOF in our case).
@ -546,7 +546,7 @@ we have changed our **wsgi.py** file uWSGI reloads the application.
Our application selects and lists items from **items** table.
Openning application
Opening application
~~~~~~~~~~~~~~~~~~~~
Finally try the application::

35
src/extra/manual/beta/_sources/cdist-reference.rst.txt
View File

@ -341,65 +341,89 @@ __cdist_log_level, __cdist_log_level_name
| TRACE | 5 |
+----------------+-----------------+
Available for: initial manifest, explorer, type manifest, type explorer,
type gencode.
__cdist_colored_log
whether or not cdist's log has colors enabled.
Is set to the string true if cdist's output is using colors,
otherwise the variable contains the string false.
Available for: initial manifest, explorer, type manifest, type explorer,
type gencode.
__cdist_dry_run
Is set only when doing dry run (-n flag).
Available for: initial manifest, explorer, type manifest, type explorer,
type gencode.
__explorer
Directory that contains all global explorers.
Available for: initial manifest, explorer, type explorer, shell.
__files
Directory that contains content from the "files" subdirectories
from the configuration directories.
Available for: initial manifest, type manifest, type gencode, 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.
| 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. This is primary variable. It's content is
literally the one user passed in.
Available for: explorer, initial manifest, type explorer, type manifest, type gencode, shell.
__target_hostname
The hostname of host we are deploying to. This variable is derived from
**__target_host** (using **socket.getaddrinfo(__target_host)** and then
**socket.gethostbyaddr()**).
Available for: explorer, initial manifest, type explorer, type manifest, type gencode, shell.
__target_fqdn
The fully qualified domain name of the host we are deploying to.
This variable is derived from **__target_host**
(using **socket.getfqdn()**).
Available for: explorer, initial manifest, type explorer, type manifest, type gencode, shell.
__target_host_tags
Comma separated list of target host tags.
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)
@ -463,5 +487,10 @@ CDIST_INVENTORY_DIR
CDIST_BETA
Enable beta functionalities.
CDIST_COLORED_OUTPUT
Colorize cdist's output. If enabled, cdist will use different colors for
different log levels.
Recognized values are 'always', 'never', and 'auto' (the default).
CDIST_CACHE_PATH_PATTERN
Custom cache path pattern.

6
src/extra/manual/beta/_sources/cdist-upgrade.rst.txt
View File

@ -14,7 +14,7 @@ To upgrade cdist in the current branch use
make man
export MANPATH=$MANPATH:$(pwd -P)/doc/man
If you stay on a version branche (i.e. 1.0, 1.1., ...), nothing should break.
If you stay on a version branch (i.e. 1.0, 1.1., ...), nothing should break.
The master branch on the other hand is the development branch and may not be
working, break your setup or eat the tree in your garden.
@ -61,7 +61,7 @@ After that, you can go back and continue the upgrade:
Update the python package
-------------------------
To upgrade to the lastet version do
To upgrade to the latest version do
.. code-block:: sh
@ -158,7 +158,7 @@ Updating from 1.5 to 1.6
* If you used **\_\_package_apt --preseed**, you need to use the new
type **\_\_debconf_set_selections** instead.
* The **\_\_package** types accepted either --state deinstalled or
--state uninstaaled. Starting with 1.6, it was made consistently
--state uninstalled. Starting with 1.6, it was made consistently
to --state removed.
Updating from 1.3 to 1.5

4
src/extra/manual/beta/_sources/cdist-why.rst.txt
View File

@ -21,7 +21,7 @@ Not only is shell scripting widely known by system engineers,
but it is also a very powerful language. Here are some features
which make daily work easy:
* Configuration can react dynamicly on explored values
* Configuration can react dynamically on explored values
* High level string manipulation (using sed, awk, grep)
* Conditional support (**if, case**)
* Loop support (**for, while**)
@ -44,7 +44,7 @@ Cdist requires very little on a target system. Even better,
in almost all cases all dependencies are usually fulfilled.
Cdist does not require an agent or high level programming
languages on the target host: it will run on any host that
has a **ssh server running** and a posix compatible shell
has a **ssh server running** and a POSIX compatible shell
(**/bin/sh**). Compared to other configuration management systems,
it does not require to open up an additional port.

80
src/extra/manual/beta/_sources/man1/cdist.rst.txt
View File

@ -15,52 +15,51 @@ SYNOPSIS
cdist banner [-h] [-l LOGLEVEL] [-q] [-v]
cdist config [-h] [-l LOGLEVEL] [-q] [-v] [-b] [-g CONFIG_FILE] [-4]
[-6] [-C CACHE_PATH_PATTERN] [-c CONF_DIR] [-i MANIFEST]
[-j [JOBS]] [-n] [-o OUT_PATH] [-P]
[-R [{tar,tgz,tbz2,txz}]] [-r REMOTE_OUT_PATH]
[--remote-copy REMOTE_COPY] [--remote-exec REMOTE_EXEC]
[-S] [-I INVENTORY_DIR] [-A] [-a] [-f HOSTFILE]
[-p [HOST_MAX]] [-s] [-t]
cdist config [-h] [-l LOGLEVEL] [-q] [-v] [-b] [--colors WHEN]
[-g CONFIG_FILE] [-4] [-6] [-C CACHE_PATH_PATTERN]
[-c CONF_DIR] [-i MANIFEST] [-j [JOBS]] [--log-server]
[-n] [-o OUT_PATH] [-P] [-R [{tar,tgz,tbz2,txz}]]
[-r REMOTE_OUT_PATH] [--remote-copy REMOTE_COPY]
[--remote-exec REMOTE_EXEC] [-S] [-I INVENTORY_DIR] [-A]
[-a] [-f HOSTFILE] [-p [HOST_MAX]] [-s] [-t]
[host [host ...]]
cdist install [-h] [-l LOGLEVEL] [-q] [-v] [-b] [-g CONFIG_FILE] [-4]
[-6] [-C CACHE_PATH_PATTERN] [-c CONF_DIR] [-i MANIFEST]
[-j [JOBS]] [-n] [-o OUT_PATH] [-P]
[-R [{tar,tgz,tbz2,txz}]] [-r REMOTE_OUT_PATH]
[--remote-copy REMOTE_COPY] [--remote-exec REMOTE_EXEC]
[-S] [-I INVENTORY_DIR] [-A] [-a] [-f HOSTFILE]
[-p [HOST_MAX]] [-s] [-t]
cdist install [-h] [-l LOGLEVEL] [-q] [-v] [-b] [--colors WHEN]
[-g CONFIG_FILE] [-4] [-6] [-C CACHE_PATH_PATTERN]
[-c CONF_DIR] [-i MANIFEST] [-j [JOBS]] [--log-server]
[-n] [-o OUT_PATH] [-P] [-R [{tar,tgz,tbz2,txz}]]
[-r REMOTE_OUT_PATH] [--remote-copy REMOTE_COPY]
[--remote-exec REMOTE_EXEC] [-S] [-I INVENTORY_DIR] [-A]
[-a] [-f HOSTFILE] [-p [HOST_MAX]] [-s] [-t]
[host [host ...]]
cdist inventory [-h] {add-host,add-tag,del-host,del-tag,list} ...
cdist inventory add-host [-h] [-l LOGLEVEL] [-q] [-v] [-b]
[-g CONFIG_FILE] [-I INVENTORY_DIR]
[-f HOSTFILE]
cdist inventory add-host [-h] [-l LOGLEVEL] [-q] [-v] [-b] [--colors WHEN]
[-g CONFIG_FILE] [-I INVENTORY_DIR] [-f HOSTFILE]
[host [host ...]]
cdist inventory add-tag [-h] [-l LOGLEVEL] [-q] [-v] [-b]
[-g CONFIG_FILE] [-I INVENTORY_DIR]
[-f HOSTFILE] [-T TAGFILE] [-t TAGLIST]
cdist inventory add-tag [-h] [-l LOGLEVEL] [-q] [-v] [-b] [--colors WHEN]
[-g CONFIG_FILE] [-I INVENTORY_DIR] [-f HOSTFILE]
[-T TAGFILE] [-t TAGLIST]
[host [host ...]]
cdist inventory del-host [-h] [-l LOGLEVEL] [-q] [-v] [-b]
cdist inventory del-host [-h] [-l LOGLEVEL] [-q] [-v] [-b] [--colors WHEN]
[-g CONFIG_FILE] [-I INVENTORY_DIR] [-a]
[-f HOSTFILE]
[host [host ...]]
cdist inventory del-tag [-h] [-l LOGLEVEL] [-q] [-v] [-b]
cdist inventory del-tag [-h] [-l LOGLEVEL] [-q] [-v] [-b] [--colors WHEN]
[-g CONFIG_FILE] [-I INVENTORY_DIR] [-a]
[-f HOSTFILE] [-T TAGFILE] [-t TAGLIST]
[host [host ...]]
cdist inventory list [-h] [-l LOGLEVEL] [-q] [-v] [-b] [-g CONFIG_FILE]
[-I INVENTORY_DIR] [-a] [-f HOSTFILE] [-H] [-t]
cdist inventory list [-h] [-l LOGLEVEL] [-q] [-v] [-b] [--colors WHEN]
[-g CONFIG_FILE] [-I INVENTORY_DIR] [-a] [-f HOSTFILE]
[-H] [-t]
[host [host ...]]
cdist preos [-h] [-l LOGLEVEL] [-q] [-v] [-c CONF_DIR] [-g CONFIG_FILE]
[-L]
cdist preos [-h] [-l LOGLEVEL] [-q] [-v] [-c CONF_DIR] [-g CONFIG_FILE] [-L]
[preos] ...
cdist preos [preos-options] debian [-h] [-l LOGLEVEL] [-q] [-v] [-b] [-a ARCH] [-B]
@ -87,9 +86,10 @@ SYNOPSIS
[-y REMOTE_COPY]
target_dir
cdist shell [-h] [-l LOGLEVEL] [-q] [-v] [-s SHELL]
cdist shell [-h] [-l LOGLEVEL] [-q] [-v] [--colors WHEN] [-s SHELL]
cdist info [-h] [-a] [-c CONF_DIR] [-e] [-F] [-f] [-g CONFIG_FILE] [-t] [pattern]
cdist info [-h] [-a] [-c CONF_DIR] [-e] [-F] [-f] [-g CONFIG_FILE] [-t]
[pattern]
cdist trigger [-h] [-l LOGLEVEL] [-q] [-v] [-b] [-g CONFIG_FILE] [-4]
[-6] [-C CACHE_PATH_PATTERN] [-c CONF_DIR] [-i MANIFEST]
@ -105,7 +105,7 @@ cdist is the frontend executable to the cdist configuration management.
It supports different subcommands as explained below.
It is written in Python so it requires :strong:`python`\ (1) to be installed.
It requires a minimal Python version 3.2.
It requires a minimal Python version 3.5.
GENERAL
-------
@ -114,6 +114,14 @@ All commands accept the following options:
**-h, --help**
Show the help screen.
**--colors WHEN**
Colorize cdist's output. If enabled, cdist will use different colors for
different log levels.
WHEN recognizes the values 'always', 'never', and 'auto' (the default).
If the value is 'auto', colored output is enabled if stdout is a TTY
unless the NO_COLOR (https://no-color.org/) environment variable is defined.
**-l LOGLEVEL, --log-level LOGLEVEL**
Set the specified verbosity level. The levels, in
order from the lowest to the highest, are: ERROR (-1),
@ -204,6 +212,12 @@ Install command is currently in beta.
are supported. Without argument CPU count is used by
default.
**--log-server**
Start a log server for sub processes to use. This is
mainly useful when running cdist nested from a code-
local script. Log server is always implicitly started
for 'install' command.
**-n, --dry-run**
Do not execute code.
@ -780,6 +794,9 @@ The possible keywords and their meanings are as follows:
:strong:`cache_path_pattern`
Specify cache path pattern.
:strong:`colored_output`
Colorize cdist's output. cf. the :code:`--colors` option.
:strong:`conf_dir`
List of configuration directories separated with the character conventionally
used by the operating system to separate search path components (as in PATH),
@ -1008,6 +1025,9 @@ CDIST_BETA
CDIST_CACHE_PATH_PATTERN
Custom cache path pattern.
CDIST_COLORED_OUTPUT
Colorize cdist's output. cf. the :code:`--colors` option.
CDIST_CONFIG_FILE
Custom configuration file.
@ -1070,5 +1090,5 @@ such case and display a warning message. An example of such a case:
COPYING
-------
Copyright \(C) 2011-2019 Nico Schottelius. Free use of this software is
Copyright \(C) 2011-2020 Nico Schottelius. Free use of this software is
granted under the terms of the GNU General Public License v3 or later (GPLv3+).

10
src/extra/manual/beta/_sources/man7/cdist-type__clean_path.rst.txt
View File

@ -10,7 +10,7 @@ DESCRIPTION
-----------
Remove files and directories which match the pattern.
Provided path (as __object_id) must be a directory.
Provided path must be a directory.
Patterns are passed to ``find``'s ``-regex`` - see ``find(1)`` for more details.
@ -29,6 +29,9 @@ pattern
OPTIONAL PARAMETERS
-------------------
path
Path which will be cleaned. Defaults to ``$__object_id``.
exclude
Pattern of files which are excluded from removal.
@ -46,6 +49,11 @@ EXAMPLES
--exclude '.+\(charset\.conf\|security\.conf\)' \
--onchange 'service apache2 restart'
__clean_path apache2-conf-enabled \
--path /etc/apache2/conf-enabled \
--pattern '.+' \
--exclude '.+\(charset\.conf\|security\.conf\)' \
--onchange 'service apache2 restart'
AUTHORS
-------

9
src/extra/manual/beta/_sources/man7/cdist-type__ssh_authorized_keys.rst.txt
View File

@ -60,6 +60,9 @@ nofile
Don't manage existence, ownership and permissions of the the authorized_keys
file.
remove-unknown
Remove undefined keys.
EXAMPLES
--------
@ -70,6 +73,12 @@ EXAMPLES
__ssh_authorized_keys root \
--key "$(cat ~/.ssh/id_rsa.pub)"
# same as above, but make sure your key is only key in
# root's authorized_keys file
__ssh_authorized_keys root \
--key "$(cat ~/.ssh/id_rsa.pub)" \
--remove-unknown
# allow key to login as user-name
__ssh_authorized_keys user-name \
--key "ssh-rsa AXYZAAB3NzaC1yc2..."

133
src/extra/manual/beta/_static/basic.css
View File

@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- basic theme.
*
* :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@ -81,10 +81,26 @@ div.sphinxsidebar input {
font-size: 1em;
}
div.sphinxsidebar #searchbox input[type="text"] {
width: 170px;
div.sphinxsidebar #searchbox form.search {
overflow: hidden;
}
div.sphinxsidebar #searchbox input[type="text"] {
float: left;
width: 80%;
padding: 0.25em;
box-sizing: border-box;
}
div.sphinxsidebar #searchbox input[type="submit"] {
float: left;
width: 20%;
border-left: none;
padding: 0.25em;
box-sizing: border-box;
}
img {
border: 0;
max-width: 100%;
@ -199,6 +215,11 @@ table.modindextable td {
/* -- general body styles --------------------------------------------------- */
div.body {
min-width: 450px;
max-width: 800px;
}
div.body p, div.body dd, div.body li, div.body blockquote {
-moz-hyphens: auto;
-ms-hyphens: auto;
@ -210,6 +231,16 @@ a.headerlink {
visibility: hidden;
}
a.brackets:before,
span.brackets > a:before{
content: "[";
}
a.brackets:after,
span.brackets > a:after {
content: "]";
}
h1:hover > a.headerlink,
h2:hover > a.headerlink,
h3:hover > a.headerlink,
@ -258,6 +289,12 @@ img.align-center, .figure.align-center, object.align-center {
margin-right: auto;
}
img.align-default, .figure.align-default {
display: block;
margin-left: auto;
margin-right: auto;
}
.align-left {
text-align: left;
}
@ -266,6 +303,10 @@ img.align-center, .figure.align-center, object.align-center {
text-align: center;
}
.align-default {
text-align: center;
}
.align-right {
text-align: right;
}
@ -332,6 +373,16 @@ table.docutils {
border-collapse: collapse;
}
table.align-center {
margin-left: auto;
margin-right: auto;
}
table.align-default {
margin-left: auto;
margin-right: auto;
}
table caption span.caption-number {
font-style: italic;
}
@ -365,6 +416,16 @@ table.citation td {
border-bottom: none;
}
th > p:first-child,
td > p:first-child {
margin-top: 0px;
}
th > p:last-child,
td > p:last-child {
margin-bottom: 0px;
}
/* -- figures --------------------------------------------------------------- */
div.figure {
@ -405,6 +466,13 @@ table.field-list td, table.field-list th {
hyphens: manual;
}
/* -- hlist styles ---------------------------------------------------------- */
table.hlist td {
vertical-align: top;
}
/* -- other body styles ----------------------------------------------------- */
ol.arabic {
@ -427,11 +495,58 @@ ol.upperroman {
list-style: upper-roman;
}
li > p:first-child {
margin-top: 0px;
}
li > p:last-child {
margin-bottom: 0px;
}
dl.footnote > dt,
dl.citation > dt {
float: left;
}
dl.footnote > dd,
dl.citation > dd {
margin-bottom: 0em;
}
dl.footnote > dd:after,
dl.citation > dd:after {
content: "";
clear: both;
}
dl.field-list {
display: grid;
grid-template-columns: fit-content(30%) auto;
}
dl.field-list > dt {
font-weight: bold;
word-break: break-word;
padding-left: 0.5em;
padding-right: 5px;
}
dl.field-list > dt:after {
content: ":";
}
dl.field-list > dd {
padding-left: 0.5em;
margin-top: 0em;
margin-left: 0em;
margin-bottom: 0em;
}
dl {
margin-bottom: 15px;
}
dd p {
dd > p:first-child {
margin-top: 0px;
}
@ -504,6 +619,12 @@ dl.glossary dt {
font-style: oblique;
}
.classifier:before {
font-style: normal;
margin: 0.5em;
content: ":";
}
abbr, acronym {
border-bottom: dotted 1px;
cursor: help;
@ -551,6 +672,10 @@ div.code-block-caption + div > div.highlight > pre {
margin-top: 0;
}
div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */
user-select: none;
}
div.code-block-caption span.caption-number {
padding: 0.1em 0.3em;
font-style: italic;

22
src/extra/manual/beta/_static/doctools.js
View File

@ -4,7 +4,7 @@
*
* Sphinx JavaScript utilities for all documentation.
*
* :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@ -70,7 +70,9 @@ jQuery.fn.highlightText = function(text, className) {
if (node.nodeType === 3) {
var val = node.nodeValue;
var pos = val.toLowerCase().indexOf(text);
if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) {
if (pos >= 0 &&
!jQuery(node.parentNode).hasClass(className) &&
!jQuery(node.parentNode).hasClass("nohighlight")) {
var span;
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
if (isInSVG) {
@ -85,14 +87,13 @@ jQuery.fn.highlightText = function(text, className) {
node.nextSibling));
node.nodeValue = val.substr(0, pos);
if (isInSVG) {
var bbox = span.getBBox();
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
rect.x.baseVal.value = bbox.x;
var bbox = node.parentElement.getBBox();
rect.x.baseVal.value = bbox.x;
rect.y.baseVal.value = bbox.y;
rect.width.baseVal.value = bbox.width;
rect.height.baseVal.value = bbox.height;
rect.setAttribute('class', className);
var parentOfText = node.parentNode.parentNode;
addItems.push({
"parent": node.parentNode,
"target": rect});
@ -148,7 +149,9 @@ var Documentation = {
this.fixFirefoxAnchorBug();
this.highlightSearchWords();
this.initIndexTable();
if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) {
this.initOnKeyListeners();
}
},
/**
@ -204,7 +207,7 @@ var Documentation = {
* see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075
*/
fixFirefoxAnchorBug : function() {
if (document.location.hash)
if (document.location.hash && $.browser.mozilla)
window.setTimeout(function() {
document.location.href += '';
}, 10);
@ -280,10 +283,11 @@ var Documentation = {
},
initOnKeyListeners: function() {
$(document).keyup(function(event) {
$(document).keydown(function(event) {
var activeElementType = document.activeElement.tagName;
// don't navigate when in search box or textarea
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') {
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT'
&& !event.altKey && !event.ctrlKey && !event.metaKey && !event.shiftKey) {
switch (event.keyCode) {
case 37: // left
var prevHref = $('link[rel="prev"]').prop('href');

292
src/extra/manual/beta/_static/documentation_options.js
View File

@ -1,296 +1,12 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '5.0.1',
VERSION: '6.6.0',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
BUILDER: 'html',
FILE_SUFFIX: '.html',
LINK_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt',
NAVIGATION_WITH_KEYS: false,
SEARCH_LANGUAGE_STOP_WORDS: ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"]
NAVIGATION_WITH_KEYS: false
};
/* Non-minified version JS is _stemmer.js if file is provided */
/**
* Porter Stemmer
*/
var Stemmer = function() {
var step2list = {
ational: 'ate',
tional: 'tion',
enci: 'ence',
anci: 'ance',
izer: 'ize',
bli: 'ble',
alli: 'al',
entli: 'ent',
eli: 'e',
ousli: 'ous',
ization: 'ize',
ation: 'ate',
ator: 'ate',
alism: 'al',
iveness: 'ive',
fulness: 'ful',
ousness: 'ous',
aliti: 'al',
iviti: 'ive',
biliti: 'ble',
logi: 'log'
};
var step3list = {
icate: 'ic',
ative: '',
alize: 'al',
iciti: 'ic',
ical: 'ic',
ful: '',
ness: ''
};
var c = "[^aeiou]"; // consonant
var v = "[aeiouy]"; // vowel
var C = c + "[^aeiouy]*"; // consonant sequence
var V = v + "[aeiou]*"; // vowel sequence
var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
var s_v = "^(" + C + ")?" + v; // vowel in stem
this.stemWord = function (w) {
var stem;
var suffix;
var firstch;
var origword = w;
if (w.length < 3)
return w;
var re;
var re2;
var re3;
var re4;
firstch = w.substr(0,1);
if (firstch == "y")
w = firstch.toUpperCase() + w.substr(1);
// Step 1a
re = /^(.+?)(ss|i)es$/;
re2 = /^(.+?)([^s])s$/;
if (re.test(w))
w = w.replace(re,"$1$2");
else if (re2.test(w))
w = w.replace(re2,"$1$2");
// Step 1b
re = /^(.+?)eed$/;
re2 = /^(.+?)(ed|ing)$/;
if (re.test(w)) {
var fp = re.exec(w);
re = new RegExp(mgr0);
if (re.test(fp[1])) {
re = /.$/;
w = w.replace(re,"");
}
}
else if (re2.test(w)) {
var fp = re2.exec(w);
stem = fp[1];
re2 = new RegExp(s_v);
if (re2.test(stem)) {
w = stem;
re2 = /(at|bl|iz)$/;
re3 = new RegExp("([^aeiouylsz])\\1$");
re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
if (re2.test(w))
w = w + "e";
else if (re3.test(w)) {
re = /.$/;
w = w.replace(re,"");
}
else if (re4.test(w))
w = w + "e";
}
}
// Step 1c
re = /^(.+?)y$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(s_v);
if (re.test(stem))
w = stem + "i";
}
// Step 2
re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
suffix = fp[2];
re = new RegExp(mgr0);
if (re.test(stem))
w = stem + step2list[suffix];
}
// Step 3
re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
suffix = fp[2];
re = new RegExp(mgr0);
if (re.test(stem))
w = stem + step3list[suffix];
}
// Step 4
re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
re2 = /^(.+?)(s|t)(ion)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(mgr1);
if (re.test(stem))
w = stem;
}
else if (re2.test(w)) {
var fp = re2.exec(w);
stem = fp[1] + fp[2];
re2 = new RegExp(mgr1);
if (re2.test(stem))
w = stem;
}
// Step 5
re = /^(.+?)e$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(mgr1);
re2 = new RegExp(meq1);
re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
w = stem;
}
re = /ll$/;
re2 = new RegExp(mgr1);
if (re.test(w) && re2.test(w)) {
re = /.$/;
w = w.replace(re,"");
}
// and turn initial Y back to y
if (firstch == "y")
w = firstch.toLowerCase() + w.substr(1);
return w;
}
}
var splitChars = (function() {
var result = {};
var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648,
1748, 1809, 2416, 2473, 2481, 2526, 2601, 2609, 2612, 2615, 2653, 2702,
2706, 2729, 2737, 2740, 2857, 2865, 2868, 2910, 2928, 2948, 2961, 2971,
2973, 3085, 3089, 3113, 3124, 3213, 3217, 3241, 3252, 3295, 3341, 3345,
3369, 3506, 3516, 3633, 3715, 3721, 3736, 3744, 3748, 3750, 3756, 3761,
3781, 3912, 4239, 4347, 4681, 4695, 4697, 4745, 4785, 4799, 4801, 4823,
4881, 5760, 5901, 5997, 6313, 7405, 8024, 8026, 8028, 8030, 8117, 8125,
8133, 8181, 8468, 8485, 8487, 8489, 8494, 8527, 11311, 11359, 11687, 11695,
11703, 11711, 11719, 11727, 11735, 12448, 12539, 43010, 43014, 43019, 43587,
43696, 43713, 64286, 64297, 64311, 64317, 64319, 64322, 64325, 65141];
var i, j, start, end;
for (i = 0; i < singles.length; i++) {
result[singles[i]] = true;
}
var ranges = [[0, 47], [58, 64], [91, 94], [123, 169], [171, 177], [182, 184], [706, 709],
[722, 735], [741, 747], [751, 879], [888, 889], [894, 901], [1154, 1161],
[1318, 1328], [1367, 1368], [1370, 1376], [1416, 1487], [1515, 1519], [1523, 1568],
[1611, 1631], [1642, 1645], [1750, 1764], [1767, 1773], [1789, 1790], [1792, 1807],
[1840, 1868], [1958, 1968], [1970, 1983], [2027, 2035], [2038, 2041], [2043, 2047],
[2070, 2073], [2075, 2083], [2085, 2087], [2089, 2307], [2362, 2364], [2366, 2383],
[2385, 2391], [2402, 2405], [2419, 2424], [2432, 2436], [2445, 2446], [2449, 2450],
[2483, 2485], [2490, 2492], [2494, 2509], [2511, 2523], [2530, 2533], [2546, 2547],
[2554, 2564], [2571, 2574], [2577, 2578], [2618, 2648], [2655, 2661], [2672, 2673],
[2677, 2692], [2746, 2748], [2750, 2767], [2769, 2783], [2786, 2789], [2800, 2820],
[2829, 2830], [2833, 2834], [2874, 2876], [2878, 2907], [2914, 2917], [2930, 2946],
[2955, 2957], [2966, 2968], [2976, 2978], [2981, 2983], [2987, 2989], [3002, 3023],
[3025, 3045], [3059, 3076], [3130, 3132], [3134, 3159], [3162, 3167], [3170, 3173],
[3184, 3191], [3199, 3204], [3258, 3260], [3262, 3293], [3298, 3301], [3312, 3332],
[3386, 3388], [3390, 3423], [3426, 3429], [3446, 3449], [3456, 3460], [3479, 3481],
[3518, 3519], [3527, 3584], [3636, 3647], [3655, 3663], [3674, 3712], [3717, 3718],
[3723, 3724], [3726, 3731], [3752, 3753], [3764, 3772], [3774, 3775], [3783, 3791],
[3802, 3803], [3806, 3839], [3841, 3871], [3892, 3903], [3949, 3975], [3980, 4095],
[4139, 4158], [4170, 4175], [4182, 4185], [4190, 4192], [4194, 4196], [4199, 4205],
[4209, 4212], [4226, 4237], [4250, 4255], [4294, 4303], [4349, 4351], [4686, 4687],
[4702, 4703], [4750, 4751], [4790, 4791], [4806, 4807], [4886, 4887], [4955, 4968],
[4989, 4991], [5008, 5023], [5109, 5120], [5741, 5742], [5787, 5791], [5867, 5869],
[5873, 5887], [5906, 5919], [5938, 5951], [5970, 5983], [6001, 6015], [6068, 6102],
[6104, 6107], [6109, 6111], [6122, 6127], [6138, 6159], [6170, 6175], [6264, 6271],
[6315, 6319], [6390, 6399], [6429, 6469], [6510, 6511], [6517, 6527], [6572, 6592],
[6600, 6607], [6619, 6655], [6679, 6687], [6741, 6783], [6794, 6799], [6810, 6822],
[6824, 6916], [6964, 6980], [6988, 6991], [7002, 7042], [7073, 7085], [7098, 7167],
[7204, 7231], [7242, 7244], [7294, 7400], [7410, 7423], [7616, 7679], [7958, 7959],
[7966, 7967], [8006, 8007], [8014, 8015], [8062, 8063], [8127, 8129], [8141, 8143],
[8148, 8149], [8156, 8159], [8173, 8177], [8189, 8303], [8306, 8307], [8314, 8318],
[8330, 8335], [8341, 8449], [8451, 8454], [8456, 8457], [8470, 8472], [8478, 8483],
[8506, 8507], [8512, 8516], [8522, 8525], [8586, 9311], [9372, 9449], [9472, 10101],
[10132, 11263], [11493, 11498], [11503, 11516], [11518, 11519], [11558, 11567],
[11622, 11630], [11632, 11647], [11671, 11679], [11743, 11822], [11824, 12292],
[12296, 12320], [12330, 12336], [12342, 12343], [12349, 12352], [12439, 12444],
[12544, 12548], [12590, 12592], [12687, 12689], [12694, 12703], [12728, 12783],
[12800, 12831], [12842, 12880], [12896, 12927], [12938, 12976], [12992, 13311],
[19894, 19967], [40908, 40959], [42125, 42191], [42238, 42239], [42509, 42511],
[42540, 42559], [42592, 42593], [42607, 42622], [42648, 42655], [42736, 42774],
[42784, 42785], [42889, 42890], [42893, 43002], [43043, 43055], [43062, 43071],
[43124, 43137], [43188, 43215], [43226, 43249], [43256, 43258], [43260, 43263],
[43302, 43311], [43335, 43359], [43389, 43395], [43443, 43470], [43482, 43519],
[43561, 43583], [43596, 43599], [43610, 43615], [43639, 43641], [43643, 43647],
[43698, 43700], [43703, 43704], [43710, 43711], [43715, 43738], [43742, 43967],
[44003, 44015], [44026, 44031], [55204, 55215], [55239, 55242], [55292, 55295],
[57344, 63743], [64046, 64047], [64110, 64111], [64218, 64255], [64263, 64274],
[64280, 64284], [64434, 64466], [64830, 64847], [64912, 64913], [64968, 65007],
[65020, 65135], [65277, 65295], [65306, 65312], [65339, 65344], [65371, 65381],
[65471, 65473], [65480, 65481], [65488, 65489], [65496, 65497]];
for (i = 0; i < ranges.length; i++) {
start = ranges[i][0];
end = ranges[i][1];
for (j = start; j <= end; j++) {
result[j] = true;
}
}
return result;
})();
function splitQuery(query) {
var result = [];
var start = -1;
for (var i = 0; i < query.length; i++) {
if (splitChars[query.charCodeAt(i)]) {
if (start !== -1) {
result.push(query.slice(start, i));
start = -1;
}
} else if (start === -1) {
start = i;
}
}
if (start !== -1) {
result.push(query.slice(start));
}
return result;
}

10872
src/extra/manual/beta/_static/jquery-3.5.1.js vendored Normal file
View File

File diff suppressed because it is too large Load Diff

6
src/extra/manual/beta/_static/jquery.js vendored
View File

File diff suppressed because one or more lines are too long

297
src/extra/manual/beta/_static/language_data.js Normal file
View File

@ -0,0 +1,297 @@
/*
* language_data.js
* ~~~~~~~~~~~~~~~~
*
* This script contains the language-specific data used by searchtools.js,
* namely the list of stopwords, stemmer, scorer and splitter.
*
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
var stopwords = ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"];
/* Non-minified version JS is _stemmer.js if file is provided */
/**
* Porter Stemmer
*/
var Stemmer = function() {
var step2list = {
ational: 'ate',
tional: 'tion',
enci: 'ence',
anci: 'ance',
izer: 'ize',
bli: 'ble',
alli: 'al',
entli: 'ent',
eli: 'e',
ousli: 'ous',
ization: 'ize',
ation: 'ate',
ator: 'ate',
alism: 'al',
iveness: 'ive',
fulness: 'ful',
ousness: 'ous',
aliti: 'al',
iviti: 'ive',
biliti: 'ble',
logi: 'log'
};
var step3list = {
icate: 'ic',
ative: '',
alize: 'al',
iciti: 'ic',
ical: 'ic',
ful: '',
ness: ''
};
var c = "[^aeiou]"; // consonant
var v = "[aeiouy]"; // vowel
var C = c + "[^aeiouy]*"; // consonant sequence
var V = v + "[aeiou]*"; // vowel sequence
var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
var s_v = "^(" + C + ")?" + v; // vowel in stem
this.stemWord = function (w) {
var stem;
var suffix;
var firstch;
var origword = w;
if (w.length < 3)
return w;
var re;
var re2;
var re3;
var re4;
firstch = w.substr(0,1);
if (firstch == "y")
w = firstch.toUpperCase() + w.substr(1);
// Step 1a
re = /^(.+?)(ss|i)es$/;
re2 = /^(.+?)([^s])s$/;
if (re.test(w))
w = w.replace(re,"$1$2");
else if (re2.test(w))
w = w.replace(re2,"$1$2");
// Step 1b
re = /^(.+?)eed$/;
re2 = /^(.+?)(ed|ing)$/;
if (re.test(w)) {
var fp = re.exec(w);
re = new RegExp(mgr0);
if (re.test(fp[1])) {
re = /.$/;
w = w.replace(re,"");
}
}
else if (re2.test(w)) {
var fp = re2.exec(w);
stem = fp[1];
re2 = new RegExp(s_v);
if (re2.test(stem)) {
w = stem;
re2 = /(at|bl|iz)$/;
re3 = new RegExp("([^aeiouylsz])\\1$");
re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
if (re2.test(w))
w = w + "e";
else if (re3.test(w)) {
re = /.$/;
w = w.replace(re,"");
}
else if (re4.test(w))
w = w + "e";
}
}
// Step 1c
re = /^(.+?)y$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(s_v);
if (re.test(stem))
w = stem + "i";
}
// Step 2
re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
suffix = fp[2];
re = new RegExp(mgr0);
if (re.test(stem))
w = stem + step2list[suffix];
}
// Step 3
re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
suffix = fp[2];
re = new RegExp(mgr0);
if (re.test(stem))
w = stem + step3list[suffix];
}
// Step 4
re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
re2 = /^(.+?)(s|t)(ion)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(mgr1);
if (re.test(stem))
w = stem;
}
else if (re2.test(w)) {
var fp = re2.exec(w);
stem = fp[1] + fp[2];
re2 = new RegExp(mgr1);
if (re2.test(stem))
w = stem;
}
// Step 5
re = /^(.+?)e$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(mgr1);
re2 = new RegExp(meq1);
re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
w = stem;
}
re = /ll$/;
re2 = new RegExp(mgr1);
if (re.test(w) && re2.test(w)) {
re = /.$/;
w = w.replace(re,"");
}
// and turn initial Y back to y
if (firstch == "y")
w = firstch.toLowerCase() + w.substr(1);
return w;
}
}
var splitChars = (function() {
var result = {};
var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648,
1748, 1809, 2416, 2473, 2481, 2526, 2601, 2609, 2612, 2615, 2653, 2702,
2706, 2729, 2737, 2740, 2857, 2865, 2868, 2910, 2928, 2948, 2961, 2971,
2973, 3085, 3089, 3113, 3124, 3213, 3217, 3241, 3252, 3295, 3341, 3345,
3369, 3506, 3516, 3633, 3715, 3721, 3736, 3744, 3748, 3750, 3756, 3761,
3781, 3912, 4239, 4347, 4681, 4695, 4697, 4745, 4785, 4799, 4801, 4823,
4881, 5760, 5901, 5997, 6313, 7405, 8024, 8026, 8028, 8030, 8117, 8125,
8133, 8181, 8468, 8485, 8487, 8489, 8494, 8527, 11311, 11359, 11687, 11695,
11703, 11711, 11719, 11727, 11735, 12448, 12539, 43010, 43014, 43019, 43587,
43696, 43713, 64286, 64297, 64311, 64317, 64319, 64322, 64325, 65141];
var i, j, start, end;
for (i = 0; i < singles.length; i++) {
result[singles[i]] = true;
}
var ranges = [[0, 47], [58, 64], [91, 94], [123, 169], [171, 177], [182, 184], [706, 709],
[722, 735], [741, 747], [751, 879], [888, 889], [894, 901], [1154, 1161],
[1318, 1328], [1367, 1368], [1370, 1376], [1416, 1487], [1515, 1519], [1523, 1568],
[1611, 1631], [1642, 1645], [1750, 1764], [1767, 1773], [1789, 1790], [1792, 1807],
[1840, 1868], [1958, 1968], [1970, 1983], [2027, 2035], [2038, 2041], [2043, 2047],
[2070, 2073], [2075, 2083], [2085, 2087], [2089, 2307], [2362, 2364], [2366, 2383],
[2385, 2391], [2402, 2405], [2419, 2424], [2432, 2436], [2445, 2446], [2449, 2450],
[2483, 2485], [2490, 2492], [2494, 2509], [2511, 2523], [2530, 2533], [2546, 2547],
[2554, 2564], [2571, 2574], [2577, 2578], [2618, 2648], [2655, 2661], [2672, 2673],
[2677, 2692], [2746, 2748], [2750, 2767], [2769, 2783], [2786, 2789], [2800, 2820],
[2829, 2830], [2833, 2834], [2874, 2876], [2878, 2907], [2914, 2917], [2930, 2946],
[2955, 2957], [2966, 2968], [2976, 2978], [2981, 2983], [2987, 2989], [3002, 3023],
[3025, 3045], [3059, 3076], [3130, 3132], [3134, 3159], [3162, 3167], [3170, 3173],
[3184, 3191], [3199, 3204], [3258, 3260], [3262, 3293], [3298, 3301], [3312, 3332],
[3386, 3388], [3390, 3423], [3426, 3429], [3446, 3449], [3456, 3460], [3479, 3481],
[3518, 3519], [3527, 3584], [3636, 3647], [3655, 3663], [3674, 3712], [3717, 3718],
[3723, 3724], [3726, 3731], [3752, 3753], [3764, 3772], [3774, 3775], [3783, 3791],
[3802, 3803], [3806, 3839], [3841, 3871], [3892, 3903], [3949, 3975], [3980, 4095],
[4139, 4158], [4170, 4175], [4182, 4185], [4190, 4192], [4194, 4196], [4199, 4205],
[4209, 4212], [4226, 4237], [4250, 4255], [4294, 4303], [4349, 4351], [4686, 4687],
[4702, 4703], [4750, 4751], [4790, 4791], [4806, 4807], [4886, 4887], [4955, 4968],
[4989, 4991], [5008, 5023], [5109, 5120], [5741, 5742], [5787, 5791], [5867, 5869],
[5873, 5887], [5906, 5919], [5938, 5951], [5970, 5983], [6001, 6015], [6068, 6102],
[6104, 6107], [6109, 6111], [6122, 6127], [6138, 6159], [6170, 6175], [6264, 6271],
[6315, 6319], [6390, 6399], [6429, 6469], [6510, 6511], [6517, 6527], [6572, 6592],
[6600, 6607], [6619, 6655], [6679, 6687], [6741, 6783], [6794, 6799], [6810, 6822],
[6824, 6916], [6964, 6980], [6988, 6991], [7002, 7042], [7073, 7085], [7098, 7167],
[7204, 7231], [7242, 7244], [7294, 7400], [7410, 7423], [7616, 7679], [7958, 7959],
[7966, 7967], [8006, 8007], [8014, 8015], [8062, 8063], [8127, 8129], [8141, 8143],
[8148, 8149], [8156, 8159], [8173, 8177], [8189, 8303], [8306, 8307], [8314, 8318],
[8330, 8335], [8341, 8449], [8451, 8454], [8456, 8457], [8470, 8472], [8478, 8483],
[8506, 8507], [8512, 8516], [8522, 8525], [8586, 9311], [9372, 9449], [9472, 10101],
[10132, 11263], [11493, 11498], [11503, 11516], [11518, 11519], [11558, 11567],
[11622, 11630], [11632, 11647], [11671, 11679], [11743, 11822], [11824, 12292],
[12296, 12320], [12330, 12336], [12342, 12343], [12349, 12352], [12439, 12444],
[12544, 12548], [12590, 12592], [12687, 12689], [12694, 12703], [12728, 12783],
[12800, 12831], [12842, 12880], [12896, 12927], [12938, 12976], [12992, 13311],
[19894, 19967], [40908, 40959], [42125, 42191], [42238, 42239], [42509, 42511],
[42540, 42559], [42592, 42593], [42607, 42622], [42648, 42655], [42736, 42774],
[42784, 42785], [42889, 42890], [42893, 43002], [43043, 43055], [43062, 43071],
[43124, 43137], [43188, 43215], [43226, 43249], [43256, 43258], [43260, 43263],
[43302, 43311], [43335, 43359], [43389, 43395], [43443, 43470], [43482, 43519],
[43561, 43583], [43596, 43599], [43610, 43615], [43639, 43641], [43643, 43647],
[43698, 43700], [43703, 43704], [43710, 43711], [43715, 43738], [43742, 43967],
[44003, 44015], [44026, 44031], [55204, 55215], [55239, 55242], [55292, 55295],
[57344, 63743], [64046, 64047], [64110, 64111], [64218, 64255], [64263, 64274],
[64280, 64284], [64434, 64466], [64830, 64847], [64912, 64913], [64968, 65007],
[65020, 65135], [65277, 65295], [65306, 65312], [65339, 65344], [65371, 65381],
[65471, 65473], [65480, 65481], [65488, 65489], [65496, 65497]];
for (i = 0; i < ranges.length; i++) {
start = ranges[i][0];
end = ranges[i][1];
for (j = start; j <= end; j++) {
result[j] = true;
}
}
return result;
})();
function splitQuery(query) {
var result = [];
var start = -1;
for (var i = 0; i < query.length; i++) {
if (splitChars[query.charCodeAt(i)]) {
if (start !== -1) {
result.push(query.slice(start, i));
start = -1;
}
} else if (start === -1) {
start = i;
}
}
if (start !== -1) {
result.push(query.slice(start));
}
return result;
}

422
src/extra/manual/beta/_static/searchtools.js
View File

@ -1,331 +1,54 @@
/*
* searchtools.js_t
* searchtools.js
* ~~~~~~~~~~~~~~~~
*
* Sphinx JavaScript utilities for the full-text search.
*
* :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
if (!Scorer) {
/**
* Simple result scoring code.
*/
var Scorer = {
// Implement the following function to further tweak the score for each result
// The function takes a result array [filename, title, anchor, descr, score]
// and returns the new score.
/*
score: function(result) {
return result[4];
},
*/
/* Non-minified version JS is _stemmer.js if file is provided */
/**
* Porter Stemmer
*/
var Stemmer = function() {
// query matches the full name of an object
objNameMatch: 11,
// or matches in the last dotted part of the object name
objPartialMatch: 6,
// Additive scores depending on the priority of the object
objPrio: {0: 15, // used to be importantResults
1: 5, // used to be objectResults
2: -5}, // used to be unimportantResults
// Used when the priority is not in the mapping.
objPrioDefault: 0,
var step2list = {
ational: 'ate',
tional: 'tion',
enci: 'ence',
anci: 'ance',
izer: 'ize',
bli: 'ble',
alli: 'al',
entli: 'ent',
eli: 'e',
ousli: 'ous',
ization: 'ize',
ation: 'ate',
ator: 'ate',
alism: 'al',
iveness: 'ive',
fulness: 'ful',
ousness: 'ous',
aliti: 'al',
iviti: 'ive',
biliti: 'ble',
logi: 'log'
// query found in title
title: 15,
partialTitle: 7,
// query found in terms
term: 5,
partialTerm: 2
};
}
var step3list = {
icate: 'ic',
ative: '',
alize: 'al',
iciti: 'ic',
ical: 'ic',
ful: '',
ness: ''
};
var c = "[^aeiou]"; // consonant
var v = "[aeiouy]"; // vowel
var C = c + "[^aeiouy]*"; // consonant sequence
var V = v + "[aeiou]*"; // vowel sequence
var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
var s_v = "^(" + C + ")?" + v; // vowel in stem
this.stemWord = function (w) {
var stem;
var suffix;
var firstch;
var origword = w;
if (w.length < 3)
return w;
var re;
var re2;
var re3;
var re4;
firstch = w.substr(0,1);
if (firstch == "y")
w = firstch.toUpperCase() + w.substr(1);
// Step 1a
re = /^(.+?)(ss|i)es$/;
re2 = /^(.+?)([^s])s$/;
if (re.test(w))
w = w.replace(re,"$1$2");
else if (re2.test(w))
w = w.replace(re2,"$1$2");
// Step 1b
re = /^(.+?)eed$/;
re2 = /^(.+?)(ed|ing)$/;
if (re.test(w)) {
var fp = re.exec(w);
re = new RegExp(mgr0);
if (re.test(fp[1])) {
re = /.$/;
w = w.replace(re,"");
}
}
else if (re2.test(w)) {
var fp = re2.exec(w);
stem = fp[1];
re2 = new RegExp(s_v);
if (re2.test(stem)) {
w = stem;
re2 = /(at|bl|iz)$/;
re3 = new RegExp("([^aeiouylsz])\\1$");
re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
if (re2.test(w))
w = w + "e";
else if (re3.test(w)) {
re = /.$/;
w = w.replace(re,"");
}
else if (re4.test(w))
w = w + "e";
}
}
// Step 1c
re = /^(.+?)y$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(s_v);
if (re.test(stem))
w = stem + "i";
}
// Step 2
re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
suffix = fp[2];
re = new RegExp(mgr0);
if (re.test(stem))
w = stem + step2list[suffix];
}
// Step 3
re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
suffix = fp[2];
re = new RegExp(mgr0);
if (re.test(stem))
w = stem + step3list[suffix];
}
// Step 4
re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
re2 = /^(.+?)(s|t)(ion)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(mgr1);
if (re.test(stem))
w = stem;
}
else if (re2.test(w)) {
var fp = re2.exec(w);
stem = fp[1] + fp[2];
re2 = new RegExp(mgr1);
if (re2.test(stem))
w = stem;
}
// Step 5
re = /^(.+?)e$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(mgr1);
re2 = new RegExp(meq1);
re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
w = stem;
}
re = /ll$/;
re2 = new RegExp(mgr1);
if (re.test(w) && re2.test(w)) {
re = /.$/;
w = w.replace(re,"");
}
// and turn initial Y back to y
if (firstch == "y")
w = firstch.toLowerCase() + w.substr(1);
return w;
if (!splitQuery) {
function splitQuery(query) {
return query.split(/\s+/);
}
}
/**
* Simple result scoring code.
*/
var Scorer = {
// Implement the following function to further tweak the score for each result
// The function takes a result array [filename, title, anchor, descr, score]
// and returns the new score.
/*
score: function(result) {
return result[4];
},
*/
// query matches the full name of an object
objNameMatch: 11,
// or matches in the last dotted part of the object name
objPartialMatch: 6,
// Additive scores depending on the priority of the object
objPrio: {0: 15, // used to be importantResults
1: 5, // used to be objectResults
2: -5}, // used to be unimportantResults
// Used when the priority is not in the mapping.
objPrioDefault: 0,
// query found in title
title: 15,
// query found in terms
term: 5
};
var splitChars = (function() {
var result = {};
var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648,
1748, 1809, 2416, 2473, 2481, 2526, 2601, 2609, 2612, 2615, 2653, 2702,
2706, 2729, 2737, 2740, 2857, 2865, 2868, 2910, 2928, 2948, 2961, 2971,
2973, 3085, 3089, 3113, 3124, 3213, 3217, 3241, 3252, 3295, 3341, 3345,
3369, 3506, 3516, 3633, 3715, 3721, 3736, 3744, 3748, 3750, 3756, 3761,
3781, 3912, 4239, 4347, 4681, 4695, 4697, 4745, 4785, 4799, 4801, 4823,
4881, 5760, 5901, 5997, 6313, 7405, 8024, 8026, 8028, 8030, 8117, 8125,
8133, 8181, 8468, 8485, 8487, 8489, 8494, 8527, 11311, 11359, 11687, 11695,
11703, 11711, 11719, 11727, 11735, 12448, 12539, 43010, 43014, 43019, 43587,
43696, 43713, 64286, 64297, 64311, 64317, 64319, 64322, 64325, 65141];
var i, j, start, end;
for (i = 0; i < singles.length; i++) {
result[singles[i]] = true;
}
var ranges = [[0, 47], [58, 64], [91, 94], [123, 169], [171, 177], [182, 184], [706, 709],
[722, 735], [741, 747], [751, 879], [888, 889], [894, 901], [1154, 1161],
[1318, 1328], [1367, 1368], [1370, 1376], [1416, 1487], [1515, 1519], [1523, 1568],
[1611, 1631], [1642, 1645], [1750, 1764], [1767, 1773], [1789, 1790], [1792, 1807],
[1840, 1868], [1958, 1968], [1970, 1983], [2027, 2035], [2038, 2041], [2043, 2047],
[2070, 2073], [2075, 2083], [2085, 2087], [2089, 2307], [2362, 2364], [2366, 2383],
[2385, 2391], [2402, 2405], [2419, 2424], [2432, 2436], [2445, 2446], [2449, 2450],
[2483, 2485], [2490, 2492], [2494, 2509], [2511, 2523], [2530, 2533], [2546, 2547],
[2554, 2564], [2571, 2574], [2577, 2578], [2618, 2648], [2655, 2661], [2672, 2673],
[2677, 2692], [2746, 2748], [2750, 2767], [2769, 2783], [2786, 2789], [2800, 2820],
[2829, 2830], [2833, 2834], [2874, 2876], [2878, 2907], [2914, 2917], [2930, 2946],
[2955, 2957], [2966, 2968], [2976, 2978], [2981, 2983], [2987, 2989], [3002, 3023],
[3025, 3045], [3059, 3076], [3130, 3132], [3134, 3159], [3162, 3167], [3170, 3173],
[3184, 3191], [3199, 3204], [3258, 3260], [3262, 3293], [3298, 3301], [3312, 3332],
[3386, 3388], [3390, 3423], [3426, 3429], [3446, 3449], [3456, 3460], [3479, 3481],
[3518, 3519], [3527, 3584], [3636, 3647], [3655, 3663], [3674, 3712], [3717, 3718],
[3723, 3724], [3726, 3731], [3752, 3753], [3764, 3772], [3774, 3775], [3783, 3791],
[3802, 3803], [3806, 3839], [3841, 3871], [3892, 3903], [3949, 3975], [3980, 4095],
[4139, 4158], [4170, 4175], [4182, 4185], [4190, 4192], [4194, 4196], [4199, 4205],
[4209, 4212], [4226, 4237], [4250, 4255], [4294, 4303], [4349, 4351], [4686, 4687],
[4702, 4703], [4750, 4751], [4790, 4791], [4806, 4807], [4886, 4887], [4955, 4968],
[4989, 4991], [5008, 5023], [5109, 5120], [5741, 5742], [5787, 5791], [5867, 5869],
[5873, 5887], [5906, 5919], [5938, 5951], [5970, 5983], [6001, 6015], [6068, 6102],
[6104, 6107], [6109, 6111], [6122, 6127], [6138, 6159], [6170, 6175], [6264, 6271],
[6315, 6319], [6390, 6399], [6429, 6469], [6510, 6511], [6517, 6527], [6572, 6592],
[6600, 6607], [6619, 6655], [6679, 6687], [6741, 6783], [6794, 6799], [6810, 6822],
[6824, 6916], [6964, 6980], [6988, 6991], [7002, 7042], [7073, 7085], [7098, 7167],
[7204, 7231], [7242, 7244], [7294, 7400], [7410, 7423], [7616, 7679], [7958, 7959],
[7966, 7967], [8006, 8007], [8014, 8015], [8062, 8063], [8127, 8129], [8141, 8143],
[8148, 8149], [8156, 8159], [8173, 8177], [8189, 8303], [8306, 8307], [8314, 8318],
[8330, 8335], [8341, 8449], [8451, 8454], [8456, 8457], [8470, 8472], [8478, 8483],
[8506, 8507], [8512, 8516], [8522, 8525], [8586, 9311], [9372, 9449], [9472, 10101],
[10132, 11263], [11493, 11498], [11503, 11516], [11518, 11519], [11558, 11567],
[11622, 11630], [11632, 11647], [11671, 11679], [11743, 11822], [11824, 12292],
[12296, 12320], [12330, 12336], [12342, 12343], [12349, 12352], [12439, 12444],
[12544, 12548], [12590, 12592], [12687, 12689], [12694, 12703], [12728, 12783],
[12800, 12831], [12842, 12880], [12896, 12927], [12938, 12976], [12992, 13311],
[19894, 19967], [40908, 40959], [42125, 42191], [42238, 42239], [42509, 42511],
[42540, 42559], [42592, 42593], [42607, 42622], [42648, 42655], [42736, 42774],
[42784, 42785], [42889, 42890], [42893, 43002], [43043, 43055], [43062, 43071],
[43124, 43137], [43188, 43215], [43226, 43249], [43256, 43258], [43260, 43263],
[43302, 43311], [43335, 43359], [43389, 43395], [43443, 43470], [43482, 43519],
[43561, 43583], [43596, 43599], [43610, 43615], [43639, 43641], [43643, 43647],
[43698, 43700], [43703, 43704], [43710, 43711], [43715, 43738], [43742, 43967],
[44003, 44015], [44026, 44031], [55204, 55215], [55239, 55242], [55292, 55295],
[57344, 63743], [64046, 64047], [64110, 64111], [64218, 64255], [64263, 64274],
[64280, 64284], [64434, 64466], [64830, 64847], [64912, 64913], [64968, 65007],
[65020, 65135], [65277, 65295], [65306, 65312], [65339, 65344], [65371, 65381],
[65471, 65473], [65480, 65481], [65488, 65489], [65496, 65497]];
for (i = 0; i < ranges.length; i++) {
start = ranges[i][0];
end = ranges[i][1];
for (j = start; j <= end; j++) {
result[j] = true;
}
}
return result;
})();
function splitQuery(query) {
var result = [];
var start = -1;
for (var i = 0; i < query.length; i++) {
if (splitChars[query.charCodeAt(i)]) {
if (start !== -1) {
result.push(query.slice(start, i));
start = -1;
}
} else if (start === -1) {
start = i;
}
}
if (start !== -1) {
result.push(query.slice(start));
}
return result;
}
/**
* Search Module
*/
@ -335,6 +58,19 @@ var Search = {
_queued_query : null,
_pulse_status : -1,
htmlToText : function(htmlString) {
var htmlElement = document.createElement('span');
htmlElement.innerHTML = htmlString;
$(htmlElement).find('.headerlink').remove();
docContent = $(htmlElement).find('[role=main]')[0];
if(docContent === undefined) {
console.warn("Content block not found. Sphinx search tries to obtain it " +
"via '[role=main]'. Could you check your theme or template.");
return "";
}
return docContent.textContent || docContent.innerText;
},
init : function() {
var params = $.getQueryParameters();
if (params.q) {
@ -399,7 +135,7 @@ var Search = {
this.out = $('#search-results');
this.title = $('<h2>' + _('Searching') + '</h2>').appendTo(this.out);
this.dots = $('<span></span>').appendTo(this.title);
this.status = $('<p style="display: none"></p>').appendTo(this.out);
this.status = $('<p class="search-summary">&nbsp;</p>').appendTo(this.out);
this.output = $('<ul class="search"/>').appendTo(this.out);
$('#search-progress').text(_('Preparing search...'));
@ -417,7 +153,6 @@ var Search = {
*/
query : function(query) {
var i;
var stopwords = ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"];
// stem the searchterms and add them to the correct list
var stemmer = new Stemmer();
@ -515,7 +250,9 @@ var Search = {
if (results.length) {
var item = results.pop();
var listItem = $('<li style="display:none"></li>');
if (DOCUMENTATION_OPTIONS.FILE_SUFFIX === '') {
var requestUrl = "";
var linkUrl = "";
if (DOCUMENTATION_OPTIONS.BUILDER === 'dirhtml') {
// dirhtml builder
var dirname = item[0] + '/';
if (dirname.match(/\/index\/$/)) {
@ -523,15 +260,17 @@ var Search = {
} else if (dirname == 'index/') {
dirname = '';
}
listItem.append($('<a/>').attr('href',
DOCUMENTATION_OPTIONS.URL_ROOT + dirname +
highlightstring + item[2]).html(item[1]));
requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + dirname;
linkUrl = requestUrl;
} else {
// normal html builders
listItem.append($('<a/>').attr('href',
item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX +
highlightstring + item[2]).html(item[1]));
requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX;
linkUrl = item[0] + DOCUMENTATION_OPTIONS.LINK_SUFFIX;
}
listItem.append($('<a/>').attr('href',
linkUrl +
highlightstring + item[2]).html(item[1]));
if (item[3]) {
listItem.append($('<span> (' + item[3] + ')</span>'));
Search.output.append(listItem);
@ -539,11 +278,7 @@ var Search = {
displayNextItem();
});
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
var suffix = DOCUMENTATION_OPTIONS.SOURCELINK_SUFFIX;
if (suffix === undefined) {
suffix = '.txt';
}
$.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + item[5] + (item[5].slice(-suffix.length) === suffix ? '' : suffix),
$.ajax({url: requestUrl,
dataType: "text",
complete: function(jqxhr, textstatus) {
var data = jqxhr.responseText;
@ -593,12 +328,13 @@ var Search = {
for (var prefix in objects) {
for (var name in objects[prefix]) {
var fullname = (prefix ? prefix + '.' : '') + name;
if (fullname.toLowerCase().indexOf(object) > -1) {
var fullnameLower = fullname.toLowerCase()
if (fullnameLower.indexOf(object) > -1) {
var score = 0;
var parts = fullname.split('.');
var parts = fullnameLower.split('.');
// check for different match types: exact matches of full name or
// "last name" (i.e. last dotted part)
if (fullname == object || parts[parts.length - 1] == object) {
if (fullnameLower == object || parts[parts.length - 1] == object) {
score += Scorer.objNameMatch;
// matches in last name
} else if (parts[parts.length - 1].indexOf(object) > -1) {
@ -665,6 +401,19 @@ var Search = {
{files: terms[word], score: Scorer.term},
{files: titleterms[word], score: Scorer.title}
];
// add support for partial matches
if (word.length > 2) {
for (var w in terms) {
if (w.match(word) && !terms[word]) {
_o.push({files: terms[w], score: Scorer.partialTerm})
}
}
for (var w in titleterms) {
if (w.match(word) && !titleterms[word]) {
_o.push({files: titleterms[w], score: Scorer.partialTitle})
}
}
}
// no match but word was a required one
if ($u.every(_o, function(o){return o.files === undefined;})) {
@ -684,7 +433,7 @@ var Search = {
for (j = 0; j < _files.length; j++) {
file = _files[j];
if (!(file in scoreMap))
scoreMap[file] = {}
scoreMap[file] = {};
scoreMap[file][word] = o.score;
}
});
@ -692,7 +441,7 @@ var Search = {
// create the mapping
for (j = 0; j < files.length; j++) {
file = files[j];
if (file in fileMap)
if (file in fileMap && fileMap[file].indexOf(word) === -1)
fileMap[file].push(word);
else
fileMap[file] = [word];
@ -704,8 +453,12 @@ var Search = {
var valid = true;
// check if all requirements are matched
if (fileMap[file].length != searchterms.length)
continue;
var filteredTermCount = // as search terms with length < 3 are discarded: ignore
searchterms.filter(function(term){return term.length > 2}).length
if (
fileMap[file].length != searchterms.length &&
fileMap[file].length != filteredTermCount
) continue;
// ensure that none of the excluded terms is in the search result
for (i = 0; i < excluded.length; i++) {
@ -736,7 +489,8 @@ var Search = {
* words. the first one is used to find the occurrence, the
* latter for highlighting it.
*/
makeSearchSummary : function(text, keywords, hlwords) {
makeSearchSummary : function(htmlText, keywords, hlwords) {
var text = Search.htmlToText(htmlText);
var textLower = text.toLowerCase();
var start = 0;
$.each(keywords, function() {

95
src/extra/manual/beta/cdist-best-practice.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>25. Best practice &mdash; cdist 6.5.6 documentation</title>
<title>25. Best practice &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -189,7 +180,7 @@
<li><a href="index.html">Docs</a> &raquo;</li>
<li>25. Best practice</li>
<li><span class="section-number">25. </span>Best practice</li>
<li class="wy-breadcrumbs-aside">
@ -209,17 +200,17 @@
<div itemprop="articleBody">
<div class="section" id="best-practice">
<h1>25. Best practice<a class="headerlink" href="#best-practice" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">25. </span>Best practice<a class="headerlink" href="#best-practice" title="Permalink to this headline"></a></h1>
<p>Practices used in real environments</p>
<div class="section" id="passwordless-connections">
<h2>25.1. Passwordless connections<a class="headerlink" href="#passwordless-connections" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">25.1. </span>Passwordless connections<a class="headerlink" href="#passwordless-connections" title="Permalink to this headline"></a></h2>
<p>It is recommended to run cdist with public key authentication.
This requires a private/public key pair and the entry
&quot;PermitRootLogin without-password&quot; in the sshd server.
See sshd_config(5) and ssh-keygen(1).</p>
</div>
<div class="section" id="speeding-up-ssh-connections">
<h2>25.2. Speeding up ssh connections<a class="headerlink" href="#speeding-up-ssh-connections" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">25.2. </span>Speeding up ssh connections<a class="headerlink" href="#speeding-up-ssh-connections" title="Permalink to this headline"></a></h2>
<p>When connecting to a new host, the initial delay with ssh connections
is pretty big. As cdist makes many connections to each host successive
connections can be sped up by &quot;sharing of multiple sessions over a single
@ -233,21 +224,21 @@ parallel multiplexed connections this with <cite>MaxSessions N</cite> (N default
for OpenSSH v7.4).</p>
</div>
<div class="section" id="speeding-up-shell-execution">
<h2>25.3. Speeding up shell execution<a class="headerlink" href="#speeding-up-shell-execution" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">25.3. </span>Speeding up shell execution<a class="headerlink" href="#speeding-up-shell-execution" title="Permalink to this headline"></a></h2>
<p>On the source host, ensure that /bin/sh is <em>not</em> bash: bash is quite slow for
script execution. Instead, you could use dash after installing it:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ln</span> <span class="o">-</span><span class="n">sf</span> <span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">dash</span> <span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">sh</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ln</span> <span class="o">-</span><span class="n">sf</span> <span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">dash</span> <span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">sh</span>
</pre></div>
</div>
</div>
<div class="section" id="multi-master-or-environment-setups">
<h2>25.4. Multi master or environment setups<a class="headerlink" href="#multi-master-or-environment-setups" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">25.4. </span>Multi master or environment setups<a class="headerlink" href="#multi-master-or-environment-setups" title="Permalink to this headline"></a></h2>
<p>If you plan to distribute cdist among servers or use different
environments, you can do so easily with the included version
control git. For instance if you plan to use the typical three
environments production, integration and development, you can
realise this with git branches:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># Go to cdist checkout</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Go to cdist checkout</span>
<span class="n">cd</span> <span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">cdist</span>
<span class="c1"># Create branches</span>
@ -261,18 +252,18 @@ realise this with git branches:</p>
</div>
<p>Similar if you want to have cdist checked out at multiple machines,
you can clone it multiple times:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">machine</span><span class="o">-</span><span class="n">a</span> <span class="o">%</span> <span class="n">git</span> <span class="n">clone</span> <span class="n">git</span><span class="p">:</span><span class="o">//</span><span class="n">your</span><span class="o">-</span><span class="n">git</span><span class="o">-</span><span class="n">server</span><span class="o">/</span><span class="n">cdist</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">machine</span><span class="o">-</span><span class="n">a</span> <span class="o">%</span> <span class="n">git</span> <span class="n">clone</span> <span class="n">git</span><span class="p">:</span><span class="o">//</span><span class="n">your</span><span class="o">-</span><span class="n">git</span><span class="o">-</span><span class="n">server</span><span class="o">/</span><span class="n">cdist</span>
<span class="n">machine</span><span class="o">-</span><span class="n">b</span> <span class="o">%</span> <span class="n">git</span> <span class="n">clone</span> <span class="n">git</span><span class="p">:</span><span class="o">//</span><span class="n">your</span><span class="o">-</span><span class="n">git</span><span class="o">-</span><span class="n">server</span><span class="o">/</span><span class="n">cdist</span>
</pre></div>
</div>
</div>
<div class="section" id="separating-work-by-groups">
<h2>25.5. Separating work by groups<a class="headerlink" href="#separating-work-by-groups" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">25.5. </span>Separating work by groups<a class="headerlink" href="#separating-work-by-groups" title="Permalink to this headline"></a></h2>
<p>If you are working with different groups on one cdist-configuration,
you can delegate to other manifests and have the groups edit only
their manifests. You can use the following snippet in
<strong>conf/manifests/init</strong>:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># Include other groups</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Include other groups</span>
<span class="n">sh</span> <span class="o">-</span><span class="n">e</span> <span class="s2">&quot;$__manifest/systems&quot;</span>
<span class="n">sh</span> <span class="o">-</span><span class="n">e</span> <span class="s2">&quot;$__manifest/cbrg&quot;</span>
@ -280,11 +271,11 @@ their manifests. You can use the following snippet in
</div>
</div>
<div class="section" id="maintaining-multiple-configurations">
<h2>25.6. Maintaining multiple configurations<a class="headerlink" href="#maintaining-multiple-configurations" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">25.6. </span>Maintaining multiple configurations<a class="headerlink" href="#maintaining-multiple-configurations" title="Permalink to this headline"></a></h2>
<p>When you need to manage multiple sites with cdist, like company_a, company_b
and private for instance, you can easily use git for this purpose.
Including a possible common base that is reused across the different sites:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># create branches</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># create branches</span>
<span class="n">git</span> <span class="n">branch</span> <span class="n">company_a</span> <span class="n">company_b</span> <span class="n">common</span> <span class="n">private</span>
<span class="c1"># make stuff for company a</span>
@ -305,7 +296,7 @@ Including a possible common base that is reused across the different sites:</p>
</pre></div>
</div>
<p>The following <strong>.git/config</strong> is taken from a real world scenario:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># Track upstream, merge from time to time</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Track upstream, merge from time to time</span>
<span class="p">[</span><span class="n">remote</span> <span class="s2">&quot;upstream&quot;</span><span class="p">]</span>
<span class="n">url</span> <span class="o">=</span> <span class="n">git</span><span class="p">:</span><span class="o">//</span><span class="n">git</span><span class="o">.</span><span class="n">schottelius</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="n">cdist</span>
<span class="n">fetch</span> <span class="o">=</span> <span class="o">+</span><span class="n">refs</span><span class="o">/</span><span class="n">heads</span><span class="o">/*</span><span class="p">:</span><span class="n">refs</span><span class="o">/</span><span class="n">remotes</span><span class="o">/</span><span class="n">upstream</span><span class="o">/*</span>
@ -339,23 +330,19 @@ Including a possible common base that is reused across the different sites:</p>
<p>Have a look at git-remote(1) to adjust the remote configuration, which allows</p>
</div>
<div class="section" id="multiple-developers-with-different-trust">
<h2>25.7. Multiple developers with different trust<a class="headerlink" href="#multiple-developers-with-different-trust" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">25.7. </span>Multiple developers with different trust<a class="headerlink" href="#multiple-developers-with-different-trust" title="Permalink to this headline"></a></h2>
<p>If you are working in an environment that requires different people to
work on the same configuration, but having different privileges, you can
implement this scenario with a gateway host and sudo:</p>
<ul>
<li><p class="first">Create a dedicated user (for instance <strong>cdist</strong>)</p>
</li>
<li><p class="first">Setup the ssh-pubkey for this user that has the right to configure all hosts</p>
</li>
<li><p class="first">Create a wrapper to update the cdist configuration in ~cdist/cdist</p>
</li>
<li><p class="first">Allow every developer to execute this script via sudo as the user cdist</p>
</li>
<li><p class="first">Allow run of cdist as user cdist on specific hosts on a per user/group basis.</p>
<li><p>Create a dedicated user (for instance <strong>cdist</strong>)</p></li>
<li><p>Setup the ssh-pubkey for this user that has the right to configure all hosts</p></li>
<li><p>Create a wrapper to update the cdist configuration in ~cdist/cdist</p></li>
<li><p>Allow every developer to execute this script via sudo as the user cdist</p></li>
<li><p>Allow run of cdist as user cdist on specific hosts on a per user/group basis.</p>
<blockquote>
<div><ul class="simple">
<li>f.i. nico ALL=(ALL) NOPASSWD: /home/cdist/bin/cdist config hostabc</li>
<li><p>f.i. nico ALL=(ALL) NOPASSWD: /home/cdist/bin/cdist config hostabc</p></li>
</ul>
</div></blockquote>
</li>
@ -363,12 +350,12 @@ implement this scenario with a gateway host and sudo:</p>
<p>For more details consult sudoers(5)</p>
</div>
<div class="section" id="templating">
<h2>25.8. Templating<a class="headerlink" href="#templating" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">25.8. </span>Templating<a class="headerlink" href="#templating" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li>create directory files/ in your type (convention)</li>
<li>create the template as an executable file like files/basic.conf.sh, it will output text using shell variables for the values</li>
<li><p>create directory files/ in your type (convention)</p></li>
<li><p>create the template as an executable file like files/basic.conf.sh, it will output text using shell variables for the values</p></li>
</ul>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="ch">#!/bin/sh</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="ch">#!/bin/sh</span>
<span class="c1"># in the template, use cat &lt;&lt; eof (here document) to output the text</span>
<span class="c1"># and use standard shell variables in the template</span>
<span class="c1"># output everything in the template script to stdout</span>
@ -385,9 +372,9 @@ cat <span class="s">&lt;&lt; EOF</span>
</pre></div>
</div>
<ul class="simple">
<li>in the manifest, export the relevant variables and add the following lines to your manifest:</li>
<li><p>in the manifest, export the relevant variables and add the following lines to your manifest:</p></li>
</ul>
<div class="highlight-console"><div class="highlight"><pre><span></span><span class="gp">#</span> <span class="nb">export</span> variables needed <span class="k">for</span> the template
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">#</span> <span class="nb">export</span> variables needed <span class="k">for</span> the template
<span class="go"> export SERVERNAME=&#39;test&quot;</span>
<span class="go"> export ROOT=&#39;/var/www/test&#39;</span>
<span class="gp">#</span> render the template
@ -401,12 +388,12 @@ cat <span class="s">&lt;&lt; EOF</span>
</div>
</div>
<div class="section" id="testing-a-new-type">
<h2>25.9. Testing a new type<a class="headerlink" href="#testing-a-new-type" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">25.9. </span>Testing a new type<a class="headerlink" href="#testing-a-new-type" title="Permalink to this headline"></a></h2>
<p>If you want to test a new type on a node, you can tell cdist to only use an
object of this type: Use the '--initial-manifest' parameter
with - (stdin) as argument and feed object into stdin
of cdist:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># Singleton type without parameter</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Singleton type without parameter</span>
<span class="nb">echo</span> __ungleich_munin_server <span class="p">|</span> cdist --initial-manifest - munin.panter.ch
<span class="c1"># Singleton type with parameter</span>
@ -420,7 +407,7 @@ of cdist:</p>
</div>
</div>
<div class="section" id="other-content-in-cdist-repository">
<h2>25.10. Other content in cdist repository<a class="headerlink" href="#other-content-in-cdist-repository" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">25.10. </span>Other content in cdist repository<a class="headerlink" href="#other-content-in-cdist-repository" title="Permalink to this headline"></a></h2>
<p>Usually the cdist repository contains all configuration
items. Sometimes you may have additional resources that
you would like to store in your central configuration
@ -433,7 +420,7 @@ and also to store all important files in one
repository.</p>
</div>
<div class="section" id="notes-on-cdist-order-dependency">
<h2>25.11. Notes on CDIST_ORDER_DEPENDENCY<a class="headerlink" href="#notes-on-cdist-order-dependency" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">25.11. </span>Notes on CDIST_ORDER_DEPENDENCY<a class="headerlink" href="#notes-on-cdist-order-dependency" title="Permalink to this headline"></a></h2>
<p>With CDIST_ORDER_DEPENDENCY all types are executed in the order in which they
are created in the manifest. The current created object automatically depends
on the previously created object.</p>
@ -441,11 +428,11 @@ on the previously created object.</p>
(like first creating the directory xyz than the file below the directory).</p>
<p>This can be helpful, but one must be aware of its side effects.</p>
<div class="section" id="cdist-order-dependency-kills-parallelization">
<h3>25.11.1. CDIST_ORDER_DEPENDENCY kills parallelization<a class="headerlink" href="#cdist-order-dependency-kills-parallelization" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">25.11.1. </span>CDIST_ORDER_DEPENDENCY kills parallelization<a class="headerlink" href="#cdist-order-dependency-kills-parallelization" title="Permalink to this headline"></a></h3>
<p>Suppose you have defined CDIST_ORDER_DEPENDENCY and then, among other things,
you specify creation of three, by nature independent, files.</p>
<p><strong>init</strong></p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="nv">CDIST_ORDER_DEPENDENCY</span><span class="o">=</span><span class="m">1</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">CDIST_ORDER_DEPENDENCY</span><span class="o">=</span><span class="m">1</span>
<span class="nb">export</span> CDIST_ORDER_DEPENDENCY
...
@ -458,7 +445,7 @@ __file /tmp/file3
<p>Due to defined CDIST_ORDER_DEPENDENCY cdist will execute them in specified order.
It is better to use CDIST_ORDER_DEPENDENCY in well defined blocks:</p>
<p><strong>init</strong></p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="nv">CDIST_ORDER_DEPENDENCY</span><span class="o">=</span><span class="m">1</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">CDIST_ORDER_DEPENDENCY</span><span class="o">=</span><span class="m">1</span>
<span class="nb">export</span> CDIST_ORDER_DEPENDENCY
...
<span class="nb">unset</span> CDIST_ORDER_DEPENDENCY

45
src/extra/manual/beta/cdist-bootstrap.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>12. Bootstrap &mdash; cdist 6.5.6 documentation</title>
<title>12. Bootstrap &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -179,7 +170,7 @@
<li><a href="index.html">Docs</a> &raquo;</li>
<li>12. Bootstrap</li>
<li><span class="section-number">12. </span>Bootstrap</li>
<li class="wy-breadcrumbs-aside">
@ -199,12 +190,12 @@
<div itemprop="articleBody">
<div class="section" id="bootstrap">
<h1>12. Bootstrap<a class="headerlink" href="#bootstrap" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">12. </span>Bootstrap<a class="headerlink" href="#bootstrap" title="Permalink to this headline"></a></h1>
<p>This document describes the usual steps recommended for a new
cdist setup. It is recommended that you have read and understood
<a class="reference external" href="cdist-quickstart.html">cdist quickstart</a> before digging into this.</p>
<div class="section" id="location">
<h2>12.1. Location<a class="headerlink" href="#location" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">12.1. </span>Location<a class="headerlink" href="#location" title="Permalink to this headline"></a></h2>
<p>First of all, you should think about where to store your configuration
database and who will be accessing or changing it. Secondly you have to
think about where to configure your hosts from, which may be a different
@ -218,16 +209,16 @@ with others.</p>
people, have a look at <a class="reference external" href="cdist-best-practice.html">cdist best practice</a>.</p>
</div>
<div class="section" id="setup-working-directory-and-branch">
<h2>12.2. Setup working directory and branch<a class="headerlink" href="#setup-working-directory-and-branch" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">12.2. </span>Setup working directory and branch<a class="headerlink" href="#setup-working-directory-and-branch" title="Permalink to this headline"></a></h2>
<p>I assume you have a fresh copy of the cdist tree in ~/cdist, cloned from
one of the official urls (see <a class="reference external" href="cdist-quickstart.html">cdist quickstart</a> if you don't).
one of the official URLs (see <a class="reference external" href="cdist-quickstart.html">cdist quickstart</a> if you don't).
Entering the command &quot;git branch&quot; should show you &quot;* master&quot;, which indicates
you are on the <strong>master</strong> branch.</p>
<p>The master branch reflects the latest development of cdist. As this is the
development branch, it may or may not work. There are also version branches
available, which are kept in a stable state. Let's use <strong>git branch -r</strong>
to list all branches:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cdist</span><span class="o">%</span> <span class="n">git</span> <span class="n">branch</span> <span class="o">-</span><span class="n">r</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cdist</span><span class="o">%</span> <span class="n">git</span> <span class="n">branch</span> <span class="o">-</span><span class="n">r</span>
<span class="n">origin</span><span class="o">/</span><span class="mf">1.0</span>
<span class="n">origin</span><span class="o">/</span><span class="mf">1.1</span>
<span class="n">origin</span><span class="o">/</span><span class="mf">1.2</span>
@ -255,7 +246,7 @@ your own work. Now it's time to create your branch, which contains your
local changes. I usually name it by the company/area I am working for:
ethz-systems, localch, customerX, ... But this is pretty much up to you.</p>
<p>In this tutorial I use the branch <strong>mycompany</strong>:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cdist</span><span class="o">%</span> <span class="n">git</span> <span class="n">checkout</span> <span class="o">-</span><span class="n">b</span> <span class="n">mycompany</span> <span class="n">origin</span><span class="o">/</span><span class="n">master</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cdist</span><span class="o">%</span> <span class="n">git</span> <span class="n">checkout</span> <span class="o">-</span><span class="n">b</span> <span class="n">mycompany</span> <span class="n">origin</span><span class="o">/</span><span class="n">master</span>
<span class="n">Branch</span> <span class="n">mycompany</span> <span class="nb">set</span> <span class="n">up</span> <span class="n">to</span> <span class="n">track</span> <span class="n">remote</span> <span class="n">branch</span> <span class="n">master</span> <span class="kn">from</span> <span class="nn">origin.</span>
<span class="n">Switched</span> <span class="n">to</span> <span class="n">a</span> <span class="n">new</span> <span class="n">branch</span> <span class="s1">&#39;mycompany&#39;</span>
<span class="n">cdist</span><span class="o">-</span><span class="n">user</span><span class="o">%</span> <span class="n">git</span> <span class="n">branch</span>
@ -266,13 +257,13 @@ ethz-systems, localch, customerX, ... But this is pretty much up to you.</p>
<p>From now on, you can use git as usual to commit your changes in your own branch.</p>
</div>
<div class="section" id="publishing-the-configuration">
<h2>12.3. Publishing the configuration<a class="headerlink" href="#publishing-the-configuration" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">12.3. </span>Publishing the configuration<a class="headerlink" href="#publishing-the-configuration" title="Permalink to this headline"></a></h2>
<p>Usually a development machine like a notebook should be considered
temporary only. For this reason and to enable shareability, the configuration
should be published to another device as early as possible. The following
example shows how to publish the configuration to another host that is
reachable via ssh and has git installed:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># Create bare git repository on the host named &quot;loch&quot;</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Create bare git repository on the host named &quot;loch&quot;</span>
<span class="n">cdist</span><span class="o">%</span> <span class="n">ssh</span> <span class="n">loch</span> <span class="s2">&quot;GIT_DIR=/home/nutzer/cdist git init&quot;</span>
<span class="n">Initialized</span> <span class="n">empty</span> <span class="n">Git</span> <span class="n">repository</span> <span class="ow">in</span> <span class="o">/</span><span class="n">home</span><span class="o">/</span><span class="n">nutzer</span><span class="o">/</span><span class="n">cdist</span><span class="o">/</span>
@ -294,9 +285,9 @@ branch with the <strong>master</strong> branch on the host <strong>loch</strong>
as usual in your branch and push out changes by entering <strong>git push</strong>.</p>
</div>
<div class="section" id="updating-from-origin">
<h2>12.4. Updating from origin<a class="headerlink" href="#updating-from-origin" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">12.4. </span>Updating from origin<a class="headerlink" href="#updating-from-origin" title="Permalink to this headline"></a></h2>
<p>Whenever you want to update your cdist installation, you can use git to do so:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># Update git repository with latest changes from origin</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Update git repository with latest changes from origin</span>
<span class="n">cdist</span><span class="o">%</span> <span class="n">git</span> <span class="n">fetch</span> <span class="n">origin</span>
<span class="c1"># Update current branch with master branch from origin</span>

137
src/extra/manual/beta/cdist-cache.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>27. Local cache overview &mdash; cdist 6.5.6 documentation</title>
<title>27. Local cache overview &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -180,7 +171,7 @@
<li><a href="index.html">Docs</a> &raquo;</li>
<li>27. Local cache overview</li>
<li><span class="section-number">27. </span>Local cache overview</li>
<li class="wy-breadcrumbs-aside">
@ -200,9 +191,9 @@
<div itemprop="articleBody">
<div class="section" id="local-cache-overview">
<h1>27. Local cache overview<a class="headerlink" href="#local-cache-overview" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">27. </span>Local cache overview<a class="headerlink" href="#local-cache-overview" title="Permalink to this headline"></a></h1>
<div class="section" id="description">
<h2>27.1. Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">27.1. </span>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>While executing, cdist stores data to local cache. Currently this feature is
one way only. That means that cdist does not use stored data for future runs.
Anyway, those data can be used for debugging cdist, debugging types and
@ -216,64 +207,64 @@ environment variable.</p>
section in cdist man page.</p>
</div>
<div class="section" id="cache-overview">
<h2>27.2. Cache overview<a class="headerlink" href="#cache-overview" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">27.2. </span>Cache overview<a class="headerlink" href="#cache-overview" title="Permalink to this headline"></a></h2>
<p>As noted above each configured host has got its subdirectory in local cache.
Entries in host's cache directory are as follows.</p>
<dl class="docutils">
<dt>bin</dt>
<dd>directory with cdist type emulators</dd>
<dt>conf</dt>
<dd>dynamically determined cdist conf directory, union of all specified
conf directories</dd>
<dt>explorer</dt>
<dd>directory containing global explorer named files containing explorer output
after running on target host</dd>
<dt>messages</dt>
<dd>file containing messages</dd>
<dt>object</dt>
<dd>directory containing subdirectory for each cdist object</dd>
<dt>object_marker</dt>
<dd>object marker for this particular cdist run</dd>
<dt>stderr</dt>
<dd>directory containing init manifest and remote stderr stream output</dd>
<dt>stdout</dt>
<dd>directory containing init manifest and remote stdout stream output</dd>
<dt>target_host</dt>
<dd>file containing target host of this cdist run, as specified when running
cdist</dd>
<dt>typeorder</dt>
<dd>file containing types in order of execution.</dd>
<dl class="simple">
<dt>bin</dt><dd><p>directory with cdist type emulators</p>
</dd>
<dt>conf</dt><dd><p>dynamically determined cdist conf directory, union of all specified
conf directories</p>
</dd>
<dt>explorer</dt><dd><p>directory containing global explorer named files containing explorer output
after running on target host</p>
</dd>
<dt>messages</dt><dd><p>file containing messages</p>
</dd>
<dt>object</dt><dd><p>directory containing subdirectory for each cdist object</p>
</dd>
<dt>object_marker</dt><dd><p>object marker for this particular cdist run</p>
</dd>
<dt>stderr</dt><dd><p>directory containing init manifest and remote stderr stream output</p>
</dd>
<dt>stdout</dt><dd><p>directory containing init manifest and remote stdout stream output</p>
</dd>
<dt>target_host</dt><dd><p>file containing target host of this cdist run, as specified when running
cdist</p>
</dd>
<dt>typeorder</dt><dd><p>file containing types in order of execution.</p>
</dd>
</dl>
<div class="section" id="object-cache-overview">
<h3>27.2.1. Object cache overview<a class="headerlink" href="#object-cache-overview" title="Permalink to this headline"></a></h3>
<p>Each object under <strong>object</strong> directory has its own structurue.</p>
<dl class="docutils">
<dt>code-local</dt>
<dd>code generated from gencode-local, present only if something is
generated</dd>
<dt>code-remote</dt>
<dd>code generated from gencode-remote, present only if something is
generated</dd>
<dt>explorer</dt>
<dd>directory containing type explorer named files containing explorer output
after running on target host</dd>
<dt>files</dt>
<dd>directory with object files created during type execution</dd>
<dt>parameter</dt>
<dd>directory containing type parameter named files containing parameter
values</dd>
<dt>source</dt>
<dd>this type's source (init manifest)</dd>
<dt>state</dt>
<dd>this type execution state ('done' when finished)</dd>
<dt>stderr</dt>
<dd>directory containing type's manifest, gencode-* and code-* stderr stream
outputs</dd>
<dt>stdin</dt>
<dd>this type stdin content</dd>
<dt>stdout</dt>
<dd>directory containing type's manifest, gencode-* and code-* stdout stream
outputs.</dd>
<h3><span class="section-number">27.2.1. </span>Object cache overview<a class="headerlink" href="#object-cache-overview" title="Permalink to this headline"></a></h3>
<p>Each object under <strong>object</strong> directory has its own structure.</p>
<dl class="simple">
<dt>code-local</dt><dd><p>code generated from gencode-local, present only if something is
generated</p>
</dd>
<dt>code-remote</dt><dd><p>code generated from gencode-remote, present only if something is
generated</p>
</dd>
<dt>explorer</dt><dd><p>directory containing type explorer named files containing explorer output
after running on target host</p>
</dd>
<dt>files</dt><dd><p>directory with object files created during type execution</p>
</dd>
<dt>parameter</dt><dd><p>directory containing type parameter named files containing parameter
values</p>
</dd>
<dt>source</dt><dd><p>this type's source (init manifest)</p>
</dd>
<dt>state</dt><dd><p>this type execution state ('done' when finished)</p>
</dd>
<dt>stderr</dt><dd><p>directory containing type's manifest, gencode-* and code-* stderr stream
outputs</p>
</dd>
<dt>stdin</dt><dd><p>this type stdin content</p>
</dd>
<dt>stdout</dt><dd><p>directory containing type's manifest, gencode-* and code-* stdout stream
outputs.</p>
</dd>
</dl>
</div>
</div>

61
src/extra/manual/beta/cdist-configuration.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>13. Configuration &mdash; cdist 6.5.6 documentation</title>
<title>13. Configuration &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -177,7 +168,7 @@
<li><a href="index.html">Docs</a> &raquo;</li>
<li>13. Configuration</li>
<li><span class="section-number">13. </span>Configuration</li>
<li class="wy-breadcrumbs-aside">
@ -197,20 +188,20 @@
<div itemprop="articleBody">
<div class="section" id="configuration">
<h1>13. Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">13. </span>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline"></a></h1>
<div class="section" id="description">
<h2>13.1. Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">13.1. </span>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>cdist obtains configuration data from the following sources in the following
order:</p>
<blockquote>
<div><ol class="arabic simple">
<li>command-line options</li>
<li>configuration file specified at command-line using -g command line option</li>
<li>configuration file specified in CDIST_CONFIG_FILE environment variable</li>
<li>environment variables</li>
<li>user's configuration file (first one found of ~/.cdist.cfg, $XDG_CONFIG_HOME/cdist/cdist.cfg, in specified order)</li>
<li>in-distribution configuration file (cdist/conf/cdist.cfg)</li>
<li>system-wide configuration file (/etc/cdist.cfg)</li>
<li><p>command-line options</p></li>
<li><p>configuration file specified at command-line using -g command line option</p></li>
<li><p>configuration file specified in CDIST_CONFIG_FILE environment variable</p></li>
<li><p>environment variables</p></li>
<li><p>user's configuration file (first one found of ~/.cdist.cfg, $XDG_CONFIG_HOME/cdist/cdist.cfg, in specified order)</p></li>
<li><p>in-distribution configuration file (cdist/conf/cdist.cfg)</p></li>
<li><p>system-wide configuration file (/etc/cdist.cfg)</p></li>
</ol>
</div></blockquote>
<p>if one exists.</p>
@ -218,7 +209,7 @@ order:</p>
precedence. Configuration option value read from source with higher
precedence will overwrite option value, if exists, read from source with
lower precedence. That means that command-line option wins them all.</p>
<p>Users can decide on the local conifguration file location. It can be either
<p>Users can decide on the local configuration file location. It can be either
~/.cdist.cfg or $XDG_CONFIG_HOME/cdist/cdist.cfg. Note that, if both exist,
then ~/.cdist.cfg is used.</p>
<p>For a per-project configuration, particular environment variables or better,
@ -226,11 +217,11 @@ CDIST_CONFIG_FILE environment variable or -g CONFIG_FILE command line option,
can be used.</p>
</div>
<div class="section" id="config-file-format">
<h2>13.2. Config file format<a class="headerlink" href="#config-file-format" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">13.2. </span>Config file format<a class="headerlink" href="#config-file-format" title="Permalink to this headline"></a></h2>
<p>cdist configuration file is in the INI file format. Currently it supports
only [GLOBAL] section.</p>
<p>Here you can find configuration file skeleton:</p>
<div class="highlight-ini"><div class="highlight"><pre><span></span><span class="k">[GLOBAL]</span>
<div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="k">[GLOBAL]</span>
<span class="c1"># archiving</span>
<span class="c1"># Use specified archiving. Valid values include:</span>
<span class="c1"># none, tar, tgz, tbz2 and txz.</span>
@ -245,6 +236,14 @@ only [GLOBAL] section.</p>
<span class="c1"># Specify cache path pattern.</span>
<span class="c1"># cache_path_pattern = %h</span>
<span class="c1">#</span>
<span class="c1"># colored_output</span>
<span class="c1"># Colorize cdist&#39;s output. If enabled, cdist will use different colors for</span>
<span class="c1"># different log levels.</span>
<span class="c1"># Recognized values are &#39;always&#39;, &#39;never&#39;, and &#39;auto&#39;.</span>
<span class="c1"># If the value is &#39;auto&#39;, colors are enabled if stdout is a TTY unless</span>
<span class="c1"># the NO_COLOR (https://no-color.org/) environment variable is defined.</span>
<span class="c1"># colored_output = auto</span>
<span class="c1">#</span>
<span class="c1"># conf_dir</span>
<span class="c1"># List of configuration directories separated with the character conventionally</span>
<span class="c1"># used by the operating system to separate search path components (as in PATH),</span>
@ -277,7 +276,7 @@ only [GLOBAL] section.</p>
<span class="c1">#</span>
<span class="c1"># out_path</span>
<span class="c1"># Directory to save cdist output in.</span>
<span class="c1"># out_path = </span>
<span class="c1"># out_path =</span>
<span class="c1">#</span>
<span class="c1"># parallel</span>
<span class="c1"># Process hosts in parallel. If -1 then the default, number of CPU&#39;s in</span>
@ -303,7 +302,7 @@ only [GLOBAL] section.</p>
<span class="c1"># remote_shell = /bin/sh</span>
<span class="c1">#</span>
<span class="c1"># verbosity</span>
<span class="c1"># Set verbosity level. Valid values are: </span>
<span class="c1"># Set verbosity level. Valid values are:</span>
<span class="c1"># ERROR, WARNING, INFO, VERBOSE, DEBUG, TRACE and OFF.</span>
<span class="c1"># verbosity = INFO</span>
</pre></div>

39
src/extra/manual/beta/cdist-explorer.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>17. Explorer &mdash; cdist 6.5.6 documentation</title>
<title>17. Explorer &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -177,7 +168,7 @@
<li><a href="index.html">Docs</a> &raquo;</li>
<li>17. Explorer</li>
<li><span class="section-number">17. </span>Explorer</li>
<li class="wy-breadcrumbs-aside">
@ -197,9 +188,9 @@
<div itemprop="articleBody">
<div class="section" id="explorer">
<h1>17. Explorer<a class="headerlink" href="#explorer" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">17. </span>Explorer<a class="headerlink" href="#explorer" title="Permalink to this headline"></a></h1>
<div class="section" id="description">
<h2>17.1. Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">17.1. </span>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Explorers are small shell scripts, which will be executed on the target
host. The aim of each 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
@ -210,11 +201,11 @@ type explorers. Both work almost exactly the same way, with the difference
that the values of the general explorers are stored in a general location and
the type specific below the object.</p>
<p>Explorers can reuse other explorers on the target system by calling</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>$__explorer/&lt;explorer_name&gt; (general and type explorer)
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$__explorer/&lt;explorer_name&gt; (general and type explorer)
</pre></div>
</div>
<p>or</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>$__type_explorer/&lt;explorer name&gt; (type explorer).
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$__type_explorer/&lt;explorer name&gt; (type explorer).
</pre></div>
</div>
<p>In case of significant errors, the explorer may exit non-zero and return an
@ -223,14 +214,14 @@ error message on stderr, which will cause cdist to abort.</p>
explorer.</p>
</div>
<div class="section" id="examples">
<h2>17.2. Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">17.2. </span>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<p>A very simple explorer may look like this:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">hostname</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">hostname</span>
</pre></div>
</div>
<p>Which is in practise the <strong>hostname</strong> explorer.</p>
<p>A type explorer, which could check for the status of a package may look like this:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="o">[</span> -f <span class="s2">&quot;</span><span class="nv">$__object</span><span class="s2">/parameter/name&quot;</span> <span class="o">]</span><span class="p">;</span> <span class="k">then</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="o">[</span> -f <span class="s2">&quot;</span><span class="nv">$__object</span><span class="s2">/parameter/name&quot;</span> <span class="o">]</span><span class="p">;</span> <span class="k">then</span>
<span class="nv">name</span><span class="o">=</span><span class="s2">&quot;</span><span class="k">$(</span>cat <span class="s2">&quot;</span><span class="nv">$__object</span><span class="s2">/parameter/name&quot;</span><span class="k">)</span><span class="s2">&quot;</span>
<span class="k">else</span>
<span class="nv">name</span><span class="o">=</span><span class="s2">&quot;</span><span class="nv">$__object_id</span><span class="s2">&quot;</span>

92
src/extra/manual/beta/cdist-features.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>2. Features &mdash; cdist 6.5.6 documentation</title>
<title>2. Features &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -173,7 +164,7 @@
<li><a href="index.html">Docs</a> &raquo;</li>
<li>2. Features</li>
<li><span class="section-number">2. </span>Features</li>
<li class="wy-breadcrumbs-aside">
@ -193,43 +184,42 @@
<div itemprop="articleBody">
<div class="section" id="features">
<h1>2. Features<a class="headerlink" href="#features" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">2. </span>Features<a class="headerlink" href="#features" title="Permalink to this headline"></a></h1>
<p>But cdist ticks differently, here is the feature set that makes it unique:</p>
<dl class="docutils">
<dt>Simplicity</dt>
<dd>There is only one type to extend cdist called <strong>type</strong></dd>
<dt>Design</dt>
<dd><ul class="first last simple">
<li>Type and core cleanly separated</li>
<li>Sticks completely to the KISS (keep it simple and stupid) paradigm</li>
<li>Meaningful error messages - do not lose time debugging error messages</li>
<li>Consistency in behaviour, naming and documentation</li>
<li>No surprise factor: Only do what is obviously clear, no magic</li>
<li>Define target state, do not focus on methods or scripts</li>
<li>Push architecture: Instantly apply your changes</li>
<dl class="simple">
<dt>Simplicity</dt><dd><p>There is only one type to extend cdist called <strong>type</strong></p>
</dd>
<dt>Design</dt><dd><ul class="simple">
<li><p>Type and core cleanly separated</p></li>
<li><p>Sticks completely to the KISS (keep it simple and stupid) paradigm</p></li>
<li><p>Meaningful error messages - do not lose time debugging error messages</p></li>
<li><p>Consistency in behaviour, naming and documentation</p></li>
<li><p>No surprise factor: Only do what is obviously clear, no magic</p></li>
<li><p>Define target state, do not focus on methods or scripts</p></li>
<li><p>Push architecture: Instantly apply your changes</p></li>
</ul>
</dd>
<dt>Small core</dt>
<dd>cdist's core is very small - less code, less bugs</dd>
<dt>Fast development</dt>
<dd>Focus on straightforwardness of type creation is a main development objective
Batteries included: A lot of requirements can be solved using standard types</dd>
<dt>Modern Programming Language</dt>
<dd>cdist is written in Python</dd>
<dt>Requirements, Scalability</dt>
<dd>No central server needed, cdist operates in push mode and can be run from any computer</dd>
<dt>Requirements, Scalability, Upgrade</dt>
<dd>cdist only needs to be updated on the master, not on the target hosts</dd>
<dt>Requirements, Security</dt>
<dd>Uses well-know <a class="reference external" href="http://www.openssh.com/">SSH</a> as transport protocol</dd>
<dt>Requirements, Simplicity</dt>
<dd>Requires only shell and SSH server on the target</dd>
<dt>UNIX</dt>
<dd>Reuse of existing tools like cat, find, mv, ...</dd>
<dt>UNIX, familiar environment, documentation</dt>
<dd>Is available as manpages and HTML</dd>
<dt>UNIX, simplicity, familiar environment</dt>
<dd>cdist is configured in POSIX shell</dd>
<dt>Small core</dt><dd><p>cdist's core is very small - less code, less bugs</p>
</dd>
<dt>Fast development</dt><dd><p>Focus on straightforwardness of type creation is a main development objective
Batteries included: A lot of requirements can be solved using standard types</p>
</dd>
<dt>Modern Programming Language</dt><dd><p>cdist is written in Python</p>
</dd>
<dt>Requirements, Scalability</dt><dd><p>No central server needed, cdist operates in push mode and can be run from any computer</p>
</dd>
<dt>Requirements, Scalability, Upgrade</dt><dd><p>cdist only needs to be updated on the master, not on the target hosts</p>
</dd>
<dt>Requirements, Security</dt><dd><p>Uses well-know <a class="reference external" href="http://www.openssh.com/">SSH</a> as transport protocol</p>
</dd>
<dt>Requirements, Simplicity</dt><dd><p>Requires only shell and SSH server on the target</p>
</dd>
<dt>UNIX</dt><dd><p>Reuse of existing tools like cat, find, mv, ...</p>
</dd>
<dt>UNIX, familiar environment, documentation</dt><dd><p>Is available as manpages and HTML</p>
</dd>
<dt>UNIX, simplicity, familiar environment</dt><dd><p>cdist is configured in POSIX shell</p>
</dd>
</dl>
</div>

71
src/extra/manual/beta/cdist-hacker.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>30. Hacking &mdash; cdist 6.5.6 documentation</title>
<title>30. Hacking &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -181,7 +172,7 @@
<li><a href="index.html">Docs</a> &raquo;</li>
<li>30. Hacking</li>
<li><span class="section-number">30. </span>Hacking</li>
<li class="wy-breadcrumbs-aside">
@ -201,9 +192,9 @@
<div itemprop="articleBody">
<div class="section" id="hacking">
<h1>30. Hacking<a class="headerlink" href="#hacking" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">30. </span>Hacking<a class="headerlink" href="#hacking" title="Permalink to this headline"></a></h1>
<div class="section" id="welcome">
<h2>30.1. Welcome<a class="headerlink" href="#welcome" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">30.1. </span>Welcome<a class="headerlink" href="#welcome" title="Permalink to this headline"></a></h2>
<p>Welcome dear hacker! I invite you to a tour of pointers to
get into the usable configuration management system, cdist.</p>
<p>The first thing to know is probably that cdist is brought to
@ -212,53 +203,47 @@ twice before merging or implementing a feature: Less features
with good usability are far better than the opposite.</p>
</div>
<div class="section" id="reporting-bugs">
<h2>30.2. Reporting bugs<a class="headerlink" href="#reporting-bugs" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">30.2. </span>Reporting bugs<a class="headerlink" href="#reporting-bugs" title="Permalink to this headline"></a></h2>
<p>If you believe you've found a bug and verified that it is
in the latest version, drop a mail to the cdist mailing list,
subject prefixed with &quot;[BUG] &quot; or create an issue on code.ungleich.ch.</p>
</div>
<div class="section" id="coding-conventions-everywhere">
<h2>30.3. Coding conventions (everywhere)<a class="headerlink" href="#coding-conventions-everywhere" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">30.3. </span>Coding conventions (everywhere)<a class="headerlink" href="#coding-conventions-everywhere" title="Permalink to this headline"></a></h2>
<p>If something should be improved or needs to be fixed, add the word FIXME
nearby, so grepping for FIXME gives all positions that need to be fixed.</p>
<p>Indentation is 4 spaces (welcome to the python world).</p>
</div>
<div class="section" id="how-to-submit-stuff-for-inclusion-into-upstream-cdist">
<h2>30.4. How to submit stuff for inclusion into upstream cdist<a class="headerlink" href="#how-to-submit-stuff-for-inclusion-into-upstream-cdist" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">30.4. </span>How to submit stuff for inclusion into upstream cdist<a class="headerlink" href="#how-to-submit-stuff-for-inclusion-into-upstream-cdist" title="Permalink to this headline"></a></h2>
<p>If you did some cool changes to cdist, which you think might be of benefit to other
cdist users, you're welcome to propose inclusion into upstream.</p>
<p>There are some requirements to ensure your changes don't break other peoples
work nor kill the authors brain:</p>
<ul>
<li><p class="first">All files should contain the usual header (Author, Copying, etc.)</p>
</li>
<li><p class="first">Code submission must be done via git</p>
</li>
<li><p class="first">Do not add cdist/conf/manifest/init - This file should only be touched in your
private branch!</p>
</li>
<li><p class="first">Code to be included should be branched of the upstream &quot;master&quot; branch</p>
<li><p>All files should contain the usual header (Author, Copying, etc.)</p></li>
<li><p>Code submission must be done via git</p></li>
<li><p>Do not add cdist/conf/manifest/init - This file should only be touched in your
private branch!</p></li>
<li><p>Code to be included should be branched of the upstream &quot;master&quot; branch</p>
<blockquote>
<div><ul class="simple">
<li>Exception: Bugfixes to a version branch</li>
<li><p>Exception: Bugfixes to a version branch</p></li>
</ul>
</div></blockquote>
</li>
<li><p class="first">On a merge request, always name the branch I should pull from</p>
</li>
<li><p class="first">Always ensure <strong>all</strong> manpages build. Use <strong>./build man</strong> to test.</p>
</li>
<li><p class="first">If you developed more than <strong>one</strong> feature, consider submitting them in
<li><p>On a merge request, always name the branch I should pull from</p></li>
<li><p>Always ensure <strong>all</strong> manpages build. Use <strong>./build man</strong> to test.</p></li>
<li><p>If you developed more than <strong>one</strong> feature, consider submitting them in
separate branches. This way one feature can already be included, even if
the other needs to be improved.</p>
</li>
the other needs to be improved.</p></li>
</ul>
<p>As soon as your work meets these requirements, write a mail
for inclusion to the mailinglist <strong>cdist-configuration-management at googlegroups.com</strong>
or open a merge request at <a class="reference external" href="https://code.ungleich.ch/ungleich-public/cdist">https://code.ungleich.ch/ungleich-public/cdist</a>.</p>
</div>
<div class="section" id="how-to-submit-a-new-type">
<h2>30.5. How to submit a new type<a class="headerlink" href="#how-to-submit-a-new-type" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">30.5. </span>How to submit a new type<a class="headerlink" href="#how-to-submit-a-new-type" title="Permalink to this headline"></a></h2>
<p>For detailed information about types, see <a class="reference external" href="cdist-type.html">cdist type</a>.</p>
<p>Submitting a type works as described above, with the additional requirement
that a corresponding manpage named man.rst in ReSTructured text format with
@ -270,9 +255,9 @@ code and thus such a type introduces redundant functionality that is given by
core cdist already.</p>
</div>
<div class="section" id="example-git-workflow">
<h2>30.6. Example git workflow<a class="headerlink" href="#example-git-workflow" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">30.6. </span>Example git workflow<a class="headerlink" href="#example-git-workflow" title="Permalink to this headline"></a></h2>
<p>The following workflow works fine for most developers</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># get latest upstream master branch</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># get latest upstream master branch</span>
git clone https://code.ungleich.ch/ungleich-public/cdist.git
<span class="c1"># update if already existing</span>
@ -316,7 +301,7 @@ git merge origin/master
</div>
<p>If at any point you want to go back to the original master branch, you can
use <strong>git stash</strong> to stash your changes away:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">..</span> <span class="n">code</span><span class="o">-</span><span class="n">block</span><span class="p">::</span> <span class="n">sh</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">..</span> <span class="n">code</span><span class="o">-</span><span class="n">block</span><span class="p">::</span> <span class="n">sh</span>
</pre></div>
</div>
<blockquote>
@ -329,7 +314,7 @@ git merge origin/master</p>
</div></blockquote>
<p>Similarly when you want to develop another new feature, you go back
to the master branch and create another branch based on it:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">..</span> <span class="n">code</span><span class="o">-</span><span class="n">block</span><span class="p">::</span> <span class="n">sh</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">..</span> <span class="n">code</span><span class="o">-</span><span class="n">block</span><span class="p">::</span> <span class="n">sh</span>
</pre></div>
</div>
<blockquote>

91
src/extra/manual/beta/cdist-install.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>4. How to install cdist &mdash; cdist 6.5.6 documentation</title>
<title>4. How to install cdist &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -190,7 +181,7 @@
<li><a href="index.html">Docs</a> &raquo;</li>
<li>4. How to install cdist</li>
<li><span class="section-number">4. </span>How to install cdist</li>
<li class="wy-breadcrumbs-aside">
@ -210,40 +201,40 @@
<div itemprop="articleBody">
<div class="section" id="how-to-install-cdist">
<h1>4. How to install cdist<a class="headerlink" href="#how-to-install-cdist" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">4. </span>How to install cdist<a class="headerlink" href="#how-to-install-cdist" title="Permalink to this headline"></a></h1>
<div class="section" id="requirements">
<h2>4.1. Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">4.1. </span>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline"></a></h2>
<div class="section" id="source-host">
<h3>4.1.1. Source Host<a class="headerlink" href="#source-host" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">4.1.1. </span>Source Host<a class="headerlink" href="#source-host" title="Permalink to this headline"></a></h3>
<p>This is the machine from which you will configure target hosts.</p>
<blockquote>
<div><ul class="simple">
<li>/bin/sh: A posix like shell (for instance bash, dash, zsh)</li>
<li>Python &gt;= 3.2</li>
<li>SSH client</li>
<li>sphinx (for building html docs and/or the man pages)</li>
<li><p>/bin/sh: A POSIX like shell (for instance bash, dash, zsh)</p></li>
<li><p>Python &gt;= 3.5</p></li>
<li><p>SSH client</p></li>
<li><p>sphinx (for building html docs and/or the man pages)</p></li>
</ul>
</div></blockquote>
</div>
<div class="section" id="target-hosts">
<h3>4.1.2. Target Hosts<a class="headerlink" href="#target-hosts" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">4.1.2. </span>Target Hosts<a class="headerlink" href="#target-hosts" title="Permalink to this headline"></a></h3>
<blockquote>
<div><ul class="simple">
<li>/bin/sh: A posix like shell (for instance bash, dash, zsh)</li>
<li>SSH server</li>
<li><p>/bin/sh: A POSIX like shell (for instance bash, dash, zsh)</p></li>
<li><p>SSH server</p></li>
</ul>
</div></blockquote>
</div>
</div>
<div class="section" id="install-cdist">
<h2>4.2. Install cdist<a class="headerlink" href="#install-cdist" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">4.2. </span>Install cdist<a class="headerlink" href="#install-cdist" title="Permalink to this headline"></a></h2>
<div class="section" id="from-git">
<h3>4.2.1. From git<a class="headerlink" href="#from-git" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">4.2.1. </span>From git<a class="headerlink" href="#from-git" title="Permalink to this headline"></a></h3>
<p>Cloning cdist from git gives you the advantage of having
a version control in place for development of your own stuff
immediately.</p>
<p>To install cdist, execute the following commands:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>git clone https://code.ungleich.ch/ungleich-public/cdist.git
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git clone https://code.ungleich.ch/ungleich-public/cdist.git
<span class="nb">cd</span> cdist
<span class="nb">export</span> <span class="nv">PATH</span><span class="o">=</span><span class="nv">$PATH</span>:<span class="k">$(</span><span class="nb">pwd</span> -P<span class="k">)</span>/bin
</pre></div>
@ -254,46 +245,46 @@ It is assumed that you are familiar with <em>git</em> ways of signing and verifi
<p>You can also get cdist from <a class="reference external" href="https://github.com/ungleich/cdist">github mirror</a>.</p>
<p>To install cdist with distutils from cloned repository, first you have to
create version.py:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>./bin/build-helper version
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>./bin/build-helper version
</pre></div>
</div>
<p>Then you install it with:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>make install
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>make install
</pre></div>
</div>
<p>or with:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>make install-user
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>make install-user
</pre></div>
</div>
<p>to install it into user <em>site-packages</em> directory.
Or directly with distutils:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>python setup.py install
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>python setup.py install
</pre></div>
</div>
<p>Note that <cite>bin/build-helper</cite> script is intended for cdist maintainers.</p>
<div class="section" id="available-versions-in-git">
<h4>4.2.1.1. Available versions in git<a class="headerlink" href="#available-versions-in-git" title="Permalink to this headline"></a></h4>
<h4><span class="section-number">4.2.1.1. </span>Available versions in git<a class="headerlink" href="#available-versions-in-git" title="Permalink to this headline"></a></h4>
<blockquote>
<div><ul class="simple">
<li>The active development takes place in the <strong>master</strong> branch</li>
<li>The released versions can be found in the tags</li>
<li><p>The active development takes place in the <strong>master</strong> branch</p></li>
<li><p>The released versions can be found in the tags</p></li>
</ul>
</div></blockquote>
<p>Other branches may be available for features or bugfixes, but they
may vanish at any point. To select a specific branch use</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># Generic code</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Generic code</span>
git checkout -b &lt;localbranchname&gt; origin/&lt;branchname&gt;
</pre></div>
</div>
<p>So for instance if you want to use and stay with version 4.1, you can use</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>git checkout -b <span class="m">4</span>.1 origin/4.1
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git checkout -b <span class="m">4</span>.1 origin/4.1
</pre></div>
</div>
</div>
<div class="section" id="building-and-using-documentation-man-and-html">
<h4>4.2.1.2. Building and using documentation (man and html)<a class="headerlink" href="#building-and-using-documentation-man-and-html" title="Permalink to this headline"></a></h4>
<h4><span class="section-number">4.2.1.2. </span>Building and using documentation (man and html)<a class="headerlink" href="#building-and-using-documentation-man-and-html" title="Permalink to this headline"></a></h4>
<p>If you want to build and use the documentation, run:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>make docs
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>make docs
</pre></div>
</div>
<p>Documentation comes in two formats, man pages and full HTML
@ -301,7 +292,7 @@ documentation. Documentation is built into distribution's
docs/dist directory. man pages are in docs/dist/man and
HTML documentation in docs/dist/html.</p>
<p>If you want to use man pages, run:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="nb">export</span> <span class="nv">MANPATH</span><span class="o">=</span><span class="nv">$MANPATH</span>:<span class="k">$(</span><span class="nb">pwd</span> -P<span class="k">)</span>/docs/dist/man
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span> <span class="nv">MANPATH</span><span class="o">=</span><span class="nv">$MANPATH</span>:<span class="k">$(</span><span class="nb">pwd</span> -P<span class="k">)</span>/docs/dist/man
</pre></div>
</div>
<p>Or you can move man pages from docs/dist/man directory to some
@ -309,20 +300,20 @@ other directory and add it to MANPATH.</p>
<p>Full HTML documentation can be accessed at docs/dist/html/index.html.</p>
<p>You can also build only man pages or only html documentation, for
only man pages run:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>make man
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>make man
</pre></div>
</div>
<p>for only html documentation run:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>make html
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>make html
</pre></div>
</div>
<p>You can also build man pages for types in your ~/.cdist directory:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>make dotman
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>make dotman
</pre></div>
</div>
<p>Built man pages are now in docs/dist/man directory. If you have
some other custom .cdist directory, e.g. /opt/cdist then use:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>make <span class="nv">DOT_CDIST_PATH</span><span class="o">=</span>/opt/cdist dotman
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>make <span class="nv">DOT_CDIST_PATH</span><span class="o">=</span>/opt/cdist dotman
</pre></div>
</div>
<p>Note that <cite>dotman</cite>-target has to be built before a <cite>make docs</cite>-run, otherwise
@ -330,15 +321,15 @@ the custom man-pages are not picked up.</p>
</div>
</div>
<div class="section" id="python-package">
<h3>4.2.2. Python package<a class="headerlink" href="#python-package" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">4.2.2. </span>Python package<a class="headerlink" href="#python-package" title="Permalink to this headline"></a></h3>
<p>Cdist is available as a python package at
<a class="reference external" href="http://pypi.python.org/pypi/cdist/">PyPi</a>. You can install it using</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>pip install cdist
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>pip install cdist
</pre></div>
</div>
</div>
<div class="section" id="installing-from-source-with-signature-verification">
<h3>4.2.3. Installing from source with signature verification<a class="headerlink" href="#installing-from-source-with-signature-verification" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">4.2.3. </span>Installing from source with signature verification<a class="headerlink" href="#installing-from-source-with-signature-verification" title="Permalink to this headline"></a></h3>
<p>If you want to install cdist from signed source and verify it, first you need to
download cdist archive and its detached signature.</p>
<p>Get both, <em>cdist-x.y.z.tar.gz</em> and <em>cdist-x.y.z.tar.gz.asc</em> from release
@ -347,7 +338,7 @@ notes of the desired tag <em>x.y.z</em> at
<p>Get GPG public key used for signing <a class="reference external" href="_static/pgp-key-EFD2AE4EC36B6901.asc">here</a>
and import it into GPG.</p>
<p>Now cdist source archive can be verified using <cite>gpg</cite>, e.g. to verify <cite>cdist-6.2.0</cite>:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>$ gpg --verify cdist-6.2.0.tar.gz.asc cdist-6.2.0.targ.gz
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ gpg --verify cdist-6.2.0.tar.gz.asc cdist-6.2.0.targ.gz
gpg: Signature made Sat Nov <span class="m">30</span> <span class="m">23</span>:14:19 <span class="m">2019</span> CET
gpg: using RSA key 69767822F3ECC3C349C1EFFFEFD2AE4EC36B6901
gpg: Good signature from <span class="s2">&quot;ungleich GmbH (ungleich FOSS) &lt;foss@ungleich.ch&gt;&quot;</span> <span class="o">[</span>ultimate<span class="o">]</span>

37
src/extra/manual/beta/cdist-integration.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>23. cdist integration / using cdist as library &mdash; cdist 6.5.6 documentation</title>
<title>23. cdist integration / using cdist as library &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -177,7 +168,7 @@
<li><a href="index.html">Docs</a> &raquo;</li>
<li>23. cdist integration / using cdist as library</li>
<li><span class="section-number">23. </span>cdist integration / using cdist as library</li>
<li class="wy-breadcrumbs-aside">
@ -197,16 +188,16 @@
<div itemprop="articleBody">
<div class="section" id="cdist-integration-using-cdist-as-library">
<h1>23. cdist integration / using cdist as library<a class="headerlink" href="#cdist-integration-using-cdist-as-library" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">23. </span>cdist integration / using cdist as library<a class="headerlink" href="#cdist-integration-using-cdist-as-library" title="Permalink to this headline"></a></h1>
<div class="section" id="description">
<h2>23.1. Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">23.1. </span>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>cdist can be integrate with other applications by importing cdist and other
cdist modules and setting all by hand. There are also helper functions which
aim to ease this integration. Just import <strong>cdist.integration</strong> and use its
functions:</p>
<ul class="simple">
<li><strong>cdist.integration.configure_hosts_simple</strong> for configuration</li>
<li><strong>cdist.integration.install_hosts_simple</strong> for installation.</li>
<li><p><strong>cdist.integration.configure_hosts_simple</strong> for configuration</p></li>
<li><p><strong>cdist.integration.install_hosts_simple</strong> for installation.</p></li>
</ul>
<p>Functions require <cite>host</cite> and <cite>manifest</cite> parameters.
<cite>host</cite> can be specified as a string representing host or as iterable
@ -219,8 +210,8 @@ find it first from local lib directory and then in PATH.</p>
<p><strong>WARNING</strong>: cdist integration helper functions are not yet stable!</p>
</div>
<div class="section" id="examples">
<h2>23.2. Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># configure host from python interactive shell</span>
<h2><span class="section-number">23.2. </span>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># configure host from python interactive shell</span>
&gt;&gt;&gt; import cdist.integration
&gt;&gt;&gt; cdist.integration.configure_hosts_simple<span class="o">(</span><span class="s1">&#39;185.203.114.185&#39;</span>,
... <span class="s1">&#39;~/.cdist/manifest/init&#39;</span><span class="o">)</span>

47
src/extra/manual/beta/cdist-inventory.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>20. Inventory &mdash; cdist 6.5.6 documentation</title>
<title>20. Inventory &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -182,7 +173,7 @@
<li><a href="index.html">Docs</a> &raquo;</li>
<li>20. Inventory</li>
<li><span class="section-number">20. </span>Inventory</li>
<li class="wy-breadcrumbs-aside">
@ -202,16 +193,16 @@
<div itemprop="articleBody">
<div class="section" id="inventory">
<h1>20. Inventory<a class="headerlink" href="#inventory" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">20. </span>Inventory<a class="headerlink" href="#inventory" title="Permalink to this headline"></a></h1>
<div class="section" id="introduction">
<h2>20.1. Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">20.1. </span>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline"></a></h2>
<p>cdist comes with simple built-in tag based inventory. It is a simple inventory
with list of hosts and a host has a list of tags.
Inventory functionality is still in <strong>beta</strong> so it can be used only if beta
command line flag is specified (-b, --beta) or setting CDIST_BETA env var.</p>
</div>
<div class="section" id="description">
<h2>20.2. Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">20.2. </span>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>The idea is to have simple tagging inventory. There is a list of hosts and for
each host there are tags. Inventory database is a set of files under inventory
database base directory. Filename equals hostname. Each file contains tags for
@ -224,12 +215,12 @@ tags are present.</p>
using cdist inventory interface or using standard UNIX tools.</p>
</div>
<div class="section" id="cdist-inventory-interface">
<h2>20.3. cdist inventory interface<a class="headerlink" href="#cdist-inventory-interface" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">20.3. </span>cdist inventory interface<a class="headerlink" href="#cdist-inventory-interface" title="Permalink to this headline"></a></h2>
<p>With cdist inventory interface you can list host(s) and tag(s), add host(s),
add tag(s), delete host(s) and delete tag(s).</p>
</div>
<div class="section" id="configuring-hosts-using-inventory">
<h2>20.4. Configuring hosts using inventory<a class="headerlink" href="#configuring-hosts-using-inventory" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">20.4. </span>Configuring hosts using inventory<a class="headerlink" href="#configuring-hosts-using-inventory" title="Permalink to this headline"></a></h2>
<p>config command now has new options, <strong>-t</strong>, <strong>-a</strong> and <strong>-A</strong>.</p>
<p><strong>-A</strong> means that all hosts in tag db is selected.</p>
<p><strong>-a</strong> means that selected hosts must contain ALL specified tags.</p>
@ -237,8 +228,8 @@ add tag(s), delete host(s) and delete tag(s).</p>
selected.</p>
</div>
<div class="section" id="examples">
<h2>20.5. Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># List inventory content</span>
<h2><span class="section-number">20.5. </span>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># List inventory content</span>
$ cdist inventory list -b
<span class="c1"># List inventory for specified host localhost</span>
@ -277,8 +268,8 @@ $ cdist config -b -A
</div>
</div>
<div class="section" id="example-of-manipulating-database">
<h2>20.6. Example of manipulating database<a class="headerlink" href="#example-of-manipulating-database" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span>$ python3 scripts/cdist inventory list -b
<h2><span class="section-number">20.6. </span>Example of manipulating database<a class="headerlink" href="#example-of-manipulating-database" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ python3 scripts/cdist inventory list -b
$ python3 scripts/cdist inventory add-host -b localhost
$ python3 scripts/cdist inventory add-host -b test.mycloud.net
$ python3 scripts/cdist inventory list -b
@ -386,14 +377,14 @@ cloud
<p>For more info about inventory commands and options see <a class="reference external" href="man1/cdist.html">cdist</a>(1).</p>
</div>
<div class="section" id="using-external-inventory">
<h2>20.7. Using external inventory<a class="headerlink" href="#using-external-inventory" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">20.7. </span>Using external inventory<a class="headerlink" href="#using-external-inventory" title="Permalink to this headline"></a></h2>
<p>cdist can be used with any external inventory where external inventory is
some storage or database from which you can get a list of hosts to configure.
cdist can then be fed with this list of hosts through stdin or file using
<strong>-f</strong> option. For example, if your host list is stored in sqlite3 database
hosts.db and you want to select hosts which purpose is <strong>django</strong> then you
can use it with cdist like:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>$ sqlite3 hosts.db <span class="s2">&quot;select hostname from hosts where purpose = &#39;django&#39;;&quot;</span> <span class="p">|</span> cdist config
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ sqlite3 hosts.db <span class="s2">&quot;select hostname from hosts where purpose = &#39;django&#39;;&quot;</span> <span class="p">|</span> cdist config
</pre></div>
</div>
</div>

83
src/extra/manual/beta/cdist-manifest.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>14. Manifest &mdash; cdist 6.5.6 documentation</title>
<title>14. Manifest &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -183,7 +174,7 @@
<li><a href="index.html">Docs</a> &raquo;</li>
<li>14. Manifest</li>
<li><span class="section-number">14. </span>Manifest</li>
<li class="wy-breadcrumbs-aside">
@ -203,9 +194,9 @@
<div itemprop="articleBody">
<div class="section" id="manifest">
<h1>14. Manifest<a class="headerlink" href="#manifest" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">14. </span>Manifest<a class="headerlink" href="#manifest" title="Permalink to this headline"></a></h1>
<div class="section" id="description">
<h2>14.1. Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">14.1. </span>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Manifests are used to define which objects to create.
Objects are instances of <strong>types</strong>, like in object oriented programming languages.
An object is represented by the combination of
@ -217,7 +208,7 @@ setup the MANPATH correctly, you can use <strong>man cdist-reference</strong> to
the reference with pointers to the manpages.</p>
<p>Types in manifests are used like normal command line tools. Let's have a look
at an example:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># Create object of type __package with the parameter state = absent</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Create object of type __package with the parameter state = absent</span>
<span class="n">__package</span> <span class="n">apache2</span> <span class="o">--</span><span class="n">state</span> <span class="n">absent</span>
<span class="c1"># Same with the __directory type</span>
@ -234,14 +225,14 @@ the parameters are exactly the same.</p>
on given conditions.</p>
</div>
<div class="section" id="initial-and-type-manifests">
<h2>14.2. Initial and type manifests<a class="headerlink" href="#initial-and-type-manifests" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">14.2. </span>Initial and type manifests<a class="headerlink" href="#initial-and-type-manifests" title="Permalink to this headline"></a></h2>
<p>Cdist knows about two types of manifests: The initial manifest and type
manifests. The initial manifest is used to define, which configurations
to apply to which hosts. The type manifests are used to create objects
from types. More about manifests in types can be found in <a class="reference external" href="cdist-type.html">cdist type</a>.</p>
</div>
<div class="section" id="define-state-in-the-initial-manifest">
<h2>14.3. Define state in the initial manifest<a class="headerlink" href="#define-state-in-the-initial-manifest" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">14.3. </span>Define state in the initial manifest<a class="headerlink" href="#define-state-in-the-initial-manifest" title="Permalink to this headline"></a></h2>
<p>The <strong>initial manifest</strong> is the entry point for cdist to find out, which
<strong>objects</strong> to configure on the selected host.
Cdist expects the initial manifest at <strong>cdist/conf/manifest/init</strong>.</p>
@ -249,7 +240,7 @@ Cdist expects the initial manifest at <strong>cdist/conf/manifest/init</strong>.
created on which host. To distinguish between hosts, you can use the
environment variable <strong>__target_host</strong> and/or <strong>__target_hostname</strong> and/or
<strong>__target_fqdn</strong>. Let's have a look at a simple example:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">__cdistmarker</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">__cdistmarker</span>
<span class="n">case</span> <span class="s2">&quot;$__target_host&quot;</span> <span class="ow">in</span>
<span class="n">localhost</span><span class="p">)</span>
@ -268,13 +259,13 @@ utilises cdist types. Every available type can be executed like a normal
command.</p>
</div>
<div class="section" id="splitting-up-the-initial-manifest">
<h2>14.4. Splitting up the initial manifest<a class="headerlink" href="#splitting-up-the-initial-manifest" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">14.4. </span>Splitting up the initial manifest<a class="headerlink" href="#splitting-up-the-initial-manifest" title="Permalink to this headline"></a></h2>
<p>If you want to split up your initial manifest, you can create other shell
scripts in <strong>cdist/conf/manifest/</strong> and include them in <strong>cdist/conf/manifest/init</strong>.
Cdist provides the environment variable <strong>__manifest</strong> to reference
the directory containing the initial manifest (see <a class="reference external" href="cdist-reference.html">cdist reference</a>).</p>
<p>The following example would include every file with a <strong>.sh</strong> suffix:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span># Include *.sh
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span># Include *.sh
for manifest in $__manifest/*.sh; do
# And source scripts into our shell environment
. &quot;$manifest&quot;
@ -283,11 +274,11 @@ done
</div>
</div>
<div class="section" id="dependencies">
<h2>14.5. Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">14.5. </span>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this headline"></a></h2>
<p>If you want to describe that something requires something else, just
setup the variable &quot;require&quot; to contain the requirements. Multiple
requirements can be added white space separated.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span> <span class="mi">1</span> <span class="c1"># No dependency</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="mi">1</span> <span class="c1"># No dependency</span>
<span class="mi">2</span> <span class="n">__file</span> <span class="o">/</span><span class="n">etc</span><span class="o">/</span><span class="n">cdist</span><span class="o">-</span><span class="n">configured</span>
<span class="mi">3</span>
<span class="mi">4</span> <span class="c1"># Require above object</span>
@ -312,7 +303,7 @@ if necessary before &quot;__link&quot; proceeds (or to abort execution with an e
export the &quot;require&quot; variable as well. But then, if you need to add extra
dependencies to a specific type, you have to make sure that you append these
to the globally already defined one.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># First of all, update the package index</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># First of all, update the package index</span>
<span class="n">__package_update_index</span>
<span class="c1"># Upgrade all the installed packages afterwards</span>
<span class="n">require</span><span class="o">=</span><span class="s2">&quot;__package_update_index&quot;</span> <span class="n">__package_upgrade_all</span>
@ -334,7 +325,7 @@ cdist jargon.</p>
in <a class="reference external" href="cdist-stages.html">cdist execution stages</a> and of how types work in <a class="reference external" href="cdist-type.html">cdist type</a>.</p>
</div>
<div class="section" id="create-dependencies-from-execution-order">
<h2>14.6. Create dependencies from execution order<a class="headerlink" href="#create-dependencies-from-execution-order" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">14.6. </span>Create dependencies from execution order<a class="headerlink" href="#create-dependencies-from-execution-order" title="Permalink to this headline"></a></h2>
<p>You can tell cdist to execute all types in the order in which they are created
in the manifest by setting up the variable CDIST_ORDER_DEPENDENCY.
When cdist sees that this variable is setup, the current created object
@ -351,21 +342,21 @@ is used. When order dependency context is defined then cdist executes types in t
order in which they are created in the manifest inside order dependency context.</p>
<p>Sometimes the best way to see how something works is to see examples.</p>
<p>Suppose you have defined <strong>initial manifest</strong>:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__cycle1 cycle1
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>__cycle1 cycle1
<span class="nb">export</span> <span class="nv">CDIST_ORDER_DEPENDENCY</span><span class="o">=</span><span class="m">1</span>
__cycle2 cycle2
__cycle3 cycle3
</pre></div>
</div>
<p>with types <strong>__cycle1</strong>:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="nb">export</span> <span class="nv">CDIST_ORDER_DEPENDENCY</span><span class="o">=</span><span class="m">1</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span> <span class="nv">CDIST_ORDER_DEPENDENCY</span><span class="o">=</span><span class="m">1</span>
__file /tmp/cycle11
__file /tmp/cycle12
__file /tmp/cycle13
</pre></div>
</div>
<p><strong>__cycle2</strong>:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__file /tmp/cycle21
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>__file /tmp/cycle21
<span class="nb">export</span> <span class="nv">CDIST_ORDER_DEPENDENCY</span><span class="o">=</span><span class="m">1</span>
__file /tmp/cycle22
__file /tmp/cycle23
@ -374,7 +365,7 @@ __file /tmp/cycle24
</pre></div>
</div>
<p><strong>__cycle3</strong>:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__file /tmp/cycle31
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>__file /tmp/cycle31
__file /tmp/cycle32
<span class="nb">export</span> <span class="nv">CDIST_ORDER_DEPENDENCY</span><span class="o">=</span><span class="m">1</span>
__file /tmp/cycle33
@ -383,7 +374,7 @@ __file /tmp/cycle34
</div>
<p>For the above config, cdist results in the following expected <em>dependency graph</em>
(type <em>__cycleX</em> is shown as <em>cX</em>, <em>__file/tmp/cycleXY</em> is shown as <em>fcXY</em>):</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">c1</span><span class="o">----&gt;</span><span class="n">fc11</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">c1</span><span class="o">----&gt;</span><span class="n">fc11</span>
<span class="o">|</span> <span class="o">/</span>\
<span class="o">|</span> <span class="o">|</span>
<span class="o">+-----&gt;</span><span class="n">fc12</span>
@ -416,12 +407,12 @@ __file /tmp/cycle34
</pre></div>
</div>
<p>Before version 6.2.0 the above configuration would result in cycle:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>ERROR: 185.203.112.26: Cycle detected in object dependencies:
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>ERROR: 185.203.112.26: Cycle detected in object dependencies:
__file/tmp/cycle11 -&gt; __cycle3/cycle3 -&gt; __cycle2/cycle2 -&gt; __cycle1/cycle1 -&gt; __file/tmp/cycle11!
</pre></div>
</div>
<p>The following manifest shows an example for order dependency contexts:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__file /tmp/fileA
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>__file /tmp/fileA
<span class="nb">export</span> <span class="nv">CDIST_ORDER_DEPENDENCY</span><span class="o">=</span><span class="m">1</span>
__file /tmp/fileB
__file /tmp/fileC
@ -438,14 +429,14 @@ __file /tmp/fileI
</div>
<p>This means:</p>
<ul class="simple">
<li>C depends on B</li>
<li>D depends on C</li>
<li>H depends on G</li>
<li><p>C depends on B</p></li>
<li><p>D depends on C</p></li>
<li><p>H depends on G</p></li>
</ul>
<p>and there are no other dependencies from this manifest.</p>
</div>
<div class="section" id="overrides">
<h2>14.7. Overrides<a class="headerlink" href="#overrides" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">14.7. </span>Overrides<a class="headerlink" href="#overrides" title="Permalink to this headline"></a></h2>
<p>In some special cases, you would like to create an already defined object
with different parameters. In normal situations this leads to an error in cdist.
If you wish, you can setup the environment variable CDIST_OVERRIDE
@ -459,9 +450,9 @@ CDIST_ORDER_DEPENDENCY will be ignored, because adding a dependency in case of
overrides would result in circular dependencies, which is an error.</p>
</div>
<div class="section" id="examples">
<h2>14.8. Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">14.8. </span>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<p>The initial manifest may for instance contain the following code:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># Always create this file, so other sysadmins know cdist is used.</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Always create this file, so other sysadmins know cdist is used.</span>
__file /etc/cdist-configured
<span class="k">case</span> <span class="s2">&quot;</span><span class="nv">$__target_host</span><span class="s2">&quot;</span> in
@ -473,11 +464,11 @@ __file /etc/cdist-configured
</pre></div>
</div>
<p>The manifest of the type &quot;nologin&quot; may look like this:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__file /etc/nologin --source <span class="s2">&quot;</span><span class="nv">$__type</span><span class="s2">/files/default.nologin&quot;</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>__file /etc/nologin --source <span class="s2">&quot;</span><span class="nv">$__type</span><span class="s2">/files/default.nologin&quot;</span>
</pre></div>
</div>
<p>This example makes use of dependencies:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># Ensure that lighttpd is installed</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Ensure that lighttpd is installed</span>
__package lighttpd --state present
<span class="c1"># Ensure that munin makes use of lighttpd instead of the default webserver</span>
<span class="c1"># package as decided by the package manager</span>
@ -485,7 +476,7 @@ __package lighttpd --state present
</pre></div>
</div>
<p>How to override objects:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># for example in the initial manifest</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># for example in the initial manifest</span>
<span class="c1"># create user account foobar with some hash for password</span>
__user foobar --password <span class="s1">&#39;some_fancy_hash&#39;</span> --home /home/foobarexample
@ -504,7 +495,7 @@ __user foobar --password <span class="s1">&#39;some_other_hash&#39;</span>
</pre></div>
</div>
<p>Dependencies defined by execution order work as following:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># Tells cdist to execute all types in the order in which they are created ...</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Tells cdist to execute all types in the order in which they are created ...</span>
<span class="nb">export</span> <span class="nv">CDIST_ORDER_DEPENDENCY</span><span class="o">=</span>on
__sample_type <span class="m">1</span>
<span class="nv">require</span><span class="o">=</span><span class="s2">&quot;__some_type_somewhere/id&quot;</span> __sample_type <span class="m">2</span>

49
src/extra/manual/beta/cdist-messaging.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>18. Messaging &mdash; cdist 6.5.6 documentation</title>
<title>18. Messaging &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -178,7 +169,7 @@
<li><a href="index.html">Docs</a> &raquo;</li>
<li>18. Messaging</li>
<li><span class="section-number">18. </span>Messaging</li>
<li class="wy-breadcrumbs-aside">
@ -198,9 +189,9 @@
<div itemprop="articleBody">
<div class="section" id="messaging">
<h1>18. Messaging<a class="headerlink" href="#messaging" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">18. </span>Messaging<a class="headerlink" href="#messaging" title="Permalink to this headline"></a></h1>
<div class="section" id="description">
<h2>18.1. Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">18.1. </span>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>cdist has a simple but powerful way of allowing communication between
the initial manifest and types as well as types and types.</p>
<p>Whenever execution is passed from cdist to one of the
@ -218,29 +209,29 @@ between the different objects (see <a class="reference external" href="cdist-man
can only react reliably on messages by objects that you depend on.</p>
</div>
<div class="section" id="availability">
<h2>18.2. Availability<a class="headerlink" href="#availability" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">18.2. </span>Availability<a class="headerlink" href="#availability" title="Permalink to this headline"></a></h2>
<p>Messaging is possible between all <strong>local</strong> scripts:</p>
<ul class="simple">
<li>initial manifest</li>
<li>type/manifest</li>
<li>type/gencode-local</li>
<li>type/gencode-remote</li>
<li><p>initial manifest</p></li>
<li><p>type/manifest</p></li>
<li><p>type/gencode-local</p></li>
<li><p>type/gencode-remote</p></li>
</ul>
</div>
<div class="section" id="examples">
<h2>18.3. Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">18.3. </span>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<p>When you want to emit a message use:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="nb">echo</span> <span class="s2">&quot;something&quot;</span> &gt;&gt; <span class="s2">&quot;</span><span class="nv">$__messages_out</span><span class="s2">&quot;</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nb">echo</span> <span class="s2">&quot;something&quot;</span> &gt;&gt; <span class="s2">&quot;</span><span class="nv">$__messages_out</span><span class="s2">&quot;</span>
</pre></div>
</div>
<p>When you want to react on a message use:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="k">if</span> grep -q <span class="s2">&quot;^__your_type/object/id:something&quot;</span> <span class="s2">&quot;</span><span class="nv">$__messages_in</span><span class="s2">&quot;</span><span class="p">;</span> <span class="k">then</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="k">if</span> grep -q <span class="s2">&quot;^__your_type/object/id:something&quot;</span> <span class="s2">&quot;</span><span class="nv">$__messages_in</span><span class="s2">&quot;</span><span class="p">;</span> <span class="k">then</span>
<span class="nb">echo</span> <span class="s2">&quot;I do something else&quot;</span>
<span class="k">fi</span>
</pre></div>
</div>
<p>Some real life examples:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># Reacting on changes from block for keepalive</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Reacting on changes from block for keepalive</span>
<span class="k">if</span> grep -q <span class="s2">&quot;^__block/keepalive-vrrp&quot;</span> <span class="s2">&quot;</span><span class="nv">$__messages_in</span><span class="s2">&quot;</span><span class="p">;</span> <span class="k">then</span>
<span class="nb">echo</span> /etc/init.d/keepalived restart
<span class="k">fi</span>
@ -252,7 +243,7 @@ can only react reliably on messages by objects that you depend on.</p>
</pre></div>
</div>
<p>Restart sshd on changes</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="nv">os</span><span class="o">=</span><span class="s2">&quot;</span><span class="k">$(</span>cat <span class="s2">&quot;</span><span class="nv">$__global</span><span class="s2">/explorer/os&quot;</span><span class="k">)</span><span class="s2">&quot;</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">os</span><span class="o">=</span><span class="s2">&quot;</span><span class="k">$(</span>cat <span class="s2">&quot;</span><span class="nv">$__global</span><span class="s2">/explorer/os&quot;</span><span class="k">)</span><span class="s2">&quot;</span>
<span class="k">case</span> <span class="s2">&quot;</span><span class="nv">$os</span><span class="s2">&quot;</span> in
centos<span class="p">|</span>redhat<span class="p">|</span>suse<span class="o">)</span>

55
src/extra/manual/beta/cdist-os.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>3. Supported operating systems &mdash; cdist 6.5.6 documentation</title>
<title>3. Supported operating systems &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -173,7 +164,7 @@
<li><a href="index.html">Docs</a> &raquo;</li>
<li>3. Supported operating systems</li>
<li><span class="section-number">3. </span>Supported operating systems</li>
<li class="wy-breadcrumbs-aside">
@ -193,23 +184,23 @@
<div itemprop="articleBody">
<div class="section" id="supported-operating-systems">
<h1>3. Supported operating systems<a class="headerlink" href="#supported-operating-systems" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">3. </span>Supported operating systems<a class="headerlink" href="#supported-operating-systems" title="Permalink to this headline"></a></h1>
<p>cdist was tested or is know to run on at least</p>
<ul class="simple">
<li><a class="reference external" href="https://alpinelinux.org">Alpine Linux</a></li>
<li><a class="reference external" href="http://www.archlinux.org">Archlinux</a></li>
<li><a class="reference external" href="http://www.centos.org">CentOS</a></li>
<li><a class="reference external" href="http://www.debian.org">Debian</a></li>
<li><a class="reference external" href="https://devuan.org">Devuan</a></li>
<li><a class="reference external" href="http://fedoraproject.org">Fedora</a></li>
<li><a class="reference external" href="http://www.freebsd.org">FreeBSD</a></li>
<li><a class="reference external" href="http://www.gentoo.org">Gentoo</a></li>
<li><a class="reference external" href="http://www.apple.com/macosx">Mac OS X</a></li>
<li><a class="reference external" href="https://www.netbsd.org">NetBSD</a></li>
<li><a class="reference external" href="http://www.openbsd.org">OpenBSD</a></li>
<li><a class="reference external" href="http://www.redhat.com">Redhat</a></li>
<li><a class="reference external" href="http://www.ubuntu.com">Ubuntu</a></li>
<li><a class="reference external" href="http://www.citrix.com/xenserver">XenServer</a></li>
<li><p><a class="reference external" href="https://alpinelinux.org">Alpine Linux</a></p></li>
<li><p><a class="reference external" href="http://www.archlinux.org">Archlinux</a></p></li>
<li><p><a class="reference external" href="http://www.centos.org">CentOS</a></p></li>
<li><p><a class="reference external" href="http://www.debian.org">Debian</a></p></li>
<li><p><a class="reference external" href="https://devuan.org">Devuan</a></p></li>
<li><p><a class="reference external" href="http://fedoraproject.org">Fedora</a></p></li>
<li><p><a class="reference external" href="http://www.freebsd.org">FreeBSD</a></p></li>
<li><p><a class="reference external" href="http://www.gentoo.org">Gentoo</a></p></li>
<li><p><a class="reference external" href="http://www.apple.com/macosx">Mac OS X</a></p></li>
<li><p><a class="reference external" href="https://www.netbsd.org">NetBSD</a></p></li>
<li><p><a class="reference external" href="http://www.openbsd.org">OpenBSD</a></p></li>
<li><p><a class="reference external" href="http://www.redhat.com">Redhat</a></p></li>
<li><p><a class="reference external" href="http://www.ubuntu.com">Ubuntu</a></p></li>
<li><p><a class="reference external" href="http://www.citrix.com/xenserver">XenServer</a></p></li>
</ul>
</div>

37
src/extra/manual/beta/cdist-parallelization.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>19. Parallelization &mdash; cdist 6.5.6 documentation</title>
<title>19. Parallelization &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -178,7 +169,7 @@
<li><a href="index.html">Docs</a> &raquo;</li>
<li>19. Parallelization</li>
<li><span class="section-number">19. </span>Parallelization</li>
<li class="wy-breadcrumbs-aside">
@ -198,9 +189,9 @@
<div itemprop="articleBody">
<div class="section" id="parallelization">
<h1>19. Parallelization<a class="headerlink" href="#parallelization" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">19. </span>Parallelization<a class="headerlink" href="#parallelization" title="Permalink to this headline"></a></h1>
<div class="section" id="description">
<h2>19.1. Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">19.1. </span>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>cdist has two modes of parallel operation.</p>
<p>One of them is to operate on each host in separate process. This is enabled
with <strong>-p/--parallel</strong> option.</p>
@ -215,8 +206,8 @@ using specified number of parallel jobs.</p>
<p>For more info on those options see <strong>cdist</strong>(1).</p>
</div>
<div class="section" id="examples">
<h2>19.2. Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># Configure hosts read from file hosts.file in parallel</span>
<h2><span class="section-number">19.2. </span>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Configure hosts read from file hosts.file in parallel</span>
$ cdist config -p -f hosts.file
<span class="c1"># Configure hosts read from file hosts.file sequentially but using default</span>
@ -230,7 +221,7 @@ $ cdist config -j <span class="m">16</span> -p -f hosts.file
</div>
</div>
<div class="section" id="caveats">
<h2>19.3. Caveats<a class="headerlink" href="#caveats" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">19.3. </span>Caveats<a class="headerlink" href="#caveats" title="Permalink to this headline"></a></h2>
<p>When operating in parallel, either by operating in parallel for each host
(-p/--parallel) or by parallel jobs within a host (-j/--jobs), and depending
on target SSH server and its configuration you may encounter connection drops.
@ -242,7 +233,7 @@ This limit is controlled with sshd :strong:MaxSessions configuration
options. For more details refer to <strong>sshd_config</strong>(5).</p>
<p>For example, if you reach <strong>MaxSessions</strong> sessions you may get the
following output:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>$ cdist config -b -j <span class="m">11</span> -v <span class="m">78</span>.47.116.244
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ cdist config -b -j <span class="m">11</span> -v <span class="m">78</span>.47.116.244
INFO: cdist: version <span class="m">4</span>.2.2-55-g640b7f9
INFO: <span class="m">78</span>.47.116.244: Running global explorers
INFO: <span class="m">78</span>.47.116.244: Remote transfer in <span class="m">11</span> parallel <span class="nb">jobs</span>

134
src/extra/manual/beta/cdist-preos.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>22. PreOS &mdash; cdist 6.5.6 documentation</title>
<title>22. PreOS &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -186,7 +177,7 @@
<li><a href="index.html">Docs</a> &raquo;</li>
<li>22. PreOS</li>
<li><span class="section-number">22. </span>PreOS</li>
<li class="wy-breadcrumbs-aside">
@ -206,37 +197,37 @@
<div itemprop="articleBody">
<div class="section" id="preos">
<h1>22. PreOS<a class="headerlink" href="#preos" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">22. </span>PreOS<a class="headerlink" href="#preos" title="Permalink to this headline"></a></h1>
<div class="section" id="description">
<h2>22.1. Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">22.1. </span>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>With cdist you can install and configure new machines. You can use cdist to
create PreOS, minimal OS whose purpose is to boot a new machine.
After PreOS is booted, the machine is ready for installing the desired OS and
afterwards it is ready for configuration.</p>
</div>
<div class="section" id="preos-creation">
<h2>22.2. PreOS creation<a class="headerlink" href="#preos-creation" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">22.2. </span>PreOS creation<a class="headerlink" href="#preos-creation" title="Permalink to this headline"></a></h2>
<p>With cdist you can create PreOS.
Currently supported PreOS-es include:</p>
<ul class="simple">
<li>debian</li>
<li>ubuntu</li>
<li>devuan</li>
<li><p>debian</p></li>
<li><p>ubuntu</p></li>
<li><p>devuan</p></li>
</ul>
<p>PreOS is created using the <code class="docutils literal"><span class="pre">cdist</span> <span class="pre">preos</span></code> command.
<p>PreOS is created using the <code class="docutils literal notranslate"><span class="pre">cdist</span> <span class="pre">preos</span></code> command.
This command has subcommands that determine the desired PreOS.</p>
<p>For example, to create an ubuntu PreOS:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>$ cdist preos ubuntu /preos/preos-ubuntu -B -C <span class="se">\</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ cdist preos ubuntu /preos/preos-ubuntu -B -C <span class="se">\</span>
-k ~/.ssh/id_rsa.pub -p /preos/pxe-ubuntu <span class="se">\</span>
-t <span class="s2">&quot;/usr/bin/curl 192.168.111.5:3000/cdist/install/&quot;</span>
</pre></div>
</div>
<p>For more info about the available options see the cdist manual page.</p>
<p>This will bootstrap (<code class="docutils literal"><span class="pre">-B</span></code>) ubuntu PreOS in <code class="docutils literal"><span class="pre">/preos/preos-ubuntu</span></code> directory, it
will be configured (<code class="docutils literal"><span class="pre">-C</span></code>) using default built-in initial manifest and with
specified ssh authorized key (<code class="docutils literal"><span class="pre">-k</span></code>) and with specified trigger command (<code class="docutils literal"><span class="pre">-t</span></code>).
<p>This will bootstrap (<code class="docutils literal notranslate"><span class="pre">-B</span></code>) ubuntu PreOS in <code class="docutils literal notranslate"><span class="pre">/preos/preos-ubuntu</span></code> directory, it
will be configured (<code class="docutils literal notranslate"><span class="pre">-C</span></code>) using default built-in initial manifest and with
specified ssh authorized key (<code class="docutils literal notranslate"><span class="pre">-k</span></code>) and with specified trigger command (<code class="docutils literal notranslate"><span class="pre">-t</span></code>).
After bootstrapping and configuration PXE
boot directory will be created (<code class="docutils literal"><span class="pre">-p</span></code>) in <code class="docutils literal"><span class="pre">/preos/pxe-ubuntu</span></code>.</p>
boot directory will be created (<code class="docutils literal notranslate"><span class="pre">-p</span></code>) in <code class="docutils literal notranslate"><span class="pre">/preos/pxe-ubuntu</span></code>.</p>
<p>After PreOS is created, new machines can be booted using the created PXE
(after proper dhcp and tftp settings).</p>
<p>Since PreOS is configured with ssh authorized key it can be accessed through
@ -250,45 +241,45 @@ for installation then cdist trigger server will start install command for the
client host using parameters specified at trigger server startup.</p>
</div>
<div class="section" id="implementing-new-preos-sub-command">
<h2>22.3. Implementing new PreOS sub-command<a class="headerlink" href="#implementing-new-preos-sub-command" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">22.3. </span>Implementing new PreOS sub-command<a class="headerlink" href="#implementing-new-preos-sub-command" title="Permalink to this headline"></a></h2>
<p>preos command is implemented as a plugin system. This plugin system scans for
preos subcommands in the <code class="docutils literal"><span class="pre">cdist/preos/</span></code> distribution directory and also in
<code class="docutils literal"><span class="pre">~/.cdist/preos/</span></code> directory if it exists.</p>
preos subcommands in the <code class="docutils literal notranslate"><span class="pre">cdist/preos/</span></code> distribution directory and also in
<code class="docutils literal notranslate"><span class="pre">~/.cdist/preos/</span></code> directory if it exists.</p>
<p>preos subcommand is a module or a class that satisfies the following:</p>
<ul class="simple">
<li>it has the attribute <code class="docutils literal"><span class="pre">_cdist_preos</span></code> set to <code class="docutils literal"><span class="pre">True</span></code></li>
<li>it defines a function/method <code class="docutils literal"><span class="pre">commandline</span></code>.</li>
<li><p>it has the attribute <code class="docutils literal notranslate"><span class="pre">_cdist_preos</span></code> set to <code class="docutils literal notranslate"><span class="pre">True</span></code></p></li>
<li><p>it defines a function/method <code class="docutils literal notranslate"><span class="pre">commandline</span></code>.</p></li>
</ul>
<p>For a module-based preos subcommand, the <code class="docutils literal"><span class="pre">commandline</span></code> function accepts a
<p>For a module-based preos subcommand, the <code class="docutils literal notranslate"><span class="pre">commandline</span></code> function accepts a
module object as its first argument and the list of command line
arguments (<code class="docutils literal"><span class="pre">sys.argv[2:]</span></code>).</p>
<p>For a class-based preos subcommand <code class="docutils literal"><span class="pre">commandline</span></code> method should be
arguments (<code class="docutils literal notranslate"><span class="pre">sys.argv[2:]</span></code>).</p>
<p>For a class-based preos subcommand <code class="docutils literal notranslate"><span class="pre">commandline</span></code> method should be
static-method and must accept a class as its first argument and the
list of command line arguments (<code class="docutils literal"><span class="pre">sys.argv[2:]</span></code>).</p>
<p>If preos scanning finds a module/class that has <code class="docutils literal"><span class="pre">_cdist_preos</span></code> set
to <code class="docutils literal"><span class="pre">True</span></code> and a function/method <code class="docutils literal"><span class="pre">commandline</span></code> then this module/class is
registered to preos subcommands. The name of the command is set to <code class="docutils literal"><span class="pre">_preos_name</span></code>
list of command line arguments (<code class="docutils literal notranslate"><span class="pre">sys.argv[2:]</span></code>).</p>
<p>If preos scanning finds a module/class that has <code class="docutils literal notranslate"><span class="pre">_cdist_preos</span></code> set
to <code class="docutils literal notranslate"><span class="pre">True</span></code> and a function/method <code class="docutils literal notranslate"><span class="pre">commandline</span></code> then this module/class is
registered to preos subcommands. The name of the command is set to <code class="docutils literal notranslate"><span class="pre">_preos_name</span></code>
attribute if defined in the module/class, defaulting to the module/class name in lowercase.
When a registered preos subcommand is specified, <code class="docutils literal"><span class="pre">commandline</span></code>
When a registered preos subcommand is specified, <code class="docutils literal notranslate"><span class="pre">commandline</span></code>
will be called with the first argument set to module/class and the second
argument set to <code class="docutils literal"><span class="pre">sys.argv[2:]</span></code>.</p>
argument set to <code class="docutils literal notranslate"><span class="pre">sys.argv[2:]</span></code>.</p>
<div class="section" id="example-of-writing-new-dummy-preos-sub-command">
<h3>22.3.1. Example of writing new dummy preos sub-command<a class="headerlink" href="#example-of-writing-new-dummy-preos-sub-command" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">22.3.1. </span>Example of writing new dummy preos sub-command<a class="headerlink" href="#example-of-writing-new-dummy-preos-sub-command" title="Permalink to this headline"></a></h3>
<div class="section" id="module-based-preos">
<h4>22.3.1.1. Module-based preos:<a class="headerlink" href="#module-based-preos" title="Permalink to this headline"></a></h4>
<h4><span class="section-number">22.3.1.1. </span>Module-based preos:<a class="headerlink" href="#module-based-preos" title="Permalink to this headline"></a></h4>
<ol class="arabic simple">
<li>Create directory <code class="docutils literal"><span class="pre">~/.cdist/preos/</span></code> if it does not exist</li>
<li>Create <code class="docutils literal"><span class="pre">~/.cdist/preos/netbsd.py</span></code> with the following contents:</li>
<li><p>Create directory <code class="docutils literal notranslate"><span class="pre">~/.cdist/preos/</span></code> if it does not exist</p></li>
<li><p>Create <code class="docutils literal notranslate"><span class="pre">~/.cdist/preos/netbsd.py</span></code> with the following contents:</p></li>
</ol>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">_preos_name</span> <span class="o">=</span> <span class="s1">&#39;netbsd&#39;</span>
<span class="n">_cdist_preos</span> <span class="o">=</span> <span class="bp">True</span>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">_preos_name</span> <span class="o">=</span> <span class="s1">&#39;netbsd&#39;</span>
<span class="n">_cdist_preos</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">def</span> <span class="nf">commandline</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">args</span><span class="p">):</span>
<span class="k">print</span><span class="p">(</span><span class="s2">&quot;NetBSD PreOS: {}&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">args</span><span class="p">))</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;NetBSD PreOS: </span><span class="si">{}</span><span class="s2">&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">args</span><span class="p">))</span>
</pre></div>
</div>
<p>When you try to run this new preos you will get:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>$ cdist preos -L
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ cdist preos -L
Available PreOS-es:
- debian
- devuan
@ -300,21 +291,21 @@ NetBSD PreOS: <span class="o">[]</span>
</div>
</div>
<div class="section" id="class-based-preos">
<h4>22.3.1.2. Class based preos:<a class="headerlink" href="#class-based-preos" title="Permalink to this headline"></a></h4>
<h4><span class="section-number">22.3.1.2. </span>Class based preos:<a class="headerlink" href="#class-based-preos" title="Permalink to this headline"></a></h4>
<ol class="arabic simple">
<li>Create directory <code class="docutils literal"><span class="pre">~/.cdist/preos/</span></code> if it does not exist</li>
<li>Create <code class="docutils literal"><span class="pre">~/.cdist/preos/freebsd.py</span></code> with the following contents:</li>
<li><p>Create directory <code class="docutils literal notranslate"><span class="pre">~/.cdist/preos/</span></code> if it does not exist</p></li>
<li><p>Create <code class="docutils literal notranslate"><span class="pre">~/.cdist/preos/freebsd.py</span></code> with the following contents:</p></li>
</ol>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">FreeBSD</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="n">_cdist_preos</span> <span class="o">=</span> <span class="bp">True</span>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">FreeBSD</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="n">_cdist_preos</span> <span class="o">=</span> <span class="kc">True</span>
<span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">commandline</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">args</span><span class="p">):</span>
<span class="k">print</span><span class="p">(</span><span class="s2">&quot;FreeBSD dummy preos: {}&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">args</span><span class="p">))</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;FreeBSD dummy preos: </span><span class="si">{}</span><span class="s2">&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">args</span><span class="p">))</span>
</pre></div>
</div>
<p>When you try to run this new preos you will get:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>$ cdist preos -h
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ cdist preos -h
Available PreOS-es:
- debian
- devuan
@ -324,42 +315,37 @@ $ cdist preos freebsd
FreeBSD dummy preos: <span class="o">[]</span>
</pre></div>
</div>
<p>In the <code class="docutils literal"><span class="pre">commandline</span></code> function/method you have all the freedom to actually create
<p>In the <code class="docutils literal notranslate"><span class="pre">commandline</span></code> function/method you have all the freedom to actually create
a PreOS.</p>
</div>
</div>
</div>
<div class="section" id="simple-tipical-use-case-for-using-preos-and-trigger">
<h2>22.4. Simple tipical use case for using PreOS and trigger<a class="headerlink" href="#simple-tipical-use-case-for-using-preos-and-trigger" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">22.4. </span>Simple tipical use case for using PreOS and trigger<a class="headerlink" href="#simple-tipical-use-case-for-using-preos-and-trigger" title="Permalink to this headline"></a></h2>
<p>Tipical use case for using PreOS and trigger command include the following steps.</p>
<ol class="arabic">
<li><p class="first">Create PreOS PXE with ssh key and trigger command for installation.</p>
<li><p>Create PreOS PXE with ssh key and trigger command for installation.</p>
<blockquote>
<div><div class="highlight-sh"><div class="highlight"><pre><span></span>$ cdist preos ubuntu /preos/ubuntu -b -C <span class="se">\</span>
<div><div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ cdist preos ubuntu /preos/ubuntu -b -C <span class="se">\</span>
-k ~/.ssh/id_rsa.pub -p /preos/pxe <span class="se">\</span>
-t <span class="s2">&quot;/usr/bin/curl 192.168.111.5:3000/cdist/install/&quot;</span>
</pre></div>
</div>
</div></blockquote>
</li>
<li><p class="first">Configure dhcp server and tftp server.</p>
</li>
<li><p class="first">On cdist host (192.168.111.5 from above) start trigger command (it will use
<li><p>Configure dhcp server and tftp server.</p></li>
<li><p>On cdist host (192.168.111.5 from above) start trigger command (it will use
default init manifest for installation).</p>
<blockquote>
<div><div class="highlight-sh"><div class="highlight"><pre><span></span>$ cdist trigger -b -v
<div><div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ cdist trigger -b -v
</pre></div>
</div>
</div></blockquote>
</li>
<li><p class="first">After all is set up start new machines (PXE boot).</p>
</li>
<li><p class="first">New machine boots and executes trigger command, i.e. triggers installation.</p>
</li>
<li><p class="first">Cdist trigger server starts installing host that has triggered it.</p>
</li>
<li><p class="first">After cdist install is finished new host is installed.</p>
</li>
<li><p>After all is set up start new machines (PXE boot).</p></li>
<li><p>New machine boots and executes trigger command, i.e. triggers installation.</p></li>
<li><p>Cdist trigger server starts installing host that has triggered it.</p></li>
<li><p>After cdist install is finished new host is installed.</p></li>
</ol>
</div>
</div>

35
src/extra/manual/beta/cdist-quickstart.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>7. Quickstart &mdash; cdist 6.5.6 documentation</title>
<title>7. Quickstart &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -173,7 +164,7 @@
<li><a href="index.html">Docs</a> &raquo;</li>
<li>7. Quickstart</li>
<li><span class="section-number">7. </span>Quickstart</li>
<li class="wy-breadcrumbs-aside">
@ -193,7 +184,7 @@
<div itemprop="articleBody">
<div class="section" id="quickstart">
<h1>7. Quickstart<a class="headerlink" href="#quickstart" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">7. </span>Quickstart<a class="headerlink" href="#quickstart" title="Permalink to this headline"></a></h1>
<p>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.</p>
@ -209,7 +200,7 @@ and usually logs into the <strong>target host</strong> as the
of the target host to allow root logins: Edit
the file <strong>/etc/ssh/sshd_config</strong> and add one of the following
lines:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># Allow login only via public key</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Allow login only via public key</span>
<span class="n">PermitRootLogin</span> <span class="n">without</span><span class="o">-</span><span class="n">password</span>
<span class="c1"># Allow login via password and public key</span>
@ -218,7 +209,7 @@ lines:</p>
</div>
<p>As cdist uses ssh intensively, it is recommended to setup authentication
with public keys:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># Generate pubkey pair as a normal user</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Generate pubkey pair as a normal user</span>
<span class="n">ssh</span><span class="o">-</span><span class="n">keygen</span>
<span class="c1"># Copy pubkey over to target host</span>
@ -227,7 +218,7 @@ with public keys:</p>
</div>
<p>Have a look at ssh-agent(1) and ssh-add(1) on how to cache the password for
your public key. Usually it looks like this:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span># Start agent and export variables
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span># Start agent and export variables
eval `ssh-agent`
# Add keys (requires password for every identity file)
@ -241,7 +232,7 @@ documentation.</p>
<p>As soon as you are able to login without password to localhost,
we can use cdist to configure it. You can copy and paste the following
code into your shell to get started and configure localhost:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># Get cdist</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Get cdist</span>
<span class="n">git</span> <span class="n">clone</span> <span class="n">git</span><span class="nd">@code</span><span class="o">.</span><span class="n">ungleich</span><span class="o">.</span><span class="n">ch</span><span class="p">:</span><span class="n">ungleich</span><span class="o">-</span><span class="n">public</span><span class="o">/</span><span class="n">cdist</span><span class="o">.</span><span class="n">git</span>
<span class="c1"># Create manifest (maps configuration to host(s)</span>

149
src/extra/manual/beta/cdist-real-world.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>8. Dive into real world cdist &mdash; cdist 6.5.6 documentation</title>
<title>8. Dive into real world cdist &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -126,7 +117,7 @@
<li class="toctree-l2"><a class="reference internal" href="#creating-python-bottle-application">8.9. Creating python bottle application</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#preparing-database">8.9.1. Preparing database</a></li>
<li class="toctree-l3"><a class="reference internal" href="#creating-application">8.9.2. Creating application</a></li>
<li class="toctree-l3"><a class="reference internal" href="#openning-application">8.9.3. Openning application</a></li>
<li class="toctree-l3"><a class="reference internal" href="#opening-application">8.9.3. Opening application</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#what-s-next">8.10. What's next?</a></li>
@ -200,7 +191,7 @@
<li><a href="index.html">Docs</a> &raquo;</li>
<li>8. Dive into real world cdist</li>
<li><span class="section-number">8. </span>Dive into real world cdist</li>
<li class="wy-breadcrumbs-aside">
@ -220,9 +211,9 @@
<div itemprop="articleBody">
<div class="section" id="dive-into-real-world-cdist">
<h1>8. Dive into real world cdist<a class="headerlink" href="#dive-into-real-world-cdist" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">8. </span>Dive into real world cdist<a class="headerlink" href="#dive-into-real-world-cdist" title="Permalink to this headline"></a></h1>
<div class="section" id="introduction">
<h2>8.1. Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">8.1. </span>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline"></a></h2>
<p>This walkthrough shows real world cdist configuration example.</p>
<p>Sample target host is named <strong>test.ungleich.ch</strong>.
Just replace <strong>test.ungleich.ch</strong> with your target hostname.</p>
@ -235,12 +226,12 @@ For HTTPS we will use Let's Encrypt certificate.</p>
<p>For setting up hosting we want to use cdist so we will write a new type
for that. This type will:</p>
<ul class="simple">
<li>install required packages</li>
<li>create OS user, user home directory and application home directory</li>
<li>create PostgreSQL database</li>
<li>configure uWSGI</li>
<li>configure Let's Encrypt certificate</li>
<li>configure nginx.</li>
<li><p>install required packages</p></li>
<li><p>create OS user, user home directory and application home directory</p></li>
<li><p>create PostgreSQL database</p></li>
<li><p>configure uWSGI</p></li>
<li><p>configure Let's Encrypt certificate</p></li>
<li><p>configure nginx.</p></li>
</ul>
<p>Our type will not create the actual python application. Its intention is only
to configure hosting for specified user and project. It is up to the user to
@ -248,11 +239,11 @@ create his/her applications.</p>
<p>So let's start.</p>
</div>
<div class="section" id="creating-type-layout">
<h2>8.2. Creating type layout<a class="headerlink" href="#creating-type-layout" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">8.2. </span>Creating type layout<a class="headerlink" href="#creating-type-layout" title="Permalink to this headline"></a></h2>
<p>We will create a new custom type. Let's call it <strong>__sample_bottle_hosting</strong>.</p>
<p>Go to <strong>~/.cdist/type</strong> directory (create it if it does not exist) and create
new type layout:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">~/.</span><span class="n">cdist</span><span class="o">/</span><span class="nb">type</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">~/.</span><span class="n">cdist</span><span class="o">/</span><span class="nb">type</span>
<span class="n">mkdir</span> <span class="n">__sample_bottle_hosting</span>
<span class="n">cd</span> <span class="n">__sample_bottle_hosting</span>
<span class="n">touch</span> <span class="n">manifest</span> <span class="n">gencode</span><span class="o">-</span><span class="n">remote</span>
@ -262,20 +253,20 @@ new type layout:</p>
</div>
</div>
<div class="section" id="creating-sample-bottle-hosting-type-parameters">
<h2>8.3. Creating __sample_bottle_hosting type parameters<a class="headerlink" href="#creating-sample-bottle-hosting-type-parameters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">8.3. </span>Creating __sample_bottle_hosting type parameters<a class="headerlink" href="#creating-sample-bottle-hosting-type-parameters" title="Permalink to this headline"></a></h2>
<p>Our type will be configurable through the means of parameters. Let's define
the following parameters:</p>
<dl class="docutils">
<dt>projectname</dt>
<dd>name for the project, needed for uWSGI ini file</dd>
<dt>user</dt>
<dd>user name</dd>
<dt>domain</dt>
<dd>target host domain, needed for Let's Encrypt certificate.</dd>
<dl class="simple">
<dt>projectname</dt><dd><p>name for the project, needed for uWSGI ini file</p>
</dd>
<dt>user</dt><dd><p>user name</p>
</dd>
<dt>domain</dt><dd><p>target host domain, needed for Let's Encrypt certificate.</p>
</dd>
</dl>
<p>We define parameters to make our type reusable for different projects, user and domain.</p>
<p>Define required parameters:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">printf</span> <span class="s2">&quot;projectname</span><span class="se">\n</span><span class="s2">&quot;</span> <span class="o">&gt;&gt;</span> <span class="n">parameter</span><span class="o">/</span><span class="n">required</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">printf</span> <span class="s2">&quot;projectname</span><span class="se">\n</span><span class="s2">&quot;</span> <span class="o">&gt;&gt;</span> <span class="n">parameter</span><span class="o">/</span><span class="n">required</span>
<span class="n">printf</span> <span class="s2">&quot;user</span><span class="se">\n</span><span class="s2">&quot;</span> <span class="o">&gt;&gt;</span> <span class="n">parameter</span><span class="o">/</span><span class="n">required</span>
<span class="n">printf</span> <span class="s2">&quot;domain</span><span class="se">\n</span><span class="s2">&quot;</span> <span class="o">&gt;&gt;</span> <span class="n">parameter</span><span class="o">/</span><span class="n">required</span>
</pre></div>
@ -283,12 +274,12 @@ the following parameters:</p>
<p>For details on type parameters see <a class="reference external" href="cdist-type.html#defining-parameters">Defining parameters</a>.</p>
</div>
<div class="section" id="creating-sample-bottle-hosting-type-manifest">
<h2>8.4. Creating __sample_bottle_hosting type manifest<a class="headerlink" href="#creating-sample-bottle-hosting-type-manifest" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">8.4. </span>Creating __sample_bottle_hosting type manifest<a class="headerlink" href="#creating-sample-bottle-hosting-type-manifest" title="Permalink to this headline"></a></h2>
<p>Next step is to define manifest (~/.cdist/type/__sample_bottle_hosting/manifest).
We also want our type to currently support only Devuan. So we will start by
checking target host OS. We will use <a class="reference external" href="cdist-reference.html#explorers">os</a>
global explorer:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>os=$(cat &quot;$__global/explorer/os&quot;)
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>os=$(cat &quot;$__global/explorer/os&quot;)
case &quot;$os&quot; in
devuan)
@ -309,10 +300,10 @@ configuration locations (e.g. nginx config directory could be in /usr/local tree
If we detected unsupported OS we should error out. cdist will stop configuration
process and output error message.</p>
<div class="section" id="creating-user-and-user-directories">
<h3>8.4.1. Creating user and user directories<a class="headerlink" href="#creating-user-and-user-directories" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">8.4.1. </span>Creating user and user directories<a class="headerlink" href="#creating-user-and-user-directories" title="Permalink to this headline"></a></h3>
<p>Then we create user and his/her home directory and application home directory.
We will use existing cdist types <a class="reference external" href="man7/cdist-type__user.html">__user</a> and <a class="reference external" href="man7/cdist-type__directory.html">__directory</a>:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>user=&quot;$(cat &quot;$__object/parameter/user&quot;)&quot;
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>user=&quot;$(cat &quot;$__object/parameter/user&quot;)&quot;
home=&quot;/home/$user&quot;
apphome=&quot;$home/app&quot;
@ -333,11 +324,11 @@ home directory is created <strong>after</strong> both user and user home directo
For details on <strong>require</strong> see <a class="reference external" href="cdist-manifest.html#dependencies">Dependencies</a>.</p>
</div>
<div class="section" id="installing-packages">
<h3>8.4.2. Installing packages<a class="headerlink" href="#installing-packages" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">8.4.2. </span>Installing packages<a class="headerlink" href="#installing-packages" title="Permalink to this headline"></a></h3>
<p>Install required packages using existing <a class="reference external" href="man7/cdist-type__package.html">__package</a> type.
Before installing package we want to update apt package index using
<a class="reference external" href="man7/cdist-type__apt_update_index.html">__apt_update_index</a>:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span># define packages that need to be installed
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span># define packages that need to be installed
packages_to_install=&quot;nginx uwsgi-plugin-python3 python3-dev python3-pip postgresql postgresql-contrib libpq-dev python3-venv uwsgi python3-psycopg2&quot;
# update package index
@ -353,7 +344,7 @@ for each member in a list we define in <strong>packages_to_install</strong> vari
This is much nicer then having as many <strong>require=&quot;__apt_update_index&quot; __package</strong>
lines as there are packages we want to install.</p>
<p>For python packages we use <a class="reference external" href="man7/cdist-type__package_pip.html">__package_pip</a>:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span># install pip3 packages
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span># install pip3 packages
for package in bottle bottle-pgsql; do
__package_pip --pip pip3 $package
done
@ -361,10 +352,10 @@ done
</div>
</div>
<div class="section" id="creating-postgresql-database">
<h3>8.4.3. Creating PostgreSQL database<a class="headerlink" href="#creating-postgresql-database" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">8.4.3. </span>Creating PostgreSQL database<a class="headerlink" href="#creating-postgresql-database" title="Permalink to this headline"></a></h3>
<p>Create PostgreSQL database using <a class="reference external" href="man7/cdist-type__postgres_database.html">__postgres_database</a>
and <a class="reference external" href="man7/cdist-type__postgres_role.html">__postgres_role</a> for creating database user:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>#PostgreSQL db &amp; user
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>#PostgreSQL db &amp; user
postgres_server=postgresql
# create PostgreSQL db user
@ -376,9 +367,9 @@ require=&quot;__postgres_role/$user __package/postgresql&quot; __postgres_databa
</div>
</div>
<div class="section" id="configuring-uwsgi">
<h3>8.4.4. Configuring uWSGI<a class="headerlink" href="#configuring-uwsgi" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">8.4.4. </span>Configuring uWSGI<a class="headerlink" href="#configuring-uwsgi" title="Permalink to this headline"></a></h3>
<p>Configure uWSGI using <a class="reference external" href="man7/cdist-type__file.html">__file</a> type:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span># configure uWSGI
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span># configure uWSGI
projectname=&quot;$(cat &quot;$__object/parameter/projectname&quot;)&quot;
require=&quot;__package/uwsgi&quot; __file /etc/uwsgi/apps-enabled/$user.ini \
--owner root --group root --mode 0644 \
@ -403,29 +394,29 @@ EOF
Installation of uWSGI also creates configuration layout: <strong>/etc/uwsgi/apps-enabled</strong>.
If this directory does not exist then <strong>__file</strong> type would error.
We also use stdin as file content source. For details see <a class="reference external" href="cdist-type.html#input-from-stdin">Input from stdin</a>.
For feading stdin we use here-document (<strong>&lt;&lt;</strong> operator). It allows redirection of subsequent
For feeding stdin we use here-document (<strong>&lt;&lt;</strong> operator). It allows redirection of subsequent
lines read by the shell to the input of a command until a line containing only the delimiter
and a newline, with no blank characters in between (EOF in our case).</p>
</div>
<div class="section" id="configuring-nginx-for-let-s-encrypt-and-https-redirection">
<h3>8.4.5. Configuring nginx for Let's Encrypt and HTTPS redirection<a class="headerlink" href="#configuring-nginx-for-let-s-encrypt-and-https-redirection" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">8.4.5. </span>Configuring nginx for Let's Encrypt and HTTPS redirection<a class="headerlink" href="#configuring-nginx-for-let-s-encrypt-and-https-redirection" title="Permalink to this headline"></a></h3>
<p>Next configure nginx for Let's Encrypt and for HTTP -&gt; HTTPS redirection. For this
purpose we will create new type <strong>__sample_nginx_http_letsencrypt_and_ssl_redirect</strong>
and use it here:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>domain=&quot;$(cat &quot;$__object/parameter/domain&quot;)&quot;
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>domain=&quot;$(cat &quot;$__object/parameter/domain&quot;)&quot;
webroot=&quot;/var/www/html&quot;
__sample_nginx_http_letsencrypt_and_ssl_redirect &quot;$domain&quot; --webroot &quot;$webroot&quot;
</pre></div>
</div>
</div>
<div class="section" id="configuring-certificate-creation">
<h3>8.4.6. Configuring certificate creation<a class="headerlink" href="#configuring-certificate-creation" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">8.4.6. </span>Configuring certificate creation<a class="headerlink" href="#configuring-certificate-creation" title="Permalink to this headline"></a></h3>
<p>After HTTP nginx configuration we will create Let's Encrypt certificate using
<a class="reference external" href="man7/cdist-type__letsencrypt_cert.html">__letsencrypt_cert</a> type.
For Let's Encrypt cert configuration ensure that there is a DNS entry for your
domain. We assure that cert creation is applied after nginx HTTP is configured
for Let's Encrypt to work:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># create SSL cert</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># create SSL cert</span>
<span class="n">require</span><span class="o">=</span><span class="s2">&quot;__package/nginx __sample_nginx_http_letsencrypt_and_ssl_redirect/$domain&quot;</span> \
<span class="n">__letsencrypt_cert</span> <span class="o">--</span><span class="n">admin</span><span class="o">-</span><span class="n">email</span> <span class="n">admin</span><span class="nd">@test</span><span class="o">.</span><span class="n">ungleich</span><span class="o">.</span><span class="n">ch</span> \
<span class="o">--</span><span class="n">webroot</span> <span class="s2">&quot;$webroot&quot;</span> \
@ -437,9 +428,9 @@ for Let's Encrypt to work:</p>
</div>
</div>
<div class="section" id="configuring-nginx-https-server-with-uwsgi-upstream">
<h3>8.4.7. Configuring nginx HTTPS server with uWSGI upstream<a class="headerlink" href="#configuring-nginx-https-server-with-uwsgi-upstream" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">8.4.7. </span>Configuring nginx HTTPS server with uWSGI upstream<a class="headerlink" href="#configuring-nginx-https-server-with-uwsgi-upstream" title="Permalink to this headline"></a></h3>
<p>Then we can configure nginx HTTPS server that will use created Let's Encrypt certificate:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span># configure nginx
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span># configure nginx
require=&quot;__package/nginx __letsencrypt_cert/$domain&quot; \
__file &quot;/etc/nginx/sites-enabled/https-$domain&quot; \
--source - --mode 0644 &lt;&lt; EOF
@ -476,10 +467,10 @@ EOF
<p>Now our manifest is finished.</p>
</div>
<div class="section" id="complete-sample-bottle-hosting-type-manifest-listing">
<h3>8.4.8. Complete __sample_bottle_hosting type manifest listing<a class="headerlink" href="#complete-sample-bottle-hosting-type-manifest-listing" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">8.4.8. </span>Complete __sample_bottle_hosting type manifest listing<a class="headerlink" href="#complete-sample-bottle-hosting-type-manifest-listing" title="Permalink to this headline"></a></h3>
<p>Here is complete __sample_bottle_hosting type manifest listing,
located in ~/.cdist/type/__sample_bottle_hosting/manifest:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>#!/bin/sh
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>#!/bin/sh
os=$(cat &quot;$__global/explorer/os&quot;)
@ -600,20 +591,20 @@ EOF
</div>
</div>
<div class="section" id="creating-sample-bottle-hosting-type-gencode-remote">
<h2>8.5. Creating __sample_bottle_hosting type gencode-remote<a class="headerlink" href="#creating-sample-bottle-hosting-type-gencode-remote" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">8.5. </span>Creating __sample_bottle_hosting type gencode-remote<a class="headerlink" href="#creating-sample-bottle-hosting-type-gencode-remote" title="Permalink to this headline"></a></h2>
<p>Now define <strong>gencode-remote</strong> script: ~/.cdist/type/__sample_bottle_hosting/gencode-remote.
After manifest is applied it should restart uWSGI and nginx services so that our
configuration is active. Our gencode-remote looks like the following:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">echo</span> <span class="s2">&quot;service uwsgi restart&quot;</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">echo</span> <span class="s2">&quot;service uwsgi restart&quot;</span>
<span class="n">echo</span> <span class="s2">&quot;service nginx restart&quot;</span>
</pre></div>
</div>
<p>Our <strong>__sample_bottle_hosting</strong> type is now finished.</p>
</div>
<div class="section" id="creating-sample-nginx-http-letsencrypt-and-ssl-redirect-type">
<h2>8.6. Creating __sample_nginx_http_letsencrypt_and_ssl_redirect type<a class="headerlink" href="#creating-sample-nginx-http-letsencrypt-and-ssl-redirect-type" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">8.6. </span>Creating __sample_nginx_http_letsencrypt_and_ssl_redirect type<a class="headerlink" href="#creating-sample-nginx-http-letsencrypt-and-ssl-redirect-type" title="Permalink to this headline"></a></h2>
<p>Let's now create <strong>__sample_nginx_http_letsencrypt_and_ssl_redirect</strong> type:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">~/.</span><span class="n">cdist</span><span class="o">/</span><span class="nb">type</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">~/.</span><span class="n">cdist</span><span class="o">/</span><span class="nb">type</span>
<span class="n">mkdir</span> <span class="n">__sample_nginx_http_letsencrypt_and_ssl_redirect</span>
<span class="n">cd</span> <span class="n">__sample_nginx_http_letsencrypt_and_ssl_redirect</span>
<span class="n">mkdir</span> <span class="n">parameter</span>
@ -623,7 +614,7 @@ configuration is active. Our gencode-remote looks like the following:</p>
</pre></div>
</div>
<p>Edit manifest:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>domain=&quot;$__object_id&quot;
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>domain=&quot;$__object_id&quot;
webroot=&quot;$(cat &quot;$__object/parameter/webroot&quot;)&quot;
# make sure we have nginx package
__package nginx
@ -651,14 +642,14 @@ EOF
</pre></div>
</div>
<p>Edit gencode-remote:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">echo</span> <span class="s2">&quot;service nginx reload&quot;</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">echo</span> <span class="s2">&quot;service nginx reload&quot;</span>
</pre></div>
</div>
</div>
<div class="section" id="creating-init-manifest">
<h2>8.7. Creating init manifest<a class="headerlink" href="#creating-init-manifest" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">8.7. </span>Creating init manifest<a class="headerlink" href="#creating-init-manifest" title="Permalink to this headline"></a></h2>
<p>Next create init manifest:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">~/.</span><span class="n">cdist</span><span class="o">/</span><span class="n">manifest</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">~/.</span><span class="n">cdist</span><span class="o">/</span><span class="n">manifest</span>
<span class="n">printf</span> <span class="s2">&quot;__sample_bottle_hosting --projectname sample --user app --domain \$__target_host sample</span><span class="se">\n</span><span class="s2">&quot;</span> <span class="o">&gt;</span> <span class="n">sample</span>
</pre></div>
</div>
@ -670,28 +661,28 @@ Here the last positional argument <em>sample</em> is type's object id. For detai
reference.</p>
</div>
<div class="section" id="configuring-host">
<h2>8.8. Configuring host<a class="headerlink" href="#configuring-host" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">8.8. </span>Configuring host<a class="headerlink" href="#configuring-host" title="Permalink to this headline"></a></h2>
<p>Finally configure test.ungleich.ch:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cdist</span> <span class="n">config</span> <span class="o">-</span><span class="n">v</span> <span class="o">-</span><span class="n">i</span> <span class="o">~/.</span><span class="n">cdist</span><span class="o">/</span><span class="n">manifest</span><span class="o">/</span><span class="n">sample</span> <span class="n">test</span><span class="o">.</span><span class="n">ungleich</span><span class="o">.</span><span class="n">ch</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cdist</span> <span class="n">config</span> <span class="o">-</span><span class="n">v</span> <span class="o">-</span><span class="n">i</span> <span class="o">~/.</span><span class="n">cdist</span><span class="o">/</span><span class="n">manifest</span><span class="o">/</span><span class="n">sample</span> <span class="n">test</span><span class="o">.</span><span class="n">ungleich</span><span class="o">.</span><span class="n">ch</span>
</pre></div>
</div>
<p>After cdist configuration is successfully finished our host is ready.</p>
</div>
<div class="section" id="creating-python-bottle-application">
<h2>8.9. Creating python bottle application<a class="headerlink" href="#creating-python-bottle-application" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">8.9. </span>Creating python bottle application<a class="headerlink" href="#creating-python-bottle-application" title="Permalink to this headline"></a></h2>
<p>We now need to create Bottle application. As you remember from the beginning
of this walkthrough our type does not create the actual python application,
its intention is only to configure hosting for specified user and project.
It is up to the user to create his/her applications.</p>
<p>Become app user:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">su</span> <span class="o">-</span><span class="n">l</span> <span class="n">app</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">su</span> <span class="o">-</span><span class="n">l</span> <span class="n">app</span>
</pre></div>
</div>
<div class="section" id="preparing-database">
<h3>8.9.1. Preparing database<a class="headerlink" href="#preparing-database" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">8.9.1. </span>Preparing database<a class="headerlink" href="#preparing-database" title="Permalink to this headline"></a></h3>
<p>We need to prepare database for our application. Create table and
insert some items:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">psql</span> <span class="o">-</span><span class="n">c</span> <span class="s2">&quot;create table items (item varchar(255));&quot;</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">psql</span> <span class="o">-</span><span class="n">c</span> <span class="s2">&quot;create table items (item varchar(255));&quot;</span>
<span class="n">psql</span> <span class="o">-</span><span class="n">c</span> <span class="s2">&quot;insert into items(item) values(&#39;spam&#39;);&quot;</span>
<span class="n">psql</span> <span class="o">-</span><span class="n">c</span> <span class="s2">&quot;insert into items(item) values(&#39;eggs&#39;);&quot;</span>
@ -700,15 +691,15 @@ insert some items:</p>
</div>
</div>
<div class="section" id="creating-application">
<h3>8.9.2. Creating application<a class="headerlink" href="#creating-application" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">8.9.2. </span>Creating application<a class="headerlink" href="#creating-application" title="Permalink to this headline"></a></h3>
<p>Next create sample app:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">/</span><span class="n">home</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">app</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">/</span><span class="n">home</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">app</span>
<span class="n">mkdir</span> <span class="n">sample</span>
<span class="n">cd</span> <span class="n">sample</span>
</pre></div>
</div>
<p>Create app.py with the following content:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="ch">#!/usr/bin/env python3</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="ch">#!/usr/bin/env python3</span>
<span class="kn">import</span> <span class="nn">bottle</span>
<span class="kn">import</span> <span class="nn">bottle_pgsql</span>
@ -732,7 +723,7 @@ insert some items:</p>
</pre></div>
</div>
<p>Create wsgi.py with the following content:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">os</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">os</span>
<span class="n">os</span><span class="o">.</span><span class="n">chdir</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="vm">__file__</span><span class="p">))</span>
@ -744,10 +735,10 @@ insert some items:</p>
we have changed our <strong>wsgi.py</strong> file uWSGI reloads the application.</p>
<p>Our application selects and lists items from <strong>items</strong> table.</p>
</div>
<div class="section" id="openning-application">
<h3>8.9.3. Openning application<a class="headerlink" href="#openning-application" title="Permalink to this headline"></a></h3>
<div class="section" id="opening-application">
<h3><span class="section-number">8.9.3. </span>Opening application<a class="headerlink" href="#opening-application" title="Permalink to this headline"></a></h3>
<p>Finally try the application:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">test</span><span class="o">.</span><span class="n">ungleich</span><span class="o">.</span><span class="n">ch</span><span class="o">/</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">test</span><span class="o">.</span><span class="n">ungleich</span><span class="o">.</span><span class="n">ch</span><span class="o">/</span>
</pre></div>
</div>
<p>It should redirect to HTTPS and return:</p>
@ -762,7 +753,7 @@ we have changed our <strong>wsgi.py</strong> file uWSGI reloads the application.
</div>
</div>
<div class="section" id="what-s-next">
<h2>8.10. What's next?<a class="headerlink" href="#what-s-next" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">8.10. </span>What's next?<a class="headerlink" href="#what-s-next" title="Permalink to this headline"></a></h2>
<p>Continue reading next sections ;)</p>
</div>
</div>

821
src/extra/manual/beta/cdist-reference.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>24. Reference &mdash; cdist 6.5.6 documentation</title>
<title>24. Reference &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -181,7 +172,7 @@
<li><a href="index.html">Docs</a> &raquo;</li>
<li>24. Reference</li>
<li><span class="section-number">24. </span>Reference</li>
<li class="wy-breadcrumbs-aside">
@ -201,471 +192,481 @@
<div itemprop="articleBody">
<div class="section" id="reference">
<h1>24. Reference<a class="headerlink" href="#reference" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">24. </span>Reference<a class="headerlink" href="#reference" title="Permalink to this headline"></a></h1>
<p>Variable, path and type reference for cdist</p>
<div class="section" id="explorers">
<h2>24.1. Explorers<a class="headerlink" href="#explorers" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">24.1. </span>Explorers<a class="headerlink" href="#explorers" title="Permalink to this headline"></a></h2>
<p>The following global explorers are available:</p>
<ul class="simple">
<li>cpu_cores</li>
<li>cpu_sockets</li>
<li>disks</li>
<li>hostname</li>
<li>init</li>
<li>interfaces</li>
<li>is-freebsd-jail</li>
<li>kernel_name</li>
<li>lsb_codename</li>
<li>lsb_description</li>
<li>lsb_id</li>
<li>lsb_release</li>
<li>machine</li>
<li>machine_type</li>
<li>memory</li>
<li>os</li>
<li>os_release</li>
<li>os_version</li>
<li>runlevel</li>
<li><p>cpu_cores</p></li>
<li><p>cpu_sockets</p></li>
<li><p>disks</p></li>
<li><p>hostname</p></li>
<li><p>init</p></li>
<li><p>interfaces</p></li>
<li><p>is-freebsd-jail</p></li>
<li><p>kernel_name</p></li>
<li><p>lsb_codename</p></li>
<li><p>lsb_description</p></li>
<li><p>lsb_id</p></li>
<li><p>lsb_release</p></li>
<li><p>machine</p></li>
<li><p>machine_type</p></li>
<li><p>memory</p></li>
<li><p>os</p></li>
<li><p>os_release</p></li>
<li><p>os_version</p></li>
<li><p>runlevel</p></li>
</ul>
</div>
<div class="section" id="paths">
<h2>24.2. Paths<a class="headerlink" href="#paths" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>$HOME/.cdist</dt>
<dd>The standard cdist configuration directory relative to your home directory.
This is usually the place you want to store your site specific configuration.</dd>
<dt>cdist/conf/</dt>
<dd>The distribution configuration directory.
This contains types and explorers to be used.</dd>
<dt>cdist/inventory/</dt>
<dd>The distribution inventory directory.
This path is relative to cdist installation directory.</dd>
<dt>cdist/preos/</dt>
<dd>The distribution PreOS plugins directory.</dd>
<dt>confdir</dt>
<dd>Cdist will use all available configuration directories and create
<h2><span class="section-number">24.2. </span>Paths<a class="headerlink" href="#paths" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>$HOME/.cdist</dt><dd><p>The standard cdist configuration directory relative to your home directory.
This is usually the place you want to store your site specific configuration.</p>
</dd>
<dt>cdist/conf/</dt><dd><p>The distribution configuration directory.
This contains types and explorers to be used.</p>
</dd>
<dt>cdist/inventory/</dt><dd><p>The distribution inventory directory.
This path is relative to cdist installation directory.</p>
</dd>
<dt>cdist/preos/</dt><dd><p>The distribution PreOS plugins directory.</p>
</dd>
<dt>confdir</dt><dd><p>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).</dd>
<dt>confdir/files/</dt>
<dd>Cdist does not care about this directory besides providing access to it.
It is thought to be a general file storage area.</dd>
<dt>confdir/manifest/init</dt>
<dd>This is the central entry point.
For more details see cdist(1).</p>
</dd>
<dt>confdir/files/</dt><dd><p>Cdist does not care about this directory besides providing access to it.
It is thought to be a general file storage area.</p>
</dd>
<dt>confdir/manifest/init</dt><dd><p>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.</dd>
<dt>confdir/manifest/*</dt>
<dd>All other files in this directory are not directly used by cdist, but you
Its intent is to used to define mapping from configurations to hosts.</p>
</dd>
<dt>confdir/manifest/*</dt><dd><p>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.</dd>
<dt>confdir/explorer/&lt;name&gt;</dt>
<dd>Contains explorers to be run on the target hosts, see <a class="reference external" href="cdist-explorer.html">cdist explorer</a>.</dd>
<dt>confdir/type/</dt>
<dd>Contains all available types, which are used to provide
some kind of functionality. See <a class="reference external" href="cdist-type.html">cdist type</a>.</dd>
<dt>confdir/type/&lt;name&gt;/</dt>
<dd>Home of the type &lt;name&gt;.
This directory is referenced by the variable __type (see below).</dd>
<dt>confdir/type/&lt;name&gt;/man.rst</dt>
<dd>Manpage in reStructuredText format (required for inclusion into upstream).</dd>
<dt>confdir/type/&lt;name&gt;/manifest</dt>
<dd>Used to generate additional objects from a type.</dd>
<dt>confdir/type/&lt;name&gt;/gencode-local</dt>
<dd>Used to generate code to be executed on the source host.</dd>
<dt>confdir/type/&lt;name&gt;/gencode-remote</dt>
<dd>Used to generate code to be executed on the target host.</dd>
<dt>confdir/type/&lt;name&gt;/parameter/required</dt>
<dd>Parameters required by type, n separated list.</dd>
<dt>confdir/type/&lt;name&gt;/parameter/optional</dt>
<dd>Parameters optionally accepted by type, n separated list.</dd>
<dt>confdir/type/&lt;name&gt;/parameter/default/*</dt>
<dd>Default values for optional parameters.
maintain different groups of hosts.</p>
</dd>
<dt>confdir/explorer/&lt;name&gt;</dt><dd><p>Contains explorers to be run on the target hosts, see <a class="reference external" href="cdist-explorer.html">cdist explorer</a>.</p>
</dd>
<dt>confdir/type/</dt><dd><p>Contains all available types, which are used to provide
some kind of functionality. See <a class="reference external" href="cdist-type.html">cdist type</a>.</p>
</dd>
<dt>confdir/type/&lt;name&gt;/</dt><dd><p>Home of the type &lt;name&gt;.
This directory is referenced by the variable __type (see below).</p>
</dd>
<dt>confdir/type/&lt;name&gt;/man.rst</dt><dd><p>Manpage in reStructuredText format (required for inclusion into upstream).</p>
</dd>
<dt>confdir/type/&lt;name&gt;/manifest</dt><dd><p>Used to generate additional objects from a type.</p>
</dd>
<dt>confdir/type/&lt;name&gt;/gencode-local</dt><dd><p>Used to generate code to be executed on the source host.</p>
</dd>
<dt>confdir/type/&lt;name&gt;/gencode-remote</dt><dd><p>Used to generate code to be executed on the target host.</p>
</dd>
<dt>confdir/type/&lt;name&gt;/parameter/required</dt><dd><p>Parameters required by type, n separated list.</p>
</dd>
<dt>confdir/type/&lt;name&gt;/parameter/optional</dt><dd><p>Parameters optionally accepted by type, n separated list.</p>
</dd>
<dt>confdir/type/&lt;name&gt;/parameter/default/*</dt><dd><p>Default values for optional parameters.
Assuming an optional parameter name of 'foo', it's default value would
be read from the file confdir/type/&lt;name&gt;/parameter/default/foo.</dd>
<dt>confdir/type/&lt;name&gt;/parameter/boolean</dt>
<dd>Boolean parameters accepted by type, n separated list.</dd>
<dt>confdir/type/&lt;name&gt;/explorer</dt>
<dd>Location of the type specific explorers.
be read from the file confdir/type/&lt;name&gt;/parameter/default/foo.</p>
</dd>
<dt>confdir/type/&lt;name&gt;/parameter/boolean</dt><dd><p>Boolean parameters accepted by type, n separated list.</p>
</dd>
<dt>confdir/type/&lt;name&gt;/explorer</dt><dd><p>Location of the type specific explorers.
This directory is referenced by the variable __type_explorer (see below).
See <a class="reference external" href="cdist-explorer.html">cdist explorer</a>.</dd>
<dt>confdir/type/&lt;name&gt;/files</dt>
<dd>This directory is reserved for user data and will not be used
See <a class="reference external" href="cdist-explorer.html">cdist explorer</a>.</p>
</dd>
<dt>confdir/type/&lt;name&gt;/files</dt><dd><p>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).</dd>
<dt>out/</dt>
<dd>This directory contains output of cdist and is usually located
files (like scripts to act as a template or configuration files).</p>
</dd>
<dt>out/</dt><dd><p>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).</dd>
<dt>out/explorer</dt>
<dd>Output of general explorers.</dd>
<dt>out/object</dt>
<dd>Objects created for the host.</dd>
<dt>out/object/&lt;object&gt;</dt>
<dd>Contains all object specific information.
This directory is referenced by the variable __object (see below).</dd>
<dt>out/object/&lt;object&gt;/explorers</dt>
<dd>Output of type specific explorers, per object.</dd>
This directory is referenced by the variable __global (see below).</p>
</dd>
<dt>out/explorer</dt><dd><p>Output of general explorers.</p>
</dd>
<dt>out/object</dt><dd><p>Objects created for the host.</p>
</dd>
<dt>out/object/&lt;object&gt;</dt><dd><p>Contains all object specific information.
This directory is referenced by the variable __object (see below).</p>
</dd>
<dt>out/object/&lt;object&gt;/explorers</dt><dd><p>Output of type specific explorers, per object.</p>
</dd>
</dl>
</div>
<div class="section" id="types">
<h2>24.3. Types<a class="headerlink" href="#types" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">24.3. </span>Types<a class="headerlink" href="#types" title="Permalink to this headline"></a></h2>
<p>The following types are available:</p>
<ul class="simple">
<li>__acl (<a class="reference external" href="man7/cdist-type__acl.html">cdist-type__acl(7)</a>)</li>
<li>__apt_default_release (<a class="reference external" href="man7/cdist-type__apt_default_release.html">cdist-type__apt_default_release(7)</a>)</li>
<li>__apt_key (<a class="reference external" href="man7/cdist-type__apt_key.html">cdist-type__apt_key(7)</a>)</li>
<li>__apt_key_uri (<a class="reference external" href="man7/cdist-type__apt_key_uri.html">cdist-type__apt_key_uri(7)</a>)</li>
<li>__apt_mark (<a class="reference external" href="man7/cdist-type__apt_mark.html">cdist-type__apt_mark(7)</a>)</li>
<li>__apt_norecommends (<a class="reference external" href="man7/cdist-type__apt_norecommends.html">cdist-type__apt_norecommends(7)</a>)</li>
<li>__apt_ppa (<a class="reference external" href="man7/cdist-type__apt_ppa.html">cdist-type__apt_ppa(7)</a>)</li>
<li>__apt_source (<a class="reference external" href="man7/cdist-type__apt_source.html">cdist-type__apt_source(7)</a>)</li>
<li>__apt_unattended_upgrades (<a class="reference external" href="man7/cdist-type__apt_unattended_upgrades.html">cdist-type__apt_unattended_upgrades(7)</a>)</li>
<li>__apt_update_index (<a class="reference external" href="man7/cdist-type__apt_update_index.html">cdist-type__apt_update_index(7)</a>)</li>
<li>__block (<a class="reference external" href="man7/cdist-type__block.html">cdist-type__block(7)</a>)</li>
<li>__ccollect_source (<a class="reference external" href="man7/cdist-type__ccollect_source.html">cdist-type__ccollect_source(7)</a>)</li>
<li>__cdist (<a class="reference external" href="man7/cdist-type__cdist.html">cdist-type__cdist(7)</a>)</li>
<li>__cdist_preos_trigger (<a class="reference external" href="man7/cdist-type__cdist_preos_trigger.html">cdist-type__cdist_preos_trigger(7)</a>)</li>
<li>__cdistmarker (<a class="reference external" href="man7/cdist-type__cdistmarker.html">cdist-type__cdistmarker(7)</a>)</li>
<li>__check_messages (<a class="reference external" href="man7/cdist-type__check_messages.html">cdist-type__check_messages(7)</a>)</li>
<li>__chroot_mount (<a class="reference external" href="man7/cdist-type__chroot_mount.html">cdist-type__chroot_mount(7)</a>)</li>
<li>__chroot_umount (<a class="reference external" href="man7/cdist-type__chroot_umount.html">cdist-type__chroot_umount(7)</a>)</li>
<li>__clean_path (<a class="reference external" href="man7/cdist-type__clean_path.html">cdist-type__clean_path(7)</a>)</li>
<li>__config_file (<a class="reference external" href="man7/cdist-type__config_file.html">cdist-type__config_file(7)</a>)</li>
<li>__consul (<a class="reference external" href="man7/cdist-type__consul.html">cdist-type__consul(7)</a>)</li>
<li>__consul_agent (<a class="reference external" href="man7/cdist-type__consul_agent.html">cdist-type__consul_agent(7)</a>)</li>
<li>__consul_check (<a class="reference external" href="man7/cdist-type__consul_check.html">cdist-type__consul_check(7)</a>)</li>
<li>__consul_reload (<a class="reference external" href="man7/cdist-type__consul_reload.html">cdist-type__consul_reload(7)</a>)</li>
<li>__consul_service (<a class="reference external" href="man7/cdist-type__consul_service.html">cdist-type__consul_service(7)</a>)</li>
<li>__consul_template (<a class="reference external" href="man7/cdist-type__consul_template.html">cdist-type__consul_template(7)</a>)</li>
<li>__consul_template_template (<a class="reference external" href="man7/cdist-type__consul_template_template.html">cdist-type__consul_template_template(7)</a>)</li>
<li>__consul_watch_checks (<a class="reference external" href="man7/cdist-type__consul_watch_checks.html">cdist-type__consul_watch_checks(7)</a>)</li>
<li>__consul_watch_event (<a class="reference external" href="man7/cdist-type__consul_watch_event.html">cdist-type__consul_watch_event(7)</a>)</li>
<li>__consul_watch_key (<a class="reference external" href="man7/cdist-type__consul_watch_key.html">cdist-type__consul_watch_key(7)</a>)</li>
<li>__consul_watch_keyprefix (<a class="reference external" href="man7/cdist-type__consul_watch_keyprefix.html">cdist-type__consul_watch_keyprefix(7)</a>)</li>
<li>__consul_watch_nodes (<a class="reference external" href="man7/cdist-type__consul_watch_nodes.html">cdist-type__consul_watch_nodes(7)</a>)</li>
<li>__consul_watch_service (<a class="reference external" href="man7/cdist-type__consul_watch_service.html">cdist-type__consul_watch_service(7)</a>)</li>
<li>__consul_watch_services (<a class="reference external" href="man7/cdist-type__consul_watch_services.html">cdist-type__consul_watch_services(7)</a>)</li>
<li>__cron (<a class="reference external" href="man7/cdist-type__cron.html">cdist-type__cron(7)</a>)</li>
<li>__daemontools (<a class="reference external" href="man7/cdist-type__daemontools.html">cdist-type__daemontools(7)</a>)</li>
<li>__daemontools_service (<a class="reference external" href="man7/cdist-type__daemontools_service.html">cdist-type__daemontools_service(7)</a>)</li>
<li>__debconf_set_selections (<a class="reference external" href="man7/cdist-type__debconf_set_selections.html">cdist-type__debconf_set_selections(7)</a>)</li>
<li>__directory (<a class="reference external" href="man7/cdist-type__directory.html">cdist-type__directory(7)</a>)</li>
<li>__docker (<a class="reference external" href="man7/cdist-type__docker.html">cdist-type__docker(7)</a>)</li>
<li>__docker_compose (<a class="reference external" href="man7/cdist-type__docker_compose.html">cdist-type__docker_compose(7)</a>)</li>
<li>__docker_config (<a class="reference external" href="man7/cdist-type__docker_config.html">cdist-type__docker_config(7)</a>)</li>
<li>__docker_secret (<a class="reference external" href="man7/cdist-type__docker_secret.html">cdist-type__docker_secret(7)</a>)</li>
<li>__docker_stack (<a class="reference external" href="man7/cdist-type__docker_stack.html">cdist-type__docker_stack(7)</a>)</li>
<li>__docker_swarm (<a class="reference external" href="man7/cdist-type__docker_swarm.html">cdist-type__docker_swarm(7)</a>)</li>
<li>__dog_vdi (<a class="reference external" href="man7/cdist-type__dog_vdi.html">cdist-type__dog_vdi(7)</a>)</li>
<li>__dot_file (<a class="reference external" href="man7/cdist-type__dot_file.html">cdist-type__dot_file(7)</a>)</li>
<li>__file_old (<a class="reference external" href="man7/cdist-type__file_old.html">cdist-type__file_old(7)</a>)</li>
<li>__filesystem (<a class="reference external" href="man7/cdist-type__filesystem.html">cdist-type__filesystem(7)</a>)</li>
<li>__firewalld_rule (<a class="reference external" href="man7/cdist-type__firewalld_rule.html">cdist-type__firewalld_rule(7)</a>)</li>
<li>__firewalld_start (<a class="reference external" href="man7/cdist-type__firewalld_start.html">cdist-type__firewalld_start(7)</a>)</li>
<li>__git (<a class="reference external" href="man7/cdist-type__git.html">cdist-type__git(7)</a>)</li>
<li>__go_get (<a class="reference external" href="man7/cdist-type__go_get.html">cdist-type__go_get(7)</a>)</li>
<li>__golang_from_vendor (<a class="reference external" href="man7/cdist-type__golang_from_vendor.html">cdist-type__golang_from_vendor(7)</a>)</li>
<li>__grafana_dashboard (<a class="reference external" href="man7/cdist-type__grafana_dashboard.html">cdist-type__grafana_dashboard(7)</a>)</li>
<li>__group (<a class="reference external" href="man7/cdist-type__group.html">cdist-type__group(7)</a>)</li>
<li>__hostname (<a class="reference external" href="man7/cdist-type__hostname.html">cdist-type__hostname(7)</a>)</li>
<li>__hosts (<a class="reference external" href="man7/cdist-type__hosts.html">cdist-type__hosts(7)</a>)</li>
<li>__install_bootloader_grub (<a class="reference external" href="man7/cdist-type__install_bootloader_grub.html">cdist-type__install_bootloader_grub(7)</a>)</li>
<li>__install_chroot_mount (<a class="reference external" href="man7/cdist-type__install_chroot_mount.html">cdist-type__install_chroot_mount(7)</a>)</li>
<li>__install_chroot_umount (<a class="reference external" href="man7/cdist-type__install_chroot_umount.html">cdist-type__install_chroot_umount(7)</a>)</li>
<li>__install_config (<a class="reference external" href="man7/cdist-type__install_config.html">cdist-type__install_config(7)</a>)</li>
<li>__install_coreos (<a class="reference external" href="man7/cdist-type__install_coreos.html">cdist-type__install_coreos(7)</a>)</li>
<li>__install_directory (<a class="reference external" href="man7/cdist-type__install_directory.html">cdist-type__install_directory(7)</a>)</li>
<li>__install_file (<a class="reference external" href="man7/cdist-type__install_file.html">cdist-type__install_file(7)</a>)</li>
<li>__install_fstab (<a class="reference external" href="man7/cdist-type__install_fstab.html">cdist-type__install_fstab(7)</a>)</li>
<li>__install_generate_fstab (<a class="reference external" href="man7/cdist-type__install_generate_fstab.html">cdist-type__install_generate_fstab(7)</a>)</li>
<li>__install_mkfs (<a class="reference external" href="man7/cdist-type__install_mkfs.html">cdist-type__install_mkfs(7)</a>)</li>
<li>__install_mount (<a class="reference external" href="man7/cdist-type__install_mount.html">cdist-type__install_mount(7)</a>)</li>
<li>__install_partition_msdos (<a class="reference external" href="man7/cdist-type__install_partition_msdos.html">cdist-type__install_partition_msdos(7)</a>)</li>
<li>__install_partition_msdos_apply (<a class="reference external" href="man7/cdist-type__install_partition_msdos_apply.html">cdist-type__install_partition_msdos_apply(7)</a>)</li>
<li>__install_reboot (<a class="reference external" href="man7/cdist-type__install_reboot.html">cdist-type__install_reboot(7)</a>)</li>
<li>__install_reset_disk (<a class="reference external" href="man7/cdist-type__install_reset_disk.html">cdist-type__install_reset_disk(7)</a>)</li>
<li>__install_stage (<a class="reference external" href="man7/cdist-type__install_stage.html">cdist-type__install_stage(7)</a>)</li>
<li>__install_umount (<a class="reference external" href="man7/cdist-type__install_umount.html">cdist-type__install_umount(7)</a>)</li>
<li>__iptables_apply (<a class="reference external" href="man7/cdist-type__iptables_apply.html">cdist-type__iptables_apply(7)</a>)</li>
<li>__iptables_rule (<a class="reference external" href="man7/cdist-type__iptables_rule.html">cdist-type__iptables_rule(7)</a>)</li>
<li>__issue (<a class="reference external" href="man7/cdist-type__issue.html">cdist-type__issue(7)</a>)</li>
<li>__jail (<a class="reference external" href="man7/cdist-type__jail.html">cdist-type__jail(7)</a>)</li>
<li>__jail_freebsd10 (<a class="reference external" href="man7/cdist-type__jail_freebsd10.html">cdist-type__jail_freebsd10(7)</a>)</li>
<li>__jail_freebsd9 (<a class="reference external" href="man7/cdist-type__jail_freebsd9.html">cdist-type__jail_freebsd9(7)</a>)</li>
<li>__key_value (<a class="reference external" href="man7/cdist-type__key_value.html">cdist-type__key_value(7)</a>)</li>
<li>__keyboard (<a class="reference external" href="man7/cdist-type__keyboard.html">cdist-type__keyboard(7)</a>)</li>
<li>__letsencrypt_cert (<a class="reference external" href="man7/cdist-type__letsencrypt_cert.html">cdist-type__letsencrypt_cert(7)</a>)</li>
<li>__line (<a class="reference external" href="man7/cdist-type__line.html">cdist-type__line(7)</a>)</li>
<li>__link (<a class="reference external" href="man7/cdist-type__link.html">cdist-type__link(7)</a>)</li>
<li>__locale (<a class="reference external" href="man7/cdist-type__locale.html">cdist-type__locale(7)</a>)</li>
<li>__locale_system (<a class="reference external" href="man7/cdist-type__locale_system.html">cdist-type__locale_system(7)</a>)</li>
<li>__motd (<a class="reference external" href="man7/cdist-type__motd.html">cdist-type__motd(7)</a>)</li>
<li>__mount (<a class="reference external" href="man7/cdist-type__mount.html">cdist-type__mount(7)</a>)</li>
<li>__mysql_database (<a class="reference external" href="man7/cdist-type__mysql_database.html">cdist-type__mysql_database(7)</a>)</li>
<li>__mysql_privileges (<a class="reference external" href="man7/cdist-type__mysql_privileges.html">cdist-type__mysql_privileges(7)</a>)</li>
<li>__mysql_user (<a class="reference external" href="man7/cdist-type__mysql_user.html">cdist-type__mysql_user(7)</a>)</li>
<li>__openldap_server (<a class="reference external" href="man7/cdist-type__openldap_server.html">cdist-type__openldap_server(7)</a>)</li>
<li>__package (<a class="reference external" href="man7/cdist-type__package.html">cdist-type__package(7)</a>)</li>
<li>__package_apk (<a class="reference external" href="man7/cdist-type__package_apk.html">cdist-type__package_apk(7)</a>)</li>
<li>__package_apt (<a class="reference external" href="man7/cdist-type__package_apt.html">cdist-type__package_apt(7)</a>)</li>
<li>__package_dpkg (<a class="reference external" href="man7/cdist-type__package_dpkg.html">cdist-type__package_dpkg(7)</a>)</li>
<li>__package_emerge (<a class="reference external" href="man7/cdist-type__package_emerge.html">cdist-type__package_emerge(7)</a>)</li>
<li>__package_emerge_dependencies (<a class="reference external" href="man7/cdist-type__package_emerge_dependencies.html">cdist-type__package_emerge_dependencies(7)</a>)</li>
<li>__package_luarocks (<a class="reference external" href="man7/cdist-type__package_luarocks.html">cdist-type__package_luarocks(7)</a>)</li>
<li>__package_opkg (<a class="reference external" href="man7/cdist-type__package_opkg.html">cdist-type__package_opkg(7)</a>)</li>
<li>__package_pacman (<a class="reference external" href="man7/cdist-type__package_pacman.html">cdist-type__package_pacman(7)</a>)</li>
<li>__package_pip (<a class="reference external" href="man7/cdist-type__package_pip.html">cdist-type__package_pip(7)</a>)</li>
<li>__package_pkg_freebsd (<a class="reference external" href="man7/cdist-type__package_pkg_freebsd.html">cdist-type__package_pkg_freebsd(7)</a>)</li>
<li>__package_pkg_openbsd (<a class="reference external" href="man7/cdist-type__package_pkg_openbsd.html">cdist-type__package_pkg_openbsd(7)</a>)</li>
<li>__package_pkgng_freebsd (<a class="reference external" href="man7/cdist-type__package_pkgng_freebsd.html">cdist-type__package_pkgng_freebsd(7)</a>)</li>
<li>__package_rubygem (<a class="reference external" href="man7/cdist-type__package_rubygem.html">cdist-type__package_rubygem(7)</a>)</li>
<li>__package_update_index (<a class="reference external" href="man7/cdist-type__package_update_index.html">cdist-type__package_update_index(7)</a>)</li>
<li>__package_upgrade_all (<a class="reference external" href="man7/cdist-type__package_upgrade_all.html">cdist-type__package_upgrade_all(7)</a>)</li>
<li>__package_yum (<a class="reference external" href="man7/cdist-type__package_yum.html">cdist-type__package_yum(7)</a>)</li>
<li>__package_zypper (<a class="reference external" href="man7/cdist-type__package_zypper.html">cdist-type__package_zypper(7)</a>)</li>
<li>__pacman_conf (<a class="reference external" href="man7/cdist-type__pacman_conf.html">cdist-type__pacman_conf(7)</a>)</li>
<li>__pacman_conf_integrate (<a class="reference external" href="man7/cdist-type__pacman_conf_integrate.html">cdist-type__pacman_conf_integrate(7)</a>)</li>
<li>__pf_apply (<a class="reference external" href="man7/cdist-type__pf_apply.html">cdist-type__pf_apply(7)</a>)</li>
<li>__pf_apply_anchor (<a class="reference external" href="man7/cdist-type__pf_apply_anchor.html">cdist-type__pf_apply_anchor(7)</a>)</li>
<li>__pf_ruleset (<a class="reference external" href="man7/cdist-type__pf_ruleset.html">cdist-type__pf_ruleset(7)</a>)</li>
<li>__ping (<a class="reference external" href="man7/cdist-type__ping.html">cdist-type__ping(7)</a>)</li>
<li>__postfix (<a class="reference external" href="man7/cdist-type__postfix.html">cdist-type__postfix(7)</a>)</li>
<li>__postfix_master (<a class="reference external" href="man7/cdist-type__postfix_master.html">cdist-type__postfix_master(7)</a>)</li>
<li>__postfix_postconf (<a class="reference external" href="man7/cdist-type__postfix_postconf.html">cdist-type__postfix_postconf(7)</a>)</li>
<li>__postfix_postmap (<a class="reference external" href="man7/cdist-type__postfix_postmap.html">cdist-type__postfix_postmap(7)</a>)</li>
<li>__postfix_reload (<a class="reference external" href="man7/cdist-type__postfix_reload.html">cdist-type__postfix_reload(7)</a>)</li>
<li>__postgres_database (<a class="reference external" href="man7/cdist-type__postgres_database.html">cdist-type__postgres_database(7)</a>)</li>
<li>__postgres_extension (<a class="reference external" href="man7/cdist-type__postgres_extension.html">cdist-type__postgres_extension(7)</a>)</li>
<li>__postgres_role (<a class="reference external" href="man7/cdist-type__postgres_role.html">cdist-type__postgres_role(7)</a>)</li>
<li>__process (<a class="reference external" href="man7/cdist-type__process.html">cdist-type__process(7)</a>)</li>
<li>__prometheus_alertmanager (<a class="reference external" href="man7/cdist-type__prometheus_alertmanager.html">cdist-type__prometheus_alertmanager(7)</a>)</li>
<li>__prometheus_exporter (<a class="reference external" href="man7/cdist-type__prometheus_exporter.html">cdist-type__prometheus_exporter(7)</a>)</li>
<li>__prometheus_server (<a class="reference external" href="man7/cdist-type__prometheus_server.html">cdist-type__prometheus_server(7)</a>)</li>
<li>__pyvenv (<a class="reference external" href="man7/cdist-type__pyvenv.html">cdist-type__pyvenv(7)</a>)</li>
<li>__qemu_img (<a class="reference external" href="man7/cdist-type__qemu_img.html">cdist-type__qemu_img(7)</a>)</li>
<li>__rbenv (<a class="reference external" href="man7/cdist-type__rbenv.html">cdist-type__rbenv(7)</a>)</li>
<li>__rsync (<a class="reference external" href="man7/cdist-type__rsync.html">cdist-type__rsync(7)</a>)</li>
<li>__rvm (<a class="reference external" href="man7/cdist-type__rvm.html">cdist-type__rvm(7)</a>)</li>
<li>__rvm_gem (<a class="reference external" href="man7/cdist-type__rvm_gem.html">cdist-type__rvm_gem(7)</a>)</li>
<li>__rvm_gemset (<a class="reference external" href="man7/cdist-type__rvm_gemset.html">cdist-type__rvm_gemset(7)</a>)</li>
<li>__rvm_ruby (<a class="reference external" href="man7/cdist-type__rvm_ruby.html">cdist-type__rvm_ruby(7)</a>)</li>
<li>__sensible_editor (<a class="reference external" href="man7/cdist-type__sensible_editor.html">cdist-type__sensible_editor(7)</a>)</li>
<li>__service (<a class="reference external" href="man7/cdist-type__service.html">cdist-type__service(7)</a>)</li>
<li>__ssh_authorized_key (<a class="reference external" href="man7/cdist-type__ssh_authorized_key.html">cdist-type__ssh_authorized_key(7)</a>)</li>
<li>__ssh_authorized_keys (<a class="reference external" href="man7/cdist-type__ssh_authorized_keys.html">cdist-type__ssh_authorized_keys(7)</a>)</li>
<li>__ssh_dot_ssh (<a class="reference external" href="man7/cdist-type__ssh_dot_ssh.html">cdist-type__ssh_dot_ssh(7)</a>)</li>
<li>__staged_file (<a class="reference external" href="man7/cdist-type__staged_file.html">cdist-type__staged_file(7)</a>)</li>
<li>__start_on_boot (<a class="reference external" href="man7/cdist-type__start_on_boot.html">cdist-type__start_on_boot(7)</a>)</li>
<li>__sysctl (<a class="reference external" href="man7/cdist-type__sysctl.html">cdist-type__sysctl(7)</a>)</li>
<li>__systemd_service (<a class="reference external" href="man7/cdist-type__systemd_service.html">cdist-type__systemd_service(7)</a>)</li>
<li>__systemd_unit (<a class="reference external" href="man7/cdist-type__systemd_unit.html">cdist-type__systemd_unit(7)</a>)</li>
<li>__timezone (<a class="reference external" href="man7/cdist-type__timezone.html">cdist-type__timezone(7)</a>)</li>
<li>__ufw (<a class="reference external" href="man7/cdist-type__ufw.html">cdist-type__ufw(7)</a>)</li>
<li>__ufw_rule (<a class="reference external" href="man7/cdist-type__ufw_rule.html">cdist-type__ufw_rule(7)</a>)</li>
<li>__update_alternatives (<a class="reference external" href="man7/cdist-type__update_alternatives.html">cdist-type__update_alternatives(7)</a>)</li>
<li>__user (<a class="reference external" href="man7/cdist-type__user.html">cdist-type__user(7)</a>)</li>
<li>__user_groups (<a class="reference external" href="man7/cdist-type__user_groups.html">cdist-type__user_groups(7)</a>)</li>
<li>__xymon_apache (<a class="reference external" href="man7/cdist-type__xymon_apache.html">cdist-type__xymon_apache(7)</a>)</li>
<li>__xymon_client (<a class="reference external" href="man7/cdist-type__xymon_client.html">cdist-type__xymon_client(7)</a>)</li>
<li>__xymon_config (<a class="reference external" href="man7/cdist-type__xymon_config.html">cdist-type__xymon_config(7)</a>)</li>
<li>__xymon_server (<a class="reference external" href="man7/cdist-type__xymon_server.html">cdist-type__xymon_server(7)</a>)</li>
<li>__yum_repo (<a class="reference external" href="man7/cdist-type__yum_repo.html">cdist-type__yum_repo(7)</a>)</li>
<li>__zypper_repo (<a class="reference external" href="man7/cdist-type__zypper_repo.html">cdist-type__zypper_repo(7)</a>)</li>
<li>__zypper_service (<a class="reference external" href="man7/cdist-type__zypper_service.html">cdist-type__zypper_service(7)</a>)</li>
<li><p>__acl (<a class="reference external" href="man7/cdist-type__acl.html">cdist-type__acl(7)</a>)</p></li>
<li><p>__apt_default_release (<a class="reference external" href="man7/cdist-type__apt_default_release.html">cdist-type__apt_default_release(7)</a>)</p></li>
<li><p>__apt_key (<a class="reference external" href="man7/cdist-type__apt_key.html">cdist-type__apt_key(7)</a>)</p></li>
<li><p>__apt_key_uri (<a class="reference external" href="man7/cdist-type__apt_key_uri.html">cdist-type__apt_key_uri(7)</a>)</p></li>
<li><p>__apt_mark (<a class="reference external" href="man7/cdist-type__apt_mark.html">cdist-type__apt_mark(7)</a>)</p></li>
<li><p>__apt_norecommends (<a class="reference external" href="man7/cdist-type__apt_norecommends.html">cdist-type__apt_norecommends(7)</a>)</p></li>
<li><p>__apt_ppa (<a class="reference external" href="man7/cdist-type__apt_ppa.html">cdist-type__apt_ppa(7)</a>)</p></li>
<li><p>__apt_source (<a class="reference external" href="man7/cdist-type__apt_source.html">cdist-type__apt_source(7)</a>)</p></li>
<li><p>__apt_unattended_upgrades (<a class="reference external" href="man7/cdist-type__apt_unattended_upgrades.html">cdist-type__apt_unattended_upgrades(7)</a>)</p></li>
<li><p>__apt_update_index (<a class="reference external" href="man7/cdist-type__apt_update_index.html">cdist-type__apt_update_index(7)</a>)</p></li>
<li><p>__block (<a class="reference external" href="man7/cdist-type__block.html">cdist-type__block(7)</a>)</p></li>
<li><p>__ccollect_source (<a class="reference external" href="man7/cdist-type__ccollect_source.html">cdist-type__ccollect_source(7)</a>)</p></li>
<li><p>__cdist (<a class="reference external" href="man7/cdist-type__cdist.html">cdist-type__cdist(7)</a>)</p></li>
<li><p>__cdist_preos_trigger (<a class="reference external" href="man7/cdist-type__cdist_preos_trigger.html">cdist-type__cdist_preos_trigger(7)</a>)</p></li>
<li><p>__cdistmarker (<a class="reference external" href="man7/cdist-type__cdistmarker.html">cdist-type__cdistmarker(7)</a>)</p></li>
<li><p>__check_messages (<a class="reference external" href="man7/cdist-type__check_messages.html">cdist-type__check_messages(7)</a>)</p></li>
<li><p>__chroot_mount (<a class="reference external" href="man7/cdist-type__chroot_mount.html">cdist-type__chroot_mount(7)</a>)</p></li>
<li><p>__chroot_umount (<a class="reference external" href="man7/cdist-type__chroot_umount.html">cdist-type__chroot_umount(7)</a>)</p></li>
<li><p>__clean_path (<a class="reference external" href="man7/cdist-type__clean_path.html">cdist-type__clean_path(7)</a>)</p></li>
<li><p>__config_file (<a class="reference external" href="man7/cdist-type__config_file.html">cdist-type__config_file(7)</a>)</p></li>
<li><p>__consul (<a class="reference external" href="man7/cdist-type__consul.html">cdist-type__consul(7)</a>)</p></li>
<li><p>__consul_agent (<a class="reference external" href="man7/cdist-type__consul_agent.html">cdist-type__consul_agent(7)</a>)</p></li>
<li><p>__consul_check (<a class="reference external" href="man7/cdist-type__consul_check.html">cdist-type__consul_check(7)</a>)</p></li>
<li><p>__consul_reload (<a class="reference external" href="man7/cdist-type__consul_reload.html">cdist-type__consul_reload(7)</a>)</p></li>
<li><p>__consul_service (<a class="reference external" href="man7/cdist-type__consul_service.html">cdist-type__consul_service(7)</a>)</p></li>
<li><p>__consul_template (<a class="reference external" href="man7/cdist-type__consul_template.html">cdist-type__consul_template(7)</a>)</p></li>
<li><p>__consul_template_template (<a class="reference external" href="man7/cdist-type__consul_template_template.html">cdist-type__consul_template_template(7)</a>)</p></li>
<li><p>__consul_watch_checks (<a class="reference external" href="man7/cdist-type__consul_watch_checks.html">cdist-type__consul_watch_checks(7)</a>)</p></li>
<li><p>__consul_watch_event (<a class="reference external" href="man7/cdist-type__consul_watch_event.html">cdist-type__consul_watch_event(7)</a>)</p></li>
<li><p>__consul_watch_key (<a class="reference external" href="man7/cdist-type__consul_watch_key.html">cdist-type__consul_watch_key(7)</a>)</p></li>
<li><p>__consul_watch_keyprefix (<a class="reference external" href="man7/cdist-type__consul_watch_keyprefix.html">cdist-type__consul_watch_keyprefix(7)</a>)</p></li>
<li><p>__consul_watch_nodes (<a class="reference external" href="man7/cdist-type__consul_watch_nodes.html">cdist-type__consul_watch_nodes(7)</a>)</p></li>
<li><p>__consul_watch_service (<a class="reference external" href="man7/cdist-type__consul_watch_service.html">cdist-type__consul_watch_service(7)</a>)</p></li>
<li><p>__consul_watch_services (<a class="reference external" href="man7/cdist-type__consul_watch_services.html">cdist-type__consul_watch_services(7)</a>)</p></li>
<li><p>__cron (<a class="reference external" href="man7/cdist-type__cron.html">cdist-type__cron(7)</a>)</p></li>
<li><p>__daemontools (<a class="reference external" href="man7/cdist-type__daemontools.html">cdist-type__daemontools(7)</a>)</p></li>
<li><p>__daemontools_service (<a class="reference external" href="man7/cdist-type__daemontools_service.html">cdist-type__daemontools_service(7)</a>)</p></li>
<li><p>__debconf_set_selections (<a class="reference external" href="man7/cdist-type__debconf_set_selections.html">cdist-type__debconf_set_selections(7)</a>)</p></li>
<li><p>__directory (<a class="reference external" href="man7/cdist-type__directory.html">cdist-type__directory(7)</a>)</p></li>
<li><p>__docker (<a class="reference external" href="man7/cdist-type__docker.html">cdist-type__docker(7)</a>)</p></li>
<li><p>__docker_compose (<a class="reference external" href="man7/cdist-type__docker_compose.html">cdist-type__docker_compose(7)</a>)</p></li>
<li><p>__docker_config (<a class="reference external" href="man7/cdist-type__docker_config.html">cdist-type__docker_config(7)</a>)</p></li>
<li><p>__docker_secret (<a class="reference external" href="man7/cdist-type__docker_secret.html">cdist-type__docker_secret(7)</a>)</p></li>
<li><p>__docker_stack (<a class="reference external" href="man7/cdist-type__docker_stack.html">cdist-type__docker_stack(7)</a>)</p></li>
<li><p>__docker_swarm (<a class="reference external" href="man7/cdist-type__docker_swarm.html">cdist-type__docker_swarm(7)</a>)</p></li>
<li><p>__dog_vdi (<a class="reference external" href="man7/cdist-type__dog_vdi.html">cdist-type__dog_vdi(7)</a>)</p></li>
<li><p>__dot_file (<a class="reference external" href="man7/cdist-type__dot_file.html">cdist-type__dot_file(7)</a>)</p></li>
<li><p>__file_old (<a class="reference external" href="man7/cdist-type__file_old.html">cdist-type__file_old(7)</a>)</p></li>
<li><p>__filesystem (<a class="reference external" href="man7/cdist-type__filesystem.html">cdist-type__filesystem(7)</a>)</p></li>
<li><p>__firewalld_rule (<a class="reference external" href="man7/cdist-type__firewalld_rule.html">cdist-type__firewalld_rule(7)</a>)</p></li>
<li><p>__firewalld_start (<a class="reference external" href="man7/cdist-type__firewalld_start.html">cdist-type__firewalld_start(7)</a>)</p></li>
<li><p>__git (<a class="reference external" href="man7/cdist-type__git.html">cdist-type__git(7)</a>)</p></li>
<li><p>__go_get (<a class="reference external" href="man7/cdist-type__go_get.html">cdist-type__go_get(7)</a>)</p></li>
<li><p>__golang_from_vendor (<a class="reference external" href="man7/cdist-type__golang_from_vendor.html">cdist-type__golang_from_vendor(7)</a>)</p></li>
<li><p>__grafana_dashboard (<a class="reference external" href="man7/cdist-type__grafana_dashboard.html">cdist-type__grafana_dashboard(7)</a>)</p></li>
<li><p>__group (<a class="reference external" href="man7/cdist-type__group.html">cdist-type__group(7)</a>)</p></li>
<li><p>__hostname (<a class="reference external" href="man7/cdist-type__hostname.html">cdist-type__hostname(7)</a>)</p></li>
<li><p>__hosts (<a class="reference external" href="man7/cdist-type__hosts.html">cdist-type__hosts(7)</a>)</p></li>
<li><p>__install_bootloader_grub (<a class="reference external" href="man7/cdist-type__install_bootloader_grub.html">cdist-type__install_bootloader_grub(7)</a>)</p></li>
<li><p>__install_chroot_mount (<a class="reference external" href="man7/cdist-type__install_chroot_mount.html">cdist-type__install_chroot_mount(7)</a>)</p></li>
<li><p>__install_chroot_umount (<a class="reference external" href="man7/cdist-type__install_chroot_umount.html">cdist-type__install_chroot_umount(7)</a>)</p></li>
<li><p>__install_config (<a class="reference external" href="man7/cdist-type__install_config.html">cdist-type__install_config(7)</a>)</p></li>
<li><p>__install_coreos (<a class="reference external" href="man7/cdist-type__install_coreos.html">cdist-type__install_coreos(7)</a>)</p></li>
<li><p>__install_directory (<a class="reference external" href="man7/cdist-type__install_directory.html">cdist-type__install_directory(7)</a>)</p></li>
<li><p>__install_file (<a class="reference external" href="man7/cdist-type__install_file.html">cdist-type__install_file(7)</a>)</p></li>
<li><p>__install_fstab (<a class="reference external" href="man7/cdist-type__install_fstab.html">cdist-type__install_fstab(7)</a>)</p></li>
<li><p>__install_generate_fstab (<a class="reference external" href="man7/cdist-type__install_generate_fstab.html">cdist-type__install_generate_fstab(7)</a>)</p></li>
<li><p>__install_mkfs (<a class="reference external" href="man7/cdist-type__install_mkfs.html">cdist-type__install_mkfs(7)</a>)</p></li>
<li><p>__install_mount (<a class="reference external" href="man7/cdist-type__install_mount.html">cdist-type__install_mount(7)</a>)</p></li>
<li><p>__install_partition_msdos (<a class="reference external" href="man7/cdist-type__install_partition_msdos.html">cdist-type__install_partition_msdos(7)</a>)</p></li>
<li><p>__install_partition_msdos_apply (<a class="reference external" href="man7/cdist-type__install_partition_msdos_apply.html">cdist-type__install_partition_msdos_apply(7)</a>)</p></li>
<li><p>__install_reboot (<a class="reference external" href="man7/cdist-type__install_reboot.html">cdist-type__install_reboot(7)</a>)</p></li>
<li><p>__install_reset_disk (<a class="reference external" href="man7/cdist-type__install_reset_disk.html">cdist-type__install_reset_disk(7)</a>)</p></li>
<li><p>__install_stage (<a class="reference external" href="man7/cdist-type__install_stage.html">cdist-type__install_stage(7)</a>)</p></li>
<li><p>__install_umount (<a class="reference external" href="man7/cdist-type__install_umount.html">cdist-type__install_umount(7)</a>)</p></li>
<li><p>__iptables_apply (<a class="reference external" href="man7/cdist-type__iptables_apply.html">cdist-type__iptables_apply(7)</a>)</p></li>
<li><p>__iptables_rule (<a class="reference external" href="man7/cdist-type__iptables_rule.html">cdist-type__iptables_rule(7)</a>)</p></li>
<li><p>__issue (<a class="reference external" href="man7/cdist-type__issue.html">cdist-type__issue(7)</a>)</p></li>
<li><p>__jail (<a class="reference external" href="man7/cdist-type__jail.html">cdist-type__jail(7)</a>)</p></li>
<li><p>__jail_freebsd10 (<a class="reference external" href="man7/cdist-type__jail_freebsd10.html">cdist-type__jail_freebsd10(7)</a>)</p></li>
<li><p>__jail_freebsd9 (<a class="reference external" href="man7/cdist-type__jail_freebsd9.html">cdist-type__jail_freebsd9(7)</a>)</p></li>
<li><p>__key_value (<a class="reference external" href="man7/cdist-type__key_value.html">cdist-type__key_value(7)</a>)</p></li>
<li><p>__keyboard (<a class="reference external" href="man7/cdist-type__keyboard.html">cdist-type__keyboard(7)</a>)</p></li>
<li><p>__letsencrypt_cert (<a class="reference external" href="man7/cdist-type__letsencrypt_cert.html">cdist-type__letsencrypt_cert(7)</a>)</p></li>
<li><p>__line (<a class="reference external" href="man7/cdist-type__line.html">cdist-type__line(7)</a>)</p></li>
<li><p>__link (<a class="reference external" href="man7/cdist-type__link.html">cdist-type__link(7)</a>)</p></li>
<li><p>__locale (<a class="reference external" href="man7/cdist-type__locale.html">cdist-type__locale(7)</a>)</p></li>
<li><p>__locale_system (<a class="reference external" href="man7/cdist-type__locale_system.html">cdist-type__locale_system(7)</a>)</p></li>
<li><p>__motd (<a class="reference external" href="man7/cdist-type__motd.html">cdist-type__motd(7)</a>)</p></li>
<li><p>__mount (<a class="reference external" href="man7/cdist-type__mount.html">cdist-type__mount(7)</a>)</p></li>
<li><p>__mysql_database (<a class="reference external" href="man7/cdist-type__mysql_database.html">cdist-type__mysql_database(7)</a>)</p></li>
<li><p>__mysql_privileges (<a class="reference external" href="man7/cdist-type__mysql_privileges.html">cdist-type__mysql_privileges(7)</a>)</p></li>
<li><p>__mysql_user (<a class="reference external" href="man7/cdist-type__mysql_user.html">cdist-type__mysql_user(7)</a>)</p></li>
<li><p>__openldap_server (<a class="reference external" href="man7/cdist-type__openldap_server.html">cdist-type__openldap_server(7)</a>)</p></li>
<li><p>__package (<a class="reference external" href="man7/cdist-type__package.html">cdist-type__package(7)</a>)</p></li>
<li><p>__package_apk (<a class="reference external" href="man7/cdist-type__package_apk.html">cdist-type__package_apk(7)</a>)</p></li>
<li><p>__package_apt (<a class="reference external" href="man7/cdist-type__package_apt.html">cdist-type__package_apt(7)</a>)</p></li>
<li><p>__package_dpkg (<a class="reference external" href="man7/cdist-type__package_dpkg.html">cdist-type__package_dpkg(7)</a>)</p></li>
<li><p>__package_emerge (<a class="reference external" href="man7/cdist-type__package_emerge.html">cdist-type__package_emerge(7)</a>)</p></li>
<li><p>__package_emerge_dependencies (<a class="reference external" href="man7/cdist-type__package_emerge_dependencies.html">cdist-type__package_emerge_dependencies(7)</a>)</p></li>
<li><p>__package_luarocks (<a class="reference external" href="man7/cdist-type__package_luarocks.html">cdist-type__package_luarocks(7)</a>)</p></li>
<li><p>__package_opkg (<a class="reference external" href="man7/cdist-type__package_opkg.html">cdist-type__package_opkg(7)</a>)</p></li>
<li><p>__package_pacman (<a class="reference external" href="man7/cdist-type__package_pacman.html">cdist-type__package_pacman(7)</a>)</p></li>
<li><p>__package_pip (<a class="reference external" href="man7/cdist-type__package_pip.html">cdist-type__package_pip(7)</a>)</p></li>
<li><p>__package_pkg_freebsd (<a class="reference external" href="man7/cdist-type__package_pkg_freebsd.html">cdist-type__package_pkg_freebsd(7)</a>)</p></li>
<li><p>__package_pkg_openbsd (<a class="reference external" href="man7/cdist-type__package_pkg_openbsd.html">cdist-type__package_pkg_openbsd(7)</a>)</p></li>
<li><p>__package_pkgng_freebsd (<a class="reference external" href="man7/cdist-type__package_pkgng_freebsd.html">cdist-type__package_pkgng_freebsd(7)</a>)</p></li>
<li><p>__package_rubygem (<a class="reference external" href="man7/cdist-type__package_rubygem.html">cdist-type__package_rubygem(7)</a>)</p></li>
<li><p>__package_update_index (<a class="reference external" href="man7/cdist-type__package_update_index.html">cdist-type__package_update_index(7)</a>)</p></li>
<li><p>__package_upgrade_all (<a class="reference external" href="man7/cdist-type__package_upgrade_all.html">cdist-type__package_upgrade_all(7)</a>)</p></li>
<li><p>__package_yum (<a class="reference external" href="man7/cdist-type__package_yum.html">cdist-type__package_yum(7)</a>)</p></li>
<li><p>__package_zypper (<a class="reference external" href="man7/cdist-type__package_zypper.html">cdist-type__package_zypper(7)</a>)</p></li>
<li><p>__pacman_conf (<a class="reference external" href="man7/cdist-type__pacman_conf.html">cdist-type__pacman_conf(7)</a>)</p></li>
<li><p>__pacman_conf_integrate (<a class="reference external" href="man7/cdist-type__pacman_conf_integrate.html">cdist-type__pacman_conf_integrate(7)</a>)</p></li>
<li><p>__pf_apply (<a class="reference external" href="man7/cdist-type__pf_apply.html">cdist-type__pf_apply(7)</a>)</p></li>
<li><p>__pf_apply_anchor (<a class="reference external" href="man7/cdist-type__pf_apply_anchor.html">cdist-type__pf_apply_anchor(7)</a>)</p></li>
<li><p>__pf_ruleset (<a class="reference external" href="man7/cdist-type__pf_ruleset.html">cdist-type__pf_ruleset(7)</a>)</p></li>
<li><p>__ping (<a class="reference external" href="man7/cdist-type__ping.html">cdist-type__ping(7)</a>)</p></li>
<li><p>__postfix (<a class="reference external" href="man7/cdist-type__postfix.html">cdist-type__postfix(7)</a>)</p></li>
<li><p>__postfix_master (<a class="reference external" href="man7/cdist-type__postfix_master.html">cdist-type__postfix_master(7)</a>)</p></li>
<li><p>__postfix_postconf (<a class="reference external" href="man7/cdist-type__postfix_postconf.html">cdist-type__postfix_postconf(7)</a>)</p></li>
<li><p>__postfix_postmap (<a class="reference external" href="man7/cdist-type__postfix_postmap.html">cdist-type__postfix_postmap(7)</a>)</p></li>
<li><p>__postfix_reload (<a class="reference external" href="man7/cdist-type__postfix_reload.html">cdist-type__postfix_reload(7)</a>)</p></li>
<li><p>__postgres_database (<a class="reference external" href="man7/cdist-type__postgres_database.html">cdist-type__postgres_database(7)</a>)</p></li>
<li><p>__postgres_extension (<a class="reference external" href="man7/cdist-type__postgres_extension.html">cdist-type__postgres_extension(7)</a>)</p></li>
<li><p>__postgres_role (<a class="reference external" href="man7/cdist-type__postgres_role.html">cdist-type__postgres_role(7)</a>)</p></li>
<li><p>__process (<a class="reference external" href="man7/cdist-type__process.html">cdist-type__process(7)</a>)</p></li>
<li><p>__prometheus_alertmanager (<a class="reference external" href="man7/cdist-type__prometheus_alertmanager.html">cdist-type__prometheus_alertmanager(7)</a>)</p></li>
<li><p>__prometheus_exporter (<a class="reference external" href="man7/cdist-type__prometheus_exporter.html">cdist-type__prometheus_exporter(7)</a>)</p></li>
<li><p>__prometheus_server (<a class="reference external" href="man7/cdist-type__prometheus_server.html">cdist-type__prometheus_server(7)</a>)</p></li>
<li><p>__pyvenv (<a class="reference external" href="man7/cdist-type__pyvenv.html">cdist-type__pyvenv(7)</a>)</p></li>
<li><p>__qemu_img (<a class="reference external" href="man7/cdist-type__qemu_img.html">cdist-type__qemu_img(7)</a>)</p></li>
<li><p>__rbenv (<a class="reference external" href="man7/cdist-type__rbenv.html">cdist-type__rbenv(7)</a>)</p></li>
<li><p>__rsync (<a class="reference external" href="man7/cdist-type__rsync.html">cdist-type__rsync(7)</a>)</p></li>
<li><p>__rvm (<a class="reference external" href="man7/cdist-type__rvm.html">cdist-type__rvm(7)</a>)</p></li>
<li><p>__rvm_gem (<a class="reference external" href="man7/cdist-type__rvm_gem.html">cdist-type__rvm_gem(7)</a>)</p></li>
<li><p>__rvm_gemset (<a class="reference external" href="man7/cdist-type__rvm_gemset.html">cdist-type__rvm_gemset(7)</a>)</p></li>
<li><p>__rvm_ruby (<a class="reference external" href="man7/cdist-type__rvm_ruby.html">cdist-type__rvm_ruby(7)</a>)</p></li>
<li><p>__sensible_editor (<a class="reference external" href="man7/cdist-type__sensible_editor.html">cdist-type__sensible_editor(7)</a>)</p></li>
<li><p>__service (<a class="reference external" href="man7/cdist-type__service.html">cdist-type__service(7)</a>)</p></li>
<li><p>__ssh_authorized_key (<a class="reference external" href="man7/cdist-type__ssh_authorized_key.html">cdist-type__ssh_authorized_key(7)</a>)</p></li>
<li><p>__ssh_authorized_keys (<a class="reference external" href="man7/cdist-type__ssh_authorized_keys.html">cdist-type__ssh_authorized_keys(7)</a>)</p></li>
<li><p>__ssh_dot_ssh (<a class="reference external" href="man7/cdist-type__ssh_dot_ssh.html">cdist-type__ssh_dot_ssh(7)</a>)</p></li>
<li><p>__staged_file (<a class="reference external" href="man7/cdist-type__staged_file.html">cdist-type__staged_file(7)</a>)</p></li>
<li><p>__start_on_boot (<a class="reference external" href="man7/cdist-type__start_on_boot.html">cdist-type__start_on_boot(7)</a>)</p></li>
<li><p>__sysctl (<a class="reference external" href="man7/cdist-type__sysctl.html">cdist-type__sysctl(7)</a>)</p></li>
<li><p>__systemd_service (<a class="reference external" href="man7/cdist-type__systemd_service.html">cdist-type__systemd_service(7)</a>)</p></li>
<li><p>__systemd_unit (<a class="reference external" href="man7/cdist-type__systemd_unit.html">cdist-type__systemd_unit(7)</a>)</p></li>
<li><p>__timezone (<a class="reference external" href="man7/cdist-type__timezone.html">cdist-type__timezone(7)</a>)</p></li>
<li><p>__ufw (<a class="reference external" href="man7/cdist-type__ufw.html">cdist-type__ufw(7)</a>)</p></li>
<li><p>__ufw_rule (<a class="reference external" href="man7/cdist-type__ufw_rule.html">cdist-type__ufw_rule(7)</a>)</p></li>
<li><p>__update_alternatives (<a class="reference external" href="man7/cdist-type__update_alternatives.html">cdist-type__update_alternatives(7)</a>)</p></li>
<li><p>__user (<a class="reference external" href="man7/cdist-type__user.html">cdist-type__user(7)</a>)</p></li>
<li><p>__user_groups (<a class="reference external" href="man7/cdist-type__user_groups.html">cdist-type__user_groups(7)</a>)</p></li>
<li><p>__xymon_apache (<a class="reference external" href="man7/cdist-type__xymon_apache.html">cdist-type__xymon_apache(7)</a>)</p></li>
<li><p>__xymon_client (<a class="reference external" href="man7/cdist-type__xymon_client.html">cdist-type__xymon_client(7)</a>)</p></li>
<li><p>__xymon_config (<a class="reference external" href="man7/cdist-type__xymon_config.html">cdist-type__xymon_config(7)</a>)</p></li>
<li><p>__xymon_server (<a class="reference external" href="man7/cdist-type__xymon_server.html">cdist-type__xymon_server(7)</a>)</p></li>
<li><p>__yum_repo (<a class="reference external" href="man7/cdist-type__yum_repo.html">cdist-type__yum_repo(7)</a>)</p></li>
<li><p>__zypper_repo (<a class="reference external" href="man7/cdist-type__zypper_repo.html">cdist-type__zypper_repo(7)</a>)</p></li>
<li><p>__zypper_service (<a class="reference external" href="man7/cdist-type__zypper_service.html">cdist-type__zypper_service(7)</a>)</p></li>
</ul>
</div>
<div class="section" id="objects">
<h2>24.4. Objects<a class="headerlink" href="#objects" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">24.4. </span>Objects<a class="headerlink" href="#objects" title="Permalink to this headline"></a></h2>
<p>For object to object communication and tests, the following paths are
usable within a object directory:</p>
<dl class="docutils">
<dt>files</dt>
<dd>This directory is reserved for user data and will not be used
<dl class="simple">
<dt>files</dt><dd><p>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).</dd>
<dt>changed</dt>
<dd>This empty file exists in an object directory, if the object has
code to be executed (either remote or local).</dd>
<dt>stdin</dt>
<dd>This file exists and contains data, if data was provided on stdin
when the type was called.</dd>
(for instance to store template results).</p>
</dd>
<dt>changed</dt><dd><p>This empty file exists in an object directory, if the object has
code to be executed (either remote or local).</p>
</dd>
<dt>stdin</dt><dd><p>This file exists and contains data, if data was provided on stdin
when the type was called.</p>
</dd>
</dl>
</div>
<div class="section" id="environment-variables-for-reading">
<h2>24.5. Environment variables (for reading)<a class="headerlink" href="#environment-variables-for-reading" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">24.5. </span>Environment variables (for reading)<a class="headerlink" href="#environment-variables-for-reading" title="Permalink to this headline"></a></h2>
<p>The following environment variables are exported by cdist:</p>
<dl class="docutils">
<dt>__cdist_log_level, __cdist_log_level_name</dt>
<dd><p class="first">cdist log level value and cdist log level name. One of:</p>
<table border="1" class="docutils">
<dl>
<dt>__cdist_log_level, __cdist_log_level_name</dt><dd><p>cdist log level value and cdist log level name. One of:</p>
<table class="docutils align-default">
<colgroup>
<col width="48%" />
<col width="52%" />
<col style="width: 48%" />
<col style="width: 52%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Log level name</th>
<th class="head">Log level value</th>
<thead>
<tr class="row-odd"><th class="head"><p>Log level name</p></th>
<th class="head"><p>Log level value</p></th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>OFF</td>
<td>60</td>
<tbody>
<tr class="row-even"><td><p>OFF</p></td>
<td><p>60</p></td>
</tr>
<tr class="row-odd"><td>ERROR</td>
<td>40</td>
<tr class="row-odd"><td><p>ERROR</p></td>
<td><p>40</p></td>
</tr>
<tr class="row-even"><td>WARNING</td>
<td>30</td>
<tr class="row-even"><td><p>WARNING</p></td>
<td><p>30</p></td>
</tr>
<tr class="row-odd"><td>INFO</td>
<td>20</td>
<tr class="row-odd"><td><p>INFO</p></td>
<td><p>20</p></td>
</tr>
<tr class="row-even"><td>VERBOSE</td>
<td>15</td>
<tr class="row-even"><td><p>VERBOSE</p></td>
<td><p>15</p></td>
</tr>
<tr class="row-odd"><td>DEBUG</td>
<td>10</td>
<tr class="row-odd"><td><p>DEBUG</p></td>
<td><p>10</p></td>
</tr>
<tr class="row-even"><td>TRACE</td>
<td>5</td>
<tr class="row-even"><td><p>TRACE</p></td>
<td><p>5</p></td>
</tr>
</tbody>
</table>
<p class="last">Available for: initial manifest, explorer, type manifest, type explorer,
<p>Available for: initial manifest, explorer, type manifest, type explorer,
type gencode.</p>
</dd>
<dt>__cdist_dry_run</dt>
<dd>Is set only when doing dry run (-n flag).
Available for: initial manifest, explorer, type manifest, type explorer,
type gencode.</dd>
<dt>__explorer</dt>
<dd>Directory that contains all global explorers.
Available for: initial manifest, explorer, type explorer, shell.</dd>
<dt>__files</dt>
<dd>Directory that contains content from the &quot;files&quot; subdirectories
from the configuration directories.
Available for: initial manifest, type manifest, type gencode, shell.</dd>
<dt>__manifest</dt>
<dd>Directory that contains the initial manifest.
Available for: initial manifest, type manifest, shell.</dd>
<dt>__global</dt>
<dd>Directory that contains generic output like explorer.
Available for: initial manifest, type manifest, type gencode, shell.</dd>
<dt>__messages_in</dt>
<dd>File to read messages from.
Available for: initial manifest, type manifest, type gencode.</dd>
<dt>__messages_out</dt>
<dd>File to write messages.
Available for: initial manifest, type manifest, type gencode.</dd>
<dt>__object</dt>
<dd>Directory that contains the current object.
Available for: type manifest, type explorer, type gencode and code scripts.</dd>
<dt>__object_id</dt>
<dd>The type unique object id.
Available for: type manifest, type explorer, type gencode and code scripts.
Note: The leading and the trailing &quot;/&quot; will always be stripped (caused by
the filesystem database and ensured by the core).
Note: Double slashes (&quot;//&quot;) will not be fixed and result in an error.</dd>
<dt>__object_name</dt>
<dd>The full qualified name of the current object.
Available for: type manifest, type explorer, type gencode.</dd>
<dt>__target_host</dt>
<dd>The host we are deploying to. This is primary variable. It's content is
literally the one user passed in.
Available for: explorer, initial manifest, type explorer, type manifest, type gencode, shell.</dd>
<dt>__target_hostname</dt>
<dd>The hostname of host we are deploying to. This variable is derived from
<dt>__cdist_colored_log</dt><dd><p>whether or not cdist's log has colors enabled.
Is set to the string true if cdist's output is using colors,
otherwise the variable contains the string false.</p>
<p>Available for: initial manifest, explorer, type manifest, type explorer,
type gencode.</p>
</dd>
<dt>__cdist_dry_run</dt><dd><p>Is set only when doing dry run (-n flag).</p>
<p>Available for: initial manifest, explorer, type manifest, type explorer,
type gencode.</p>
</dd>
<dt>__explorer</dt><dd><p>Directory that contains all global explorers.</p>
<p>Available for: initial manifest, explorer, type explorer, shell.</p>
</dd>
<dt>__files</dt><dd><p>Directory that contains content from the &quot;files&quot; subdirectories
from the configuration directories.</p>
<p>Available for: initial manifest, type manifest, type gencode, shell.</p>
</dd>
<dt>__manifest</dt><dd><p>Directory that contains the initial manifest.</p>
<p>Available for: initial manifest, type manifest, shell.</p>
</dd>
<dt>__global</dt><dd><p>Directory that contains generic output like explorer.</p>
<p>Available for: initial manifest, type manifest, type gencode, shell.</p>
</dd>
<dt>__messages_in</dt><dd><p>File to read messages from.</p>
<p>Available for: initial manifest, type manifest, type gencode.</p>
</dd>
<dt>__messages_out</dt><dd><p>File to write messages.</p>
<p>Available for: initial manifest, type manifest, type gencode.</p>
</dd>
<dt>__object</dt><dd><p>Directory that contains the current object.</p>
<p>Available for: type manifest, type explorer, type gencode and code scripts.</p>
</dd>
<dt>__object_id</dt><dd><p>The type unique object id.</p>
<p>Available for: type manifest, type explorer, type gencode and code scripts.</p>
<div class="line-block">
<div class="line">Note: The leading and the trailing &quot;/&quot; will always be stripped (caused by
the filesystem database and ensured by the core).</div>
<div class="line">Note: Double slashes (&quot;//&quot;) will not be fixed and result in an error.</div>
</div>
</dd>
<dt>__object_name</dt><dd><p>The full qualified name of the current object.</p>
<p>Available for: type manifest, type explorer, type gencode.</p>
</dd>
<dt>__target_host</dt><dd><p>The host we are deploying to. This is primary variable. It's content is
literally the one user passed in.</p>
<p>Available for: explorer, initial manifest, type explorer, type manifest, type gencode, shell.</p>
</dd>
<dt>__target_hostname</dt><dd><p>The hostname of host we are deploying to. This variable is derived from
<strong>__target_host</strong> (using <strong>socket.getaddrinfo(__target_host)</strong> and then
<strong>socket.gethostbyaddr()</strong>).
Available for: explorer, initial manifest, type explorer, type manifest, type gencode, shell.</dd>
<dt>__target_fqdn</dt>
<dd>The fully qualified domain name of the host we are deploying to.
<strong>socket.gethostbyaddr()</strong>).</p>
<p>Available for: explorer, initial manifest, type explorer, type manifest, type gencode, shell.</p>
</dd>
<dt>__target_fqdn</dt><dd><p>The fully qualified domain name of the host we are deploying to.
This variable is derived from <strong>__target_host</strong>
(using <strong>socket.getfqdn()</strong>).
Available for: explorer, initial manifest, type explorer, type manifest, type gencode, shell.</dd>
<dt>__target_host_tags</dt>
<dd>Comma separated list of target host tags.
Available for: explorer, initial manifest, type explorer, type manifest, type gencode, shell.</dd>
<dt>__type</dt>
<dd>Path to the current type.
Available for: type manifest, type gencode.</dd>
<dt>__type_explorer</dt>
<dd>Directory that contains the type explorers.
Available for: type explorer.</dd>
(using <strong>socket.getfqdn()</strong>).</p>
<p>Available for: explorer, initial manifest, type explorer, type manifest, type gencode, shell.</p>
</dd>
<dt>__target_host_tags</dt><dd><p>Comma separated list of target host tags.</p>
<p>Available for: explorer, initial manifest, type explorer, type manifest, type gencode, shell.</p>
</dd>
<dt>__type</dt><dd><p>Path to the current type.</p>
<p>Available for: type manifest, type gencode.</p>
</dd>
<dt>__type_explorer</dt><dd><p>Directory that contains the type explorers.</p>
<p>Available for: type explorer.</p>
</dd>
</dl>
</div>
<div class="section" id="environment-variables-for-writing">
<h2>24.6. Environment variables (for writing)<a class="headerlink" href="#environment-variables-for-writing" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">24.6. </span>Environment variables (for writing)<a class="headerlink" href="#environment-variables-for-writing" title="Permalink to this headline"></a></h2>
<p>The following environment variables influence the behaviour of cdist:</p>
<dl class="docutils">
<dt>require</dt>
<dd>Setup dependencies between objects (see <a class="reference external" href="cdist-manifest.html">cdist manifest</a>).</dd>
<dt>__cdist_log_level</dt>
<dd><p class="first">cdist log level value. One of:</p>
<table border="1" class="docutils">
<dl>
<dt>require</dt><dd><p>Setup dependencies between objects (see <a class="reference external" href="cdist-manifest.html">cdist manifest</a>).</p>
</dd>
<dt>__cdist_log_level</dt><dd><p>cdist log level value. One of:</p>
<table class="docutils align-default">
<colgroup>
<col width="48%" />
<col width="52%" />
<col style="width: 48%" />
<col style="width: 52%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Log level</th>
<th class="head">Log level value</th>
<thead>
<tr class="row-odd"><th class="head"><p>Log level</p></th>
<th class="head"><p>Log level value</p></th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>OFF</td>
<td>60</td>
<tbody>
<tr class="row-even"><td><p>OFF</p></td>
<td><p>60</p></td>
</tr>
<tr class="row-odd"><td>ERROR</td>
<td>40</td>
<tr class="row-odd"><td><p>ERROR</p></td>
<td><p>40</p></td>
</tr>
<tr class="row-even"><td>WARNING</td>
<td>30</td>
<tr class="row-even"><td><p>WARNING</p></td>
<td><p>30</p></td>
</tr>
<tr class="row-odd"><td>INFO</td>
<td>20</td>
<tr class="row-odd"><td><p>INFO</p></td>
<td><p>20</p></td>
</tr>
<tr class="row-even"><td>VERBOSE</td>
<td>15</td>
<tr class="row-even"><td><p>VERBOSE</p></td>
<td><p>15</p></td>
</tr>
<tr class="row-odd"><td>DEBUG</td>
<td>10</td>
<tr class="row-odd"><td><p>DEBUG</p></td>
<td><p>10</p></td>
</tr>
<tr class="row-even"><td>TRACE</td>
<td>5</td>
<tr class="row-even"><td><p>TRACE</p></td>
<td><p>5</p></td>
</tr>
</tbody>
</table>
<p class="last">If set cdist will set this log level in
<p>If set cdist will set this log level in
accordance with configuration rules. If cdist invokation is used
in types then nested cdist will honor this specified log level if
not specified otherwise while invoking it.</p>
</dd>
<dt>CDIST_PATH</dt>
<dd>Colon delimited list of config directories.</dd>
<dt>CDIST_LOCAL_SHELL</dt>
<dd>Use this shell locally instead of /bin/sh to execute scripts.</dd>
<dt>CDIST_REMOTE_SHELL</dt>
<dd>Use this shell remotely instead of /bin/sh to execute scripts.</dd>
<dt>CDIST_OVERRIDE</dt>
<dd>Allow overwriting type parameters (see <a class="reference external" href="cdist-manifest.html">cdist manifest</a>).</dd>
<dt>CDIST_ORDER_DEPENDENCY</dt>
<dd>Create dependencies based on the execution order (see <a class="reference external" href="cdist-manifest.html">cdist manifest</a>).
Note that in version 6.2.0 semantic of this processing mode is finally fixed and well defined.</dd>
<dt>CDIST_REMOTE_EXEC</dt>
<dd>Use this command for remote execution (should behave like ssh).</dd>
<dt>CDIST_REMOTE_COPY</dt>
<dd>Use this command for remote copy (should behave like scp).</dd>
<dt>CDIST_INVENTORY_DIR</dt>
<dd>Use this directory as inventory directory.</dd>
<dt>CDIST_BETA</dt>
<dd>Enable beta functionalities.</dd>
<dt>CDIST_CACHE_PATH_PATTERN</dt>
<dd>Custom cache path pattern.</dd>
<dt>CDIST_PATH</dt><dd><p>Colon delimited list of config directories.</p>
</dd>
<dt>CDIST_LOCAL_SHELL</dt><dd><p>Use this shell locally instead of /bin/sh to execute scripts.</p>
</dd>
<dt>CDIST_REMOTE_SHELL</dt><dd><p>Use this shell remotely instead of /bin/sh to execute scripts.</p>
</dd>
<dt>CDIST_OVERRIDE</dt><dd><p>Allow overwriting type parameters (see <a class="reference external" href="cdist-manifest.html">cdist manifest</a>).</p>
</dd>
<dt>CDIST_ORDER_DEPENDENCY</dt><dd><p>Create dependencies based on the execution order (see <a class="reference external" href="cdist-manifest.html">cdist manifest</a>).
Note that in version 6.2.0 semantic of this processing mode is finally fixed and well defined.</p>
</dd>
<dt>CDIST_REMOTE_EXEC</dt><dd><p>Use this command for remote execution (should behave like ssh).</p>
</dd>
<dt>CDIST_REMOTE_COPY</dt><dd><p>Use this command for remote copy (should behave like scp).</p>
</dd>
<dt>CDIST_INVENTORY_DIR</dt><dd><p>Use this directory as inventory directory.</p>
</dd>
<dt>CDIST_BETA</dt><dd><p>Enable beta functionalities.</p>
</dd>
<dt>CDIST_COLORED_OUTPUT</dt><dd><p>Colorize cdist's output. If enabled, cdist will use different colors for
different log levels.
Recognized values are 'always', 'never', and 'auto' (the default).</p>
</dd>
<dt>CDIST_CACHE_PATH_PATTERN</dt><dd><p>Custom cache path pattern.</p>
</dd>
</dl>
</div>
</div>

33
src/extra/manual/beta/cdist-remote-exec-copy.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>29. Remote exec and copy commands &mdash; cdist 6.5.6 documentation</title>
<title>29. Remote exec and copy commands &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -173,7 +164,7 @@
<li><a href="index.html">Docs</a> &raquo;</li>
<li>29. Remote exec and copy commands</li>
<li><span class="section-number">29. </span>Remote exec and copy commands</li>
<li class="wy-breadcrumbs-aside">
@ -193,15 +184,15 @@
<div itemprop="articleBody">
<div class="section" id="remote-exec-and-copy-commands">
<h1>29. Remote exec and copy commands<a class="headerlink" href="#remote-exec-and-copy-commands" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">29. </span>Remote exec and copy commands<a class="headerlink" href="#remote-exec-and-copy-commands" title="Permalink to this headline"></a></h1>
<p>Cdist interacts with the target host in two ways:</p>
<ul class="simple">
<li>it executes code (__remote_exec)</li>
<li>and it copies files (__remote_copy)</li>
<li><p>it executes code (__remote_exec)</p></li>
<li><p>and it copies files (__remote_copy)</p></li>
</ul>
<p>By default this is accomplished with ssh and scp respectively.
The default implementations used by cdist are:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">__remote_exec</span><span class="p">:</span> <span class="n">ssh</span> <span class="o">-</span><span class="n">o</span> <span class="n">User</span><span class="o">=</span><span class="n">root</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">__remote_exec</span><span class="p">:</span> <span class="n">ssh</span> <span class="o">-</span><span class="n">o</span> <span class="n">User</span><span class="o">=</span><span class="n">root</span>
<span class="n">__remote_copy</span><span class="p">:</span> <span class="n">scp</span> <span class="o">-</span><span class="n">o</span> <span class="n">User</span><span class="o">=</span><span class="n">root</span>
</pre></div>
</div>

33
src/extra/manual/beta/cdist-saving-output-streams.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>28. Saving output streams &mdash; cdist 6.5.6 documentation</title>
<title>28. Saving output streams &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -176,7 +167,7 @@
<li><a href="index.html">Docs</a> &raquo;</li>
<li>28. Saving output streams</li>
<li><span class="section-number">28. </span>Saving output streams</li>
<li class="wy-breadcrumbs-aside">
@ -196,9 +187,9 @@
<div itemprop="articleBody">
<div class="section" id="saving-output-streams">
<h1>28. Saving output streams<a class="headerlink" href="#saving-output-streams" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">28. </span>Saving output streams<a class="headerlink" href="#saving-output-streams" title="Permalink to this headline"></a></h1>
<div class="section" id="description">
<h2>28.1. Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">28.1. </span>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Since version 4.8.0 cdist, by default, saves output streams to local cache.
Saving output streams is implemented because important information was lost
during a config run, hidden in all other output.
@ -210,7 +201,7 @@ on these cache files see <a class="reference external" href="cdist-cache.html">L
<p>Also, in case of an error, cdist can now exit and show all information it has
about the error.</p>
<p>For example:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>$ ./bin/cdist config -v -i ~/.cdist/manifest/init-output-streams <span class="k">$(</span>cat ~/ungleich/data/opennebula-debian9-test <span class="k">)</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ ./bin/cdist config -v -i ~/.cdist/manifest/init-output-streams <span class="k">$(</span>cat ~/ungleich/data/opennebula-debian9-test <span class="k">)</span>
INFO: <span class="m">185</span>.203.112.42: Starting configuration run
INFO: <span class="m">185</span>.203.112.42: Processing __myline/test
ERROR: <span class="m">185</span>.203.112.42: Command failed: <span class="s1">&#39;/bin/sh -e /tmp/tmpow6cwemh/75ee6a79e32da093da23fe4a13dd104b/data/object/__myline/test/.cdist-kisrqlpw/code-local&#39;</span>
@ -250,7 +241,7 @@ discovered.</p>
<p>There is also an option <strong>-S/--disable-saving-output-streams</strong> for
disabling saving output streams. In this case error reporting can look
like this:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>$ ./bin/cdist config -v -S -i ~/.cdist/manifest/init-output-streams <span class="k">$(</span>cat ~/ungleich/data/opennebula-debian9-test <span class="k">)</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ ./bin/cdist config -v -S -i ~/.cdist/manifest/init-output-streams <span class="k">$(</span>cat ~/ungleich/data/opennebula-debian9-test <span class="k">)</span>
INFO: <span class="m">185</span>.203.112.42: Starting configuration run
<span class="nb">test</span> stdout output streams
<span class="nb">test</span> stderr output streams

45
src/extra/manual/beta/cdist-stages.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>26. Execution stages &mdash; cdist 6.5.6 documentation</title>
<title>26. Execution stages &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -184,7 +175,7 @@
<li><a href="index.html">Docs</a> &raquo;</li>
<li>26. Execution stages</li>
<li><span class="section-number">26. </span>Execution stages</li>
<li class="wy-breadcrumbs-aside">
@ -204,20 +195,20 @@
<div itemprop="articleBody">
<div class="section" id="execution-stages">
<h1>26. Execution stages<a class="headerlink" href="#execution-stages" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">26. </span>Execution stages<a class="headerlink" href="#execution-stages" title="Permalink to this headline"></a></h1>
<div class="section" id="description">
<h2>26.1. Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">26.1. </span>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>When cdist is started, it passes through different stages.</p>
</div>
<div class="section" id="stage-1-target-information-retrieval">
<h2>26.2. Stage 1: target information retrieval<a class="headerlink" href="#stage-1-target-information-retrieval" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">26.2. </span>Stage 1: target information retrieval<a class="headerlink" href="#stage-1-target-information-retrieval" title="Permalink to this headline"></a></h2>
<p>In this stage information is collected about the target host using so called
explorers. Every existing explorer is run on the target and the output of all
explorers are copied back into the local cache. The results can be used by
manifests and types.</p>
</div>
<div class="section" id="stage-2-run-the-initial-manifest">
<h2>26.3. Stage 2: run the initial manifest<a class="headerlink" href="#stage-2-run-the-initial-manifest" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">26.3. </span>Stage 2: run the initial manifest<a class="headerlink" href="#stage-2-run-the-initial-manifest" title="Permalink to this headline"></a></h2>
<p>The initial manifest, which should be used for mappings of hosts to types,
is executed. This stage creates objects in a cconfig database that contains
the objects as defined in the manifest for the specific host. In this stage,
@ -225,14 +216,14 @@ no conflicts may occur, i.e. no object of the same type with the same id may
be created, if it has different parameters.</p>
</div>
<div class="section" id="stage-3-object-information-retrieval">
<h2>26.4. Stage 3: object information retrieval<a class="headerlink" href="#stage-3-object-information-retrieval" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">26.4. </span>Stage 3: object information retrieval<a class="headerlink" href="#stage-3-object-information-retrieval" title="Permalink to this headline"></a></h2>
<p>Every object is checked whether its type has explorers and if so, these are
executed on the target host. The results are transferred back
and can be used in the following stages to decide what changes need to be made
on the target to implement the desired state.</p>
</div>
<div class="section" id="stage-4-run-the-object-manifest">
<h2>26.5. Stage 4: run the object manifest<a class="headerlink" href="#stage-4-run-the-object-manifest" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">26.5. </span>Stage 4: run the object manifest<a class="headerlink" href="#stage-4-run-the-object-manifest" title="Permalink to this headline"></a></h2>
<p>Every object is checked whether its type has a executable manifest. The
manifest script may generate and change the created objects. In other words,
one type can reuse other types.</p>
@ -243,23 +234,23 @@ may occur during the merge. A conflict would mean that two different objects
try to create the same object, which indicates a broken configuration.</p>
</div>
<div class="section" id="stage-5-code-generation">
<h2>26.6. Stage 5: code generation<a class="headerlink" href="#stage-5-code-generation" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">26.6. </span>Stage 5: code generation<a class="headerlink" href="#stage-5-code-generation" title="Permalink to this headline"></a></h2>
<p>In this stage for every created object its type is checked for executable
gencode scripts. The gencode scripts generate the code to be executed on the
target on stdout. If the gencode executables fail, they must print diagnostic
messages on stderr and exit non-zero.</p>
</div>
<div class="section" id="stage-6-code-execution">
<h2>26.7. Stage 6: code execution<a class="headerlink" href="#stage-6-code-execution" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">26.7. </span>Stage 6: code execution<a class="headerlink" href="#stage-6-code-execution" title="Permalink to this headline"></a></h2>
<p>For every object the resulting code from the previous stage is transferred to
the target host and executed there to apply the configuration changes.</p>
</div>
<div class="section" id="stage-7-cache">
<h2>26.8. Stage 7: cache<a class="headerlink" href="#stage-7-cache" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">26.8. </span>Stage 7: cache<a class="headerlink" href="#stage-7-cache" title="Permalink to this headline"></a></h2>
<p>The cache stores the information from the current run for later use.</p>
</div>
<div class="section" id="summary">
<h2>26.9. Summary<a class="headerlink" href="#summary" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">26.9. </span>Summary<a class="headerlink" href="#summary" title="Permalink to this headline"></a></h2>
<p>If, and only if, all the stages complete without errors, the configuration
will be applied to the target.</p>
</div>

35
src/extra/manual/beta/cdist-support.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>6. Support &mdash; cdist 6.5.6 documentation</title>
<title>6. Support &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -179,7 +170,7 @@
<li><a href="index.html">Docs</a> &raquo;</li>
<li>6. Support</li>
<li><span class="section-number">6. </span>Support</li>
<li class="wy-breadcrumbs-aside">
@ -199,25 +190,25 @@
<div itemprop="articleBody">
<div class="section" id="support">
<h1>6. Support<a class="headerlink" href="#support" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">6. </span>Support<a class="headerlink" href="#support" title="Permalink to this headline"></a></h1>
<div class="section" id="chat">
<h2>6.1. Chat<a class="headerlink" href="#chat" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">6.1. </span>Chat<a class="headerlink" href="#chat" title="Permalink to this headline"></a></h2>
<p>Chat with us on <a class="reference external" href="https://ungleich.ch/u/projects/open-chat/">#cdist:ungleich.ch</a>.</p>
</div>
<div class="section" id="mailing-list">
<h2>6.2. Mailing list<a class="headerlink" href="#mailing-list" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">6.2. </span>Mailing list<a class="headerlink" href="#mailing-list" title="Permalink to this headline"></a></h2>
<p>Bug reports, questions, patches, etc. should be send to the
<a class="reference external" href="https://groups.google.com/forum/#!forum/cdist-configuration-management">cdist mailing list</a>.</p>
</div>
<div class="section" id="linkedin">
<h2>6.3. Linkedin<a class="headerlink" href="#linkedin" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">6.3. </span>Linkedin<a class="headerlink" href="#linkedin" title="Permalink to this headline"></a></h2>
<p>If you have an account
at <a class="reference external" href="http://www.linkedin.com/">Linked in</a>,
you can join the
<a class="reference external" href="http://www.linkedin.com/groups/cdist-configuration-management-3952797">cdist group</a>.</p>
</div>
<div class="section" id="commercial-support">
<h2>6.4. Commercial support<a class="headerlink" href="#commercial-support" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">6.4. </span>Commercial support<a class="headerlink" href="#commercial-support" title="Permalink to this headline"></a></h2>
<p>You can request commercial support for cdist from
<a class="reference external" href="http://www.ungleich.ch/">ungleich</a>.</p>
</div>

41
src/extra/manual/beta/cdist-trigger.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>21. Trigger &mdash; cdist 6.5.6 documentation</title>
<title>21. Trigger &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -176,7 +167,7 @@
<li><a href="index.html">Docs</a> &raquo;</li>
<li>21. Trigger</li>
<li><span class="section-number">21. </span>Trigger</li>
<li class="wy-breadcrumbs-aside">
@ -196,19 +187,19 @@
<div itemprop="articleBody">
<div class="section" id="trigger">
<h1>21. Trigger<a class="headerlink" href="#trigger" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">21. </span>Trigger<a class="headerlink" href="#trigger" title="Permalink to this headline"></a></h1>
<div class="section" id="description">
<h2>21.1. Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">21.1. </span>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>cdist supports triggering for host installation/configuration using trigger command.
This command starts trigger server at management node, for example:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>$ cdist trigger -b -v
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ cdist trigger -b -v
</pre></div>
</div>
<p>This will start cdist trigger server in verbose mode. cdist trigger server accepts
simple requests for configuration and for installation:</p>
<ul class="simple">
<li><strong>/cdist/install/</strong> for installation</li>
<li><strong>/cdist/config/</strong> for configuration.</li>
<li><p><strong>/cdist/install/</strong> for installation</p></li>
<li><p><strong>/cdist/config/</strong> for configuration.</p></li>
</ul>
<p>Other configuration parameters are the same as in like cdist config (See <a class="reference external" href="man1/cdist.html">cdist</a>).</p>
<p>Machines can then trigger cdist trigger server with appropriate requests.
@ -221,9 +212,9 @@ host name is dervied then it is used for running cdist config. If no
host name is resolved then IP address is used.</p>
<p>This command returns the following response codes to client requests:</p>
<ul class="simple">
<li>200 for success</li>
<li>599 for cdist run errors</li>
<li>500 for cdist/server errors.</li>
<li><p>200 for success</p></li>
<li><p>599 for cdist run errors</p></li>
<li><p>500 for cdist/server errors.</p></li>
</ul>
</div>
</div>

41
src/extra/manual/beta/cdist-troubleshooting.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>31. Troubleshooting &mdash; cdist 6.5.6 documentation</title>
<title>31. Troubleshooting &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -71,7 +62,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -176,7 +167,7 @@
<li><a href="index.html">Docs</a> &raquo;</li>
<li>31. Troubleshooting</li>
<li><span class="section-number">31. </span>Troubleshooting</li>
<li class="wy-breadcrumbs-aside">
@ -196,13 +187,13 @@
<div itemprop="articleBody">
<div class="section" id="troubleshooting">
<h1>31. Troubleshooting<a class="headerlink" href="#troubleshooting" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">31. </span>Troubleshooting<a class="headerlink" href="#troubleshooting" title="Permalink to this headline"></a></h1>
<div class="section" id="error-in-manifest-is-not-considered-an-error-by-cdist">
<h2>31.1. Error in manifest is not considered an error by cdist<a class="headerlink" href="#error-in-manifest-is-not-considered-an-error-by-cdist" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">31.1. </span>Error in manifest is not considered an error by cdist<a class="headerlink" href="#error-in-manifest-is-not-considered-an-error-by-cdist" title="Permalink to this headline"></a></h2>
<p>Situation: You are executing other scripts from a manifest.
This script fails, but cdist does not recognise the error.
An example script would be something like this:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>% cat ~/.cdist/manifest/init
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>% cat ~/.cdist/manifest/init
<span class="s2">&quot;</span><span class="nv">$__manifest</span><span class="s2">/special&quot;</span>
% cat ~/.cdist/manifest/special
<span class="c1">#!/bin/sh</span>
@ -219,7 +210,7 @@ code of the last echo line instead of the failing command.</p>
<p>All scripts executed by cdist carry the -e flag.
To prevent the above from happening, there are three solutions available,
two of which can be used in the calling script:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># Execute as before, but abort on failure</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Execute as before, but abort on failure</span>
sh -e <span class="s2">&quot;</span><span class="nv">$__manifest</span><span class="s2">/special&quot;</span>
<span class="c1"># Source the script in our namespace, runs in a set -e environment:</span>
@ -228,23 +219,23 @@ sh -e <span class="s2">&quot;</span><span class="nv">$__manifest</span><span cla
</div>
<p>The third solution is to include a shebang header in every script
you write to use the -e flag:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>% cat ~/.cdist/manifest/special
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>% cat ~/.cdist/manifest/special
<span class="c1">#!/bin/sh -e</span>
...
</pre></div>
</div>
</div>
<div class="section" id="using-debug-dump-helper-script">
<h2>31.2. Using debug dump helper script<a class="headerlink" href="#using-debug-dump-helper-script" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">31.2. </span>Using debug dump helper script<a class="headerlink" href="#using-debug-dump-helper-script" title="Permalink to this headline"></a></h2>
<p>Since cdist stores data to local cache that can be used for debugging there
is a helper script that dumps data from local cache,
<a class="reference external" href="man1/cdist-dump.html">cdist-dump</a>.</p>
<p>For more info see:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>cdist-dump -h
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cdist-dump -h
</pre></div>
</div>
<p>Or from cdist git cloned directory:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>./scripts/cdist-dump -h
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>./scripts/cdist-dump -h
</pre></div>
</div>
</div>

223
src/extra/manual/beta/cdist-type.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>15. cdist type &mdash; cdist 6.5.6 documentation</title>
<title>15. cdist type &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -204,7 +195,7 @@
<li><a href="index.html">Docs</a> &raquo;</li>
<li>15. cdist type</li>
<li><span class="section-number">15. </span>cdist type</li>
<li class="wy-breadcrumbs-aside">
@ -224,25 +215,25 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type">
<h1>15. cdist type<a class="headerlink" href="#cdist-type" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">15. </span>cdist type<a class="headerlink" href="#cdist-type" title="Permalink to this headline"></a></h1>
<div class="section" id="description">
<h2>15.1. Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">15.1. </span>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>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.</p>
</div>
<div class="section" id="synopsis">
<h2>15.2. Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__TYPE ID --parameter value <span class="o">[</span>--parameter value ...<span class="o">]</span>
<h2><span class="section-number">15.2. </span>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>__TYPE ID --parameter value <span class="o">[</span>--parameter value ...<span class="o">]</span>
__TYPE --parameter value <span class="o">[</span>--parameter value ...<span class="o">]</span> <span class="o">(</span><span class="k">for</span> singletons<span class="o">)</span>
</pre></div>
</div>
</div>
<div class="section" id="how-to-use-a-type">
<h2>15.3. How to use a type<a class="headerlink" href="#how-to-use-a-type" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">15.3. </span>How to use a type<a class="headerlink" href="#how-to-use-a-type" title="Permalink to this headline"></a></h2>
<p>You can use types from the initial manifest or the type manifest like a
normal shell command:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># Creates empty file /etc/cdist-configured</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Creates empty file /etc/cdist-configured</span>
__file /etc/cdist-configured --type file
<span class="c1"># Ensure tree is installed</span>
@ -252,12 +243,12 @@ __package tree --state installed
<p>A list of supported types can be found in the <a class="reference external" href="cdist-reference.html">cdist reference</a> manpage.</p>
</div>
<div class="section" id="singleton-types">
<h2>15.4. Singleton types<a class="headerlink" href="#singleton-types" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">15.4. </span>Singleton types<a class="headerlink" href="#singleton-types" title="Permalink to this headline"></a></h2>
<p>If a type is flagged as a singleton, it may be used only
once per host. This is useful for types which can be used only once on a
system. Singleton types do not take an object name as argument.</p>
<p>Example:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># __issue type manages /etc/issue</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># __issue type manages /etc/issue</span>
__issue
<span class="c1"># Probably your own type - singletons may use parameters</span>
@ -266,28 +257,28 @@ __myfancysingleton --colour green
</div>
</div>
<div class="section" id="config-types">
<h2>15.5. Config types<a class="headerlink" href="#config-types" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">15.5. </span>Config types<a class="headerlink" href="#config-types" title="Permalink to this headline"></a></h2>
<p>By default types are used with config command. These are types that are not
flagged by any known command flag. If a type is marked then it will be skipped
with config command.</p>
</div>
<div class="section" id="install-types">
<h2>15.6. Install types<a class="headerlink" href="#install-types" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">15.6. </span>Install types<a class="headerlink" href="#install-types" title="Permalink to this headline"></a></h2>
<p>If a type is flagged with 'install' flag then it is used only with install command.
With other commands, i.e. config, these types are skipped if used.</p>
</div>
<div class="section" id="nonparallel-types">
<h2>15.7. Nonparallel types<a class="headerlink" href="#nonparallel-types" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">15.7. </span>Nonparallel types<a class="headerlink" href="#nonparallel-types" title="Permalink to this headline"></a></h2>
<p>If a type is flagged with 'nonparallel' flag then its objects cannot be run in parallel
when using -j option. Example of such a type is __package_dpkg type where dpkg itself
prevents to be run in more than one instance.</p>
</div>
<div class="section" id="deprecated-types">
<h2>15.8. Deprecated types<a class="headerlink" href="#deprecated-types" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">15.8. </span>Deprecated types<a class="headerlink" href="#deprecated-types" title="Permalink to this headline"></a></h2>
<p>If a type is flagged with 'deprecated' marker then it is considered deprecated.
When it is used cdist writes warning line. If 'deprecated' marker has content
then this content is printed as a deprecation messages, e.g.:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>$ ls -l deprecated
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ ls -l deprecated
-rw-r--r-- <span class="m">1</span> darko darko <span class="m">71</span> May <span class="m">20</span> <span class="m">18</span>:30 deprecated
$ cat deprecated
This <span class="nb">type</span> is deprecated. It will be removed in the next minor release.
@ -296,7 +287,7 @@ WARNING: <span class="m">185</span>.203.112.26: Type __foo is deprecated: This <
</pre></div>
</div>
<p>If 'deprecated' marker has no content then general message is printed, e.g.:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>$ ls -l deprecated
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ ls -l deprecated
-rw-r--r-- <span class="m">1</span> darko darko <span class="m">0</span> May <span class="m">20</span> <span class="m">18</span>:36 deprecated
$ <span class="nb">echo</span> <span class="s1">&#39;__bar foo&#39;</span> <span class="p">|</span> ./bin/cdist config -i - <span class="m">185</span>.203.112.26
WARNING: <span class="m">185</span>.203.112.26: Type __bar is deprecated.
@ -304,15 +295,15 @@ WARNING: <span class="m">185</span>.203.112.26: Type __bar is deprecated.
</div>
</div>
<div class="section" id="how-to-write-a-new-type">
<h2>15.9. How to write a new type<a class="headerlink" href="#how-to-write-a-new-type" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">15.9. </span>How to write a new type<a class="headerlink" href="#how-to-write-a-new-type" title="Permalink to this headline"></a></h2>
<p>A type consists of</p>
<ul class="simple">
<li>parameter (optional)</li>
<li>manifest (optional)</li>
<li>singleton (optional)</li>
<li>explorer (optional)</li>
<li>gencode (optional)</li>
<li>nonparallel (optional)</li>
<li><p>parameter (optional)</p></li>
<li><p>manifest (optional)</p></li>
<li><p>singleton (optional)</p></li>
<li><p>explorer (optional)</p></li>
<li><p>gencode (optional)</p></li>
<li><p>nonparallel (optional)</p></li>
</ul>
<p>Types are stored below cdist/conf/type/. Their name should always be prefixed with
two underscores (__) to prevent collisions with other executables in $PATH.</p>
@ -325,7 +316,7 @@ they are written in shell so they are executed using '/bin/sh -e' or 'CDIST_LOCA
<a class="reference external" href="man1/cdist-new-type.html">cdist-new-type</a>.</p>
</div>
<div class="section" id="defining-parameters">
<h2>15.10. Defining parameters<a class="headerlink" href="#defining-parameters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">15.10. </span>Defining parameters<a class="headerlink" href="#defining-parameters" title="Permalink to this headline"></a></h2>
<p>Every type consists of required, optional and boolean parameters, which must
each be declared in a newline separated file in <strong>parameter/required</strong>,
<strong>parameter/required_multiple</strong>, <strong>parameter/optional</strong>,
@ -338,7 +329,7 @@ or no parameters at all.</p>
<p>Default values for optional parameters can be predefined in
<strong>parameter/default/&lt;name&gt;</strong>.</p>
<p>Example:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="nb">echo</span> servername &gt;&gt; cdist/conf/type/__nginx_vhost/parameter/required
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nb">echo</span> servername &gt;&gt; cdist/conf/type/__nginx_vhost/parameter/required
<span class="nb">echo</span> logdirectory &gt;&gt; cdist/conf/type/__nginx_vhost/parameter/optional
<span class="nb">echo</span> loglevel &gt;&gt; cdist/conf/type/__nginx_vhost/parameter/optional
mkdir cdist/conf/type/__nginx_vhost/parameter/default
@ -349,13 +340,13 @@ mkdir cdist/conf/type/__nginx_vhost/parameter/default
</div>
</div>
<div class="section" id="using-parameters">
<h2>15.11. Using parameters<a class="headerlink" href="#using-parameters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">15.11. </span>Using parameters<a class="headerlink" href="#using-parameters" title="Permalink to this headline"></a></h2>
<p>The parameters given to a type can be accessed and used in all type scripts
(e.g manifest, gencode, explorer). Note that boolean parameters are
represented by file existence. File exists -&gt; True,
file does not exist -&gt; False</p>
<p>Example: (e.g. in cdist/conf/type/__nginx_vhost/manifest)</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># required parameter</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># required parameter</span>
<span class="nv">servername</span><span class="o">=</span><span class="s2">&quot;</span><span class="k">$(</span>cat <span class="s2">&quot;</span><span class="nv">$__object</span><span class="s2">/parameter/servername&quot;</span><span class="k">)</span><span class="s2">&quot;</span>
<span class="c1"># optional parameter</span>
@ -382,14 +373,14 @@ file does not exist -&gt; False</p>
</div>
</div>
<div class="section" id="deprecated-parameters">
<h2>15.12. Deprecated parameters<a class="headerlink" href="#deprecated-parameters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">15.12. </span>Deprecated parameters<a class="headerlink" href="#deprecated-parameters" title="Permalink to this headline"></a></h2>
<p>To deprecate type parameters one can declare a file for each deprecated
parameter under <strong>parameter/deprecated</strong> directory.</p>
<p>When such parameter is used cdist writes warning line with deprecation message.
If such file has content then this content is printed as deprecation message.
If there is no content then generic parameter deprecation message is printed.</p>
<p>Example:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>$ ls parameter/deprecated/
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ ls parameter/deprecated/
eggs spam
$ cat parameter/deprecated/eggs
eggs parameter is deprecated, please use multiple egg parameter.
@ -403,11 +394,11 @@ WARNING: <span class="m">185</span>.203.112.26: eggs parameter of <span class="n
</div>
</div>
<div class="section" id="input-from-stdin">
<h2>15.13. Input from stdin<a class="headerlink" href="#input-from-stdin" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">15.13. </span>Input from stdin<a class="headerlink" href="#input-from-stdin" title="Permalink to this headline"></a></h2>
<p>Every type can access what has been written on stdin when it has been called.
The result is saved into the <strong>stdin</strong> file in the object directory.</p>
<p>Example use of a type: (e.g. in cdist/conf/type/__archlinux_hostname)</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__file /etc/rc.conf --source - <span class="s">&lt;&lt; eof</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>__file /etc/rc.conf --source - <span class="s">&lt;&lt; eof</span>
<span class="s">...</span>
<span class="s">HOSTNAME=&quot;$__target_host&quot;</span>
<span class="s">...</span>
@ -417,7 +408,7 @@ The result is saved into the <strong>stdin</strong> file in the object directory
<p>If you have not seen this syntax (&lt;&lt; eof) before, it may help you to read
about &quot;here documents&quot;.</p>
<p>In the __file type, stdin is used as source for the file, if - is used for source:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="o">[</span> -f <span class="s2">&quot;</span><span class="nv">$__object</span><span class="s2">/parameter/source&quot;</span> <span class="o">]</span><span class="p">;</span> <span class="k">then</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="o">[</span> -f <span class="s2">&quot;</span><span class="nv">$__object</span><span class="s2">/parameter/source&quot;</span> <span class="o">]</span><span class="p">;</span> <span class="k">then</span>
<span class="nv">source</span><span class="o">=</span><span class="s2">&quot;</span><span class="k">$(</span>cat <span class="s2">&quot;</span><span class="nv">$__object</span><span class="s2">/parameter/source&quot;</span><span class="k">)</span><span class="s2">&quot;</span>
<span class="k">if</span> <span class="o">[</span> <span class="s2">&quot;</span><span class="nv">$source</span><span class="s2">&quot;</span> <span class="o">=</span> <span class="s2">&quot;-&quot;</span> <span class="o">]</span><span class="p">;</span> <span class="k">then</span>
<span class="nv">source</span><span class="o">=</span><span class="s2">&quot;</span><span class="nv">$__object</span><span class="s2">/stdin&quot;</span>
@ -426,12 +417,12 @@ about &quot;here documents&quot;.</p>
</pre></div>
</div>
<div class="section" id="stdin-inside-a-loop">
<h3>15.13.1. Stdin inside a loop<a class="headerlink" href="#stdin-inside-a-loop" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">15.13.1. </span>Stdin inside a loop<a class="headerlink" href="#stdin-inside-a-loop" title="Permalink to this headline"></a></h3>
<p>Since cdist saves type's stdin content in the object as <strong>$__object/stdin</strong>,
so it can be accessed in manifest and gencode-* scripts, this can lead to
unexpected behavior. For example, suppose you have some type with the following
in its manifest:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="o">[</span> -f <span class="s2">&quot;</span><span class="nv">$__object</span><span class="s2">/parameter/foo&quot;</span> <span class="o">]</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="o">[</span> -f <span class="s2">&quot;</span><span class="nv">$__object</span><span class="s2">/parameter/foo&quot;</span> <span class="o">]</span>
<span class="k">then</span>
<span class="k">while</span> <span class="nb">read</span> -r l
<span class="k">do</span>
@ -442,18 +433,18 @@ in its manifest:</p>
</pre></div>
</div>
<p>and init manifest:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__foo foo --foo a --foo b --foo c
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>__foo foo --foo a --foo b --foo c
</pre></div>
</div>
<p>You expect that manifest stderr content is:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>a
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>a
b
c
</pre></div>
</div>
<p>and that files <em>a</em>, <em>b</em> and <em>c</em> are created. But all you get in manifest stderr
is:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>a
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>a
</pre></div>
</div>
<p>and only <em>a</em> file is created.</p>
@ -461,14 +452,14 @@ is:</p>
commands in while body have this same stdin. So when <em>__file</em> type gets executed,
cdist saves its stdin which means it gets the remaining content of parameter <em>foo</em>
file, i.e.:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>b
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>b
c
</pre></div>
</div>
<p>The solution is to make sure that your types inside such loops get their stdin
from somewhere else, e.g. for the above problem <em>__file</em> type can get empty
stdin from <em>/dev/null</em>:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="o">[</span> -f <span class="s2">&quot;</span><span class="nv">$__object</span><span class="s2">/parameter/foo&quot;</span> <span class="o">]</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="o">[</span> -f <span class="s2">&quot;</span><span class="nv">$__object</span><span class="s2">/parameter/foo&quot;</span> <span class="o">]</span>
<span class="k">then</span>
<span class="k">while</span> <span class="nb">read</span> -r l
<span class="k">do</span>
@ -481,11 +472,11 @@ stdin from <em>/dev/null</em>:</p>
</div>
</div>
<div class="section" id="writing-the-manifest">
<h2>15.14. Writing the manifest<a class="headerlink" href="#writing-the-manifest" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">15.14. </span>Writing the manifest<a class="headerlink" href="#writing-the-manifest" title="Permalink to this headline"></a></h2>
<p>In the manifest of a type you can use other types, so your type extends
their functionality. A good example is the __package type, which in
a shortened version looks like this:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="nv">os</span><span class="o">=</span><span class="s2">&quot;</span><span class="k">$(</span>cat <span class="s2">&quot;</span><span class="nv">$__global</span><span class="s2">/explorer/os&quot;</span><span class="k">)</span><span class="s2">&quot;</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">os</span><span class="o">=</span><span class="s2">&quot;</span><span class="k">$(</span>cat <span class="s2">&quot;</span><span class="nv">$__global</span><span class="s2">/explorer/os&quot;</span><span class="k">)</span><span class="s2">&quot;</span>
<span class="k">case</span> <span class="s2">&quot;</span><span class="nv">$os</span><span class="s2">&quot;</span> in
archlinux<span class="o">)</span> <span class="nv">type</span><span class="o">=</span><span class="s2">&quot;pacman&quot;</span> <span class="p">;;</span>
debian<span class="p">|</span>ubuntu<span class="o">)</span> <span class="nv">type</span><span class="o">=</span><span class="s2">&quot;apt&quot;</span> <span class="p">;;</span>
@ -505,47 +496,47 @@ which are documented in <a class="reference external" href="cdist-reference.html
to execute it. For more information about manifests see <a class="reference external" href="cdist-manifest.html">cdist manifest</a>.</p>
</div>
<div class="section" id="singleton-one-instance-only">
<h2>15.15. Singleton - one instance only<a class="headerlink" href="#singleton-one-instance-only" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">15.15. </span>Singleton - one instance only<a class="headerlink" href="#singleton-one-instance-only" title="Permalink to this headline"></a></h2>
<p>If you want to ensure that a type can only be used once per target, you can
mark it as a singleton: Just create the (empty) file &quot;singleton&quot; in your type
directory:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>touch cdist/conf/type/__NAME/singleton
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>touch cdist/conf/type/__NAME/singleton
</pre></div>
</div>
<p>This will also change the way your type must be called:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__YOURTYPE --parameter value
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>__YOURTYPE --parameter value
</pre></div>
</div>
<p>As you can see, the object ID is omitted, because it does not make any sense,
if your type can be used only once.</p>
</div>
<div class="section" id="install-type-with-install-command">
<h2>15.16. Install - type with install command<a class="headerlink" href="#install-type-with-install-command" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">15.16. </span>Install - type with install command<a class="headerlink" href="#install-type-with-install-command" title="Permalink to this headline"></a></h2>
<p>If you want a type to be used with install command, you must mark it as
install: create the (empty) file &quot;install&quot; in your type directory:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>touch cdist/conf/type/__install_NAME/install
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>touch cdist/conf/type/__install_NAME/install
</pre></div>
</div>
<p>With other commands, i.e. config, it will be skipped if used.</p>
</div>
<div class="section" id="nonparallel-only-one-instance-can-be-run-at-a-time">
<h2>15.17. Nonparallel - only one instance can be run at a time<a class="headerlink" href="#nonparallel-only-one-instance-can-be-run-at-a-time" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">15.17. </span>Nonparallel - only one instance can be run at a time<a class="headerlink" href="#nonparallel-only-one-instance-can-be-run-at-a-time" title="Permalink to this headline"></a></h2>
<p>If objects of a type must not or cannot be run in parallel when using -j
option, you must mark it as nonparallel: create the (empty) file &quot;nonparallel&quot;
in your type directory:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>touch cdist/conf/type/__NAME/nonparallel
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>touch cdist/conf/type/__NAME/nonparallel
</pre></div>
</div>
<p>For example, package types are nonparallel types.</p>
</div>
<div class="section" id="the-type-explorers">
<h2>15.18. The type explorers<a class="headerlink" href="#the-type-explorers" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">15.18. </span>The type explorers<a class="headerlink" href="#the-type-explorers" title="Permalink to this headline"></a></h2>
<p>If a type needs to explore specific details, it can provide type specific
explorers, which will be executed on the target for every created object.</p>
<p>The explorers are stored under the &quot;explorer&quot; directory below the type.
It could for instance contain code to check the md5sum of a file on the
client, like this (shortened version from the type __file):</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="o">[</span> -f <span class="s2">&quot;</span><span class="nv">$__object</span><span class="s2">/parameter/destination&quot;</span> <span class="o">]</span><span class="p">;</span> <span class="k">then</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="o">[</span> -f <span class="s2">&quot;</span><span class="nv">$__object</span><span class="s2">/parameter/destination&quot;</span> <span class="o">]</span><span class="p">;</span> <span class="k">then</span>
<span class="nv">destination</span><span class="o">=</span><span class="s2">&quot;</span><span class="k">$(</span>cat <span class="s2">&quot;</span><span class="nv">$__object</span><span class="s2">/parameter/destination&quot;</span><span class="k">)</span><span class="s2">&quot;</span>
<span class="k">else</span>
<span class="nv">destination</span><span class="o">=</span><span class="s2">&quot;/</span><span class="nv">$__object_id</span><span class="s2">&quot;</span>
@ -558,7 +549,7 @@ client, like this (shortened version from the type __file):</p>
</div>
</div>
<div class="section" id="writing-the-gencode-script">
<h2>15.19. Writing the gencode script<a class="headerlink" href="#writing-the-gencode-script" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">15.19. </span>Writing the gencode script<a class="headerlink" href="#writing-the-gencode-script" title="Permalink to this headline"></a></h2>
<p>There are two gencode scripts: <strong>gencode-local</strong> and <strong>gencode-remote</strong>.
The output of gencode-local is executed locally, whereas
the output of gencode-remote is executed on the target.
@ -567,7 +558,7 @@ and the type specific explorers.</p>
<p>If the gencode scripts encounters an error, it should print diagnostic
messages to stderr and exit non-zero. If you need to debug the gencode
script, you can write to stderr:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># Debug output to stderr</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Debug output to stderr</span>
<span class="nb">echo</span> <span class="s2">&quot;My fancy debug line&quot;</span> &gt;<span class="p">&amp;</span><span class="m">2</span>
<span class="c1"># Output to be saved by cdist for execution on the target</span>
@ -581,16 +572,16 @@ the same as ssh for some options where colon is a delimiter, as for -L ssh
option (see <strong>ssh</strong>(1) and <strong>scp</strong>(1)).</p>
</div>
<div class="section" id="variable-access-from-the-generated-scripts">
<h2>15.20. Variable access from the generated scripts<a class="headerlink" href="#variable-access-from-the-generated-scripts" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">15.20. </span>Variable access from the generated scripts<a class="headerlink" href="#variable-access-from-the-generated-scripts" title="Permalink to this headline"></a></h2>
<p>In the generated scripts, you have access to the following cdist variables</p>
<ul class="simple">
<li>__object</li>
<li>__object_id</li>
<li><p>__object</p></li>
<li><p>__object_id</p></li>
</ul>
<p>but only for read operations, means there is no back copy of this
files after the script execution.</p>
<p>So when you generate a script with the following content, it will work:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="o">[</span> -f <span class="s2">&quot;</span><span class="nv">$__object</span><span class="s2">/parameter/name&quot;</span> <span class="o">]</span><span class="p">;</span> <span class="k">then</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="o">[</span> -f <span class="s2">&quot;</span><span class="nv">$__object</span><span class="s2">/parameter/name&quot;</span> <span class="o">]</span><span class="p">;</span> <span class="k">then</span>
<span class="nv">name</span><span class="o">=</span><span class="s2">&quot;</span><span class="k">$(</span>cat <span class="s2">&quot;</span><span class="nv">$__object</span><span class="s2">/parameter/name&quot;</span><span class="k">)</span><span class="s2">&quot;</span>
<span class="k">else</span>
<span class="nv">name</span><span class="o">=</span><span class="s2">&quot;</span><span class="nv">$__object_id</span><span class="s2">&quot;</span>
@ -599,50 +590,50 @@ files after the script execution.</p>
</div>
</div>
<div class="section" id="environment-variable-usage-idiom">
<h2>15.21. Environment variable usage idiom<a class="headerlink" href="#environment-variable-usage-idiom" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">15.21. </span>Environment variable usage idiom<a class="headerlink" href="#environment-variable-usage-idiom" title="Permalink to this headline"></a></h2>
<p>In type scripts you can support environment variables with default values if
environment variable is unset or null by using <strong>${parameter:-[word]}</strong>
parameter expansion.</p>
<p>Example using mktemp in a portable way that supports TMPDIR environment variable.</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="nv">tempfile</span><span class="o">=</span><span class="k">$(</span>mktemp <span class="s2">&quot;</span><span class="si">${</span><span class="nv">TMPDIR</span><span class="k">:-</span><span class="p">/tmp</span><span class="si">}</span><span class="s2">/cdist.XXXXXXXXXX&quot;</span><span class="k">)</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">tempfile</span><span class="o">=</span><span class="k">$(</span>mktemp <span class="s2">&quot;</span><span class="si">${</span><span class="nv">TMPDIR</span><span class="k">:-</span><span class="p">/tmp</span><span class="si">}</span><span class="s2">/cdist.XXXXXXXXXX&quot;</span><span class="k">)</span>
</pre></div>
</div>
</div>
<div class="section" id="log-level-in-types">
<h2>15.22. Log level in types<a class="headerlink" href="#log-level-in-types" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">15.22. </span>Log level in types<a class="headerlink" href="#log-level-in-types" title="Permalink to this headline"></a></h2>
<p>cdist log level can be accessed from __cdist_log_level variable.One of:</p>
<blockquote>
<div><table border="1" class="docutils">
<div><table class="docutils align-default">
<colgroup>
<col width="48%" />
<col width="52%" />
<col style="width: 48%" />
<col style="width: 52%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Log level</th>
<th class="head">Log level value</th>
<thead>
<tr class="row-odd"><th class="head"><p>Log level</p></th>
<th class="head"><p>Log level value</p></th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>OFF</td>
<td>60</td>
<tbody>
<tr class="row-even"><td><p>OFF</p></td>
<td><p>60</p></td>
</tr>
<tr class="row-odd"><td>ERROR</td>
<td>40</td>
<tr class="row-odd"><td><p>ERROR</p></td>
<td><p>40</p></td>
</tr>
<tr class="row-even"><td>WARNING</td>
<td>30</td>
<tr class="row-even"><td><p>WARNING</p></td>
<td><p>30</p></td>
</tr>
<tr class="row-odd"><td>INFO</td>
<td>20</td>
<tr class="row-odd"><td><p>INFO</p></td>
<td><p>20</p></td>
</tr>
<tr class="row-even"><td>VERBOSE</td>
<td>15</td>
<tr class="row-even"><td><p>VERBOSE</p></td>
<td><p>15</p></td>
</tr>
<tr class="row-odd"><td>DEBUG</td>
<td>10</td>
<tr class="row-odd"><td><p>DEBUG</p></td>
<td><p>10</p></td>
</tr>
<tr class="row-even"><td>TRACE</td>
<td>5</td>
<tr class="row-even"><td><p>TRACE</p></td>
<td><p>5</p></td>
</tr>
</tbody>
</table>
@ -651,13 +642,13 @@ parameter expansion.</p>
type explorer, type gencode.</p>
</div>
<div class="section" id="detecting-dry-run">
<h2>15.23. Detecting dry run<a class="headerlink" href="#detecting-dry-run" title="Permalink to this headline"></a></h2>
<p>If <code class="docutils literal"><span class="pre">$__cdist_dry_run</span></code> environment variable is set, then it's dry run.</p>
<h2><span class="section-number">15.23. </span>Detecting dry run<a class="headerlink" href="#detecting-dry-run" title="Permalink to this headline"></a></h2>
<p>If <code class="docutils literal notranslate"><span class="pre">$__cdist_dry_run</span></code> environment variable is set, then it's dry run.</p>
<p>It is available for initial manifest, explorer, type manifest,
type explorer, type gencode.</p>
</div>
<div class="section" id="hints-for-typewriters">
<h2>15.24. Hints for typewriters<a class="headerlink" href="#hints-for-typewriters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">15.24. </span>Hints for typewriters<a class="headerlink" href="#hints-for-typewriters" title="Permalink to this headline"></a></h2>
<p>It must be assumed that the target is pretty dumb and thus does not have high
level tools like ruby installed. If a type requires specific tools to be present
on the target, there must be another type that provides this tool and the first
@ -671,13 +662,13 @@ a folder named &quot;files&quot; within the type (again, because cdist guarantee
never ever touch this folder).</p>
</div>
<div class="section" id="how-to-include-a-type-into-upstream-cdist">
<h2>15.25. How to include a type into upstream cdist<a class="headerlink" href="#how-to-include-a-type-into-upstream-cdist" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">15.25. </span>How to include a type into upstream cdist<a class="headerlink" href="#how-to-include-a-type-into-upstream-cdist" title="Permalink to this headline"></a></h2>
<p>If you think your type may be useful for others, ensure it works with the
current master branch of cdist and have a look at <a class="reference external" href="cdist-hacker.html">cdist hacking</a> on
how to submit it.</p>
</div>
<div class="section" id="python-types">
<h2>15.26. Python types<a class="headerlink" href="#python-types" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">15.26. </span>Python types<a class="headerlink" href="#python-types" title="Permalink to this headline"></a></h2>
<p>From version/branch <strong>beta</strong> cdist support python types, types that are written
in python language with cdist's core support. cdist detects such type if type is
detectable as a python package, i.e. if <strong>__init__.py</strong> file is present in type's
@ -691,18 +682,18 @@ in shell, since this is the code that is directly executed at target host.</p>
<p>When writing python type you can extend <strong>cdist.core.pytypes.PythonType</strong> class.
You need to implement the following methods:</p>
<ul class="simple">
<li><strong>get_args_parser</strong>: implementation should return <strong>argparse.ArgumentParser</strong> and if
<li><p><strong>get_args_parser</strong>: implementation should return <strong>argparse.ArgumentParser</strong> and if
it is undefined or returned None then cdist falls back to classic type parameter
definition and argument parsing</li>
<li><strong>type_manifest</strong>: implementation should yield <strong>cdist.core.pytypes.&lt;type-name&gt;</strong>
attribute function call result, or <strong>yield from ()</strong> if type does not use other types</li>
<li><strong>type_gencode</strong>: implementation should return a string consisting of lines
of shell code that will be executed at target host.</li>
definition and argument parsing</p></li>
<li><p><strong>type_manifest</strong>: implementation should yield <strong>cdist.core.pytypes.&lt;type-name&gt;</strong>
attribute function call result, or <strong>yield from ()</strong> if type does not use other types</p></li>
<li><p><strong>type_gencode</strong>: implementation should return a string consisting of lines
of shell code that will be executed at target host.</p></li>
</ul>
<p><strong>cdist.core.pytypes.&lt;type-name&gt;</strong> attributes correspond to detected python types.
<strong>Note</strong> that double underscore ('__') at the beginning of type name is removed.</p>
<p>Example:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>import os
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>import os
import sys
from cdist.core.pytypes import *
@ -728,15 +719,15 @@ class DummyConfig<span class="o">(</span>PythonType<span class="o">)</span>:
</div>
<p><strong>cdist.core.PythonType</strong> class provides the following methods:</p>
<ul class="simple">
<li><strong>get_parameter</strong>: get type parameter</li>
<li><strong>get_explorer_file</strong>: get path to file for specified explorer</li>
<li><strong>get_explorer</strong>: get value for specified explorer</li>
<li><strong>run_local</strong>: run specified command locally</li>
<li><strong>run_remote</strong>: run specified command remotely</li>
<li><strong>transfer</strong>: transfer specified source to the remote</li>
<li><strong>die</strong>: raise error</li>
<li><strong>send_message</strong>: send message</li>
<li><strong>receive_message</strong>: get message.</li>
<li><p><strong>get_parameter</strong>: get type parameter</p></li>
<li><p><strong>get_explorer_file</strong>: get path to file for specified explorer</p></li>
<li><p><strong>get_explorer</strong>: get value for specified explorer</p></li>
<li><p><strong>run_local</strong>: run specified command locally</p></li>
<li><p><strong>run_remote</strong>: run specified command remotely</p></li>
<li><p><strong>transfer</strong>: transfer specified source to the remote</p></li>
<li><p><strong>die</strong>: raise error</p></li>
<li><p><strong>send_message</strong>: send message</p></li>
<li><p><strong>receive_message</strong>: get message.</p></li>
</ul>
<p>When running python type, cdist will save output streams to <strong>gencode-py</strong>,
stdout and stderr output files.</p>

27
src/extra/manual/beta/cdist-types.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16. cdist types &mdash; cdist 6.5.6 documentation</title>
<title>16. cdist types &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -336,7 +327,7 @@
<li><a href="index.html">Docs</a> &raquo;</li>
<li>16. cdist types</li>
<li><span class="section-number">16. </span>cdist types</li>
<li class="wy-breadcrumbs-aside">
@ -356,7 +347,7 @@
<div itemprop="articleBody">
<div class="section" id="cdist-types">
<h1>16. cdist types<a class="headerlink" href="#cdist-types" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16. </span>cdist types<a class="headerlink" href="#cdist-types" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="man7/cdist-type__acl.html">16.1. __acl</a></li>

147
src/extra/manual/beta/cdist-upgrade.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>5. How to upgrade cdist &mdash; cdist 6.5.6 documentation</title>
<title>5. How to upgrade cdist &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -195,7 +186,7 @@
<li><a href="index.html">Docs</a> &raquo;</li>
<li>5. How to upgrade cdist</li>
<li><span class="section-number">5. </span>How to upgrade cdist</li>
<li class="wy-breadcrumbs-aside">
@ -215,25 +206,25 @@
<div itemprop="articleBody">
<div class="section" id="how-to-upgrade-cdist">
<h1>5. How to upgrade cdist<a class="headerlink" href="#how-to-upgrade-cdist" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">5. </span>How to upgrade cdist<a class="headerlink" href="#how-to-upgrade-cdist" title="Permalink to this headline"></a></h1>
<div class="section" id="update-the-git-installation">
<h2>5.1. Update the git installation<a class="headerlink" href="#update-the-git-installation" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">5.1. </span>Update the git installation<a class="headerlink" href="#update-the-git-installation" title="Permalink to this headline"></a></h2>
<p>To upgrade cdist in the current branch use</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>git pull
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git pull
<span class="c1"># Also update the manpages</span>
make man
<span class="nb">export</span> <span class="nv">MANPATH</span><span class="o">=</span><span class="nv">$MANPATH</span>:<span class="k">$(</span><span class="nb">pwd</span> -P<span class="k">)</span>/doc/man
</pre></div>
</div>
<p>If you stay on a version branche (i.e. 1.0, 1.1., ...), nothing should break.
<p>If you stay on a version branch (i.e. 1.0, 1.1., ...), nothing should break.
The master branch on the other hand is the development branch and may not be
working, break your setup or eat the tree in your garden.</p>
<div class="section" id="safely-upgrading-to-new-versions">
<h3>5.1.1. Safely upgrading to new versions<a class="headerlink" href="#safely-upgrading-to-new-versions" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">5.1.1. </span>Safely upgrading to new versions<a class="headerlink" href="#safely-upgrading-to-new-versions" title="Permalink to this headline"></a></h3>
<p>To upgrade to <strong>any</strong> further cdist version, you can take the
following procedure to do a safe upgrade:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># Create new branch to try out the update</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Create new branch to try out the update</span>
git checkout -b upgrade_cdist
<span class="c1"># Get latest cdist version in git database</span>
@ -250,7 +241,7 @@ git merge origin/master
<p>Now you can ensure all custom types work with the new version.
Assume that you need to go back to an older version during
the migration/update, you can do so as follows:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># commit changes</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># commit changes</span>
git commit -m ...
<span class="c1"># go back to original branch</span>
@ -258,132 +249,132 @@ git checkout master
</pre></div>
</div>
<p>After that, you can go back and continue the upgrade:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># git checkout upgrade_cdist</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># git checkout upgrade_cdist</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="update-the-python-package">
<h2>5.2. Update the python package<a class="headerlink" href="#update-the-python-package" title="Permalink to this headline"></a></h2>
<p>To upgrade to the lastet version do</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>pip install --upgrade cdist
<h2><span class="section-number">5.2. </span>Update the python package<a class="headerlink" href="#update-the-python-package" title="Permalink to this headline"></a></h2>
<p>To upgrade to the latest version do</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>pip install --upgrade cdist
</pre></div>
</div>
</div>
<div class="section" id="general-update-instructions">
<h2>5.3. General update instructions<a class="headerlink" href="#general-update-instructions" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">5.3. </span>General update instructions<a class="headerlink" href="#general-update-instructions" title="Permalink to this headline"></a></h2>
<div class="section" id="updating-from-3-0-to-3-1">
<h3>5.3.1. Updating from 3.0 to 3.1<a class="headerlink" href="#updating-from-3-0-to-3-1" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">5.3.1. </span>Updating from 3.0 to 3.1<a class="headerlink" href="#updating-from-3-0-to-3-1" title="Permalink to this headline"></a></h3>
<p>The type <strong>__ssh_authorized_keys</strong> now also manages existing keys,
not only the ones added by cdist.</p>
</div>
<div class="section" id="updating-from-2-3-to-3-0">
<h3>5.3.2. Updating from 2.3 to 3.0<a class="headerlink" href="#updating-from-2-3-to-3-0" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">5.3.2. </span>Updating from 2.3 to 3.0<a class="headerlink" href="#updating-from-2-3-to-3-0" title="Permalink to this headline"></a></h3>
<p>The <strong>changed</strong> attribute of objects has been removed.
Use <a class="reference external" href="/software/cdist/man/3.0.0/man7/cdist-messaging.html">messaging</a> instead.</p>
</div>
<div class="section" id="updating-from-2-2-to-2-3">
<h3>5.3.3. Updating from 2.2 to 2.3<a class="headerlink" href="#updating-from-2-2-to-2-3" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">5.3.3. </span>Updating from 2.2 to 2.3<a class="headerlink" href="#updating-from-2-2-to-2-3" title="Permalink to this headline"></a></h3>
<p>No incompatibilities.</p>
</div>
<div class="section" id="updating-from-2-1-to-2-2">
<h3>5.3.4. Updating from 2.1 to 2.2<a class="headerlink" href="#updating-from-2-1-to-2-2" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">5.3.4. </span>Updating from 2.1 to 2.2<a class="headerlink" href="#updating-from-2-1-to-2-2" title="Permalink to this headline"></a></h3>
<p>Starting with 2.2, the syntax for requiring a singleton type changed:
Old format:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="nv">require</span><span class="o">=</span><span class="s2">&quot;__singleton_type/singleton&quot;</span> ...
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">require</span><span class="o">=</span><span class="s2">&quot;__singleton_type/singleton&quot;</span> ...
</pre></div>
</div>
<p>New format:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="nv">require</span><span class="o">=</span><span class="s2">&quot;__singleton_type&quot;</span> ...
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">require</span><span class="o">=</span><span class="s2">&quot;__singleton_type&quot;</span> ...
</pre></div>
</div>
<p>Internally the &quot;singleton&quot; object id was dropped to make life more easy.
You can probably fix your configuration by running the following code
snippet (currently untested, please report back if it works for you):</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>find ~/.cdist/* -type f -exec sed -i <span class="s1">&#39;s,/singleton,,&#39;</span> <span class="o">{}</span> <span class="se">\;</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>find ~/.cdist/* -type f -exec sed -i <span class="s1">&#39;s,/singleton,,&#39;</span> <span class="o">{}</span> <span class="se">\;</span>
</pre></div>
</div>
</div>
<div class="section" id="updating-from-2-0-to-2-1">
<h3>5.3.5. Updating from 2.0 to 2.1<a class="headerlink" href="#updating-from-2-0-to-2-1" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">5.3.5. </span>Updating from 2.0 to 2.1<a class="headerlink" href="#updating-from-2-0-to-2-1" title="Permalink to this headline"></a></h3>
<p>Have a look at the update guide for [[2.0 to 2.1|2.0-to-2.1]].</p>
<blockquote>
<div><ul class="simple">
<li>Type <strong>__package* and __process</strong> use --state <strong>present</strong> or <strong>absent</strong>.
<li><p>Type <strong>__package* and __process</strong> use --state <strong>present</strong> or <strong>absent</strong>.
The states <strong>removed/installed</strong> and <strong>stopped/running</strong> have been removed.
Support for the new states is already present in 2.0.</li>
<li>Type <strong>__directory</strong>: Parameter --parents and --recursive are now boolean
The old &quot;yes/no&quot; values need to be removed.</li>
<li>Type <strong>__rvm_ruby</strong>: Parameter --default is now boolean
The old &quot;yes/no&quot; values need to be removed.</li>
<li>Type <strong>__rvm_gemset</strong>: Parameter --default is now boolean
The old &quot;yes/no&quot; values need to be removed.</li>
<li>Type <strong>__addifnosuchline</strong> and <strong>__removeline</strong> have been replaced by <strong>__line</strong></li>
<li>The <strong>conf</strong> directory is now located at <strong>cdist/conf</strong>.
Support for the new states is already present in 2.0.</p></li>
<li><p>Type <strong>__directory</strong>: Parameter --parents and --recursive are now boolean
The old &quot;yes/no&quot; values need to be removed.</p></li>
<li><p>Type <strong>__rvm_ruby</strong>: Parameter --default is now boolean
The old &quot;yes/no&quot; values need to be removed.</p></li>
<li><p>Type <strong>__rvm_gemset</strong>: Parameter --default is now boolean
The old &quot;yes/no&quot; values need to be removed.</p></li>
<li><p>Type <strong>__addifnosuchline</strong> and <strong>__removeline</strong> have been replaced by <strong>__line</strong></p></li>
<li><p>The <strong>conf</strong> directory is now located at <strong>cdist/conf</strong>.
You need to migrate your types, explorers and manifests
manually to the new location.</li>
<li>Replace the variable <strong>__self</strong> by <strong>__object_name</strong>
Support for the variable <strong>__object_name</strong> is already present in 2.0.</li>
<li>The types <strong>__autofs</strong>, <strong>__autofs_map</strong> and <strong>__autofs_reload</strong> have been removed
(no maintainer, no users)</li>
<li>Type <strong>__user</strong>: Parameter --groups removed (use the new __user_groups type)</li>
<li><dl class="first docutils">
<dt>Type <strong>__ssh_authorized_key</strong> has been replaced by more flexible type</dt>
<dd><strong>__ssh_authorized_keys</strong></dd>
manually to the new location.</p></li>
<li><p>Replace the variable <strong>__self</strong> by <strong>__object_name</strong>
Support for the variable <strong>__object_name</strong> is already present in 2.0.</p></li>
<li><p>The types <strong>__autofs</strong>, <strong>__autofs_map</strong> and <strong>__autofs_reload</strong> have been removed
(no maintainer, no users)</p></li>
<li><p>Type <strong>__user</strong>: Parameter --groups removed (use the new __user_groups type)</p></li>
<li><dl class="simple">
<dt>Type <strong>__ssh_authorized_key</strong> has been replaced by more flexible type</dt><dd><p><strong>__ssh_authorized_keys</strong></p>
</dd>
</dl>
</li>
</ul>
</div></blockquote>
</div>
<div class="section" id="updating-from-1-7-to-2-0">
<h3>5.3.6. Updating from 1.7 to 2.0<a class="headerlink" href="#updating-from-1-7-to-2-0" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">5.3.6. </span>Updating from 1.7 to 2.0<a class="headerlink" href="#updating-from-1-7-to-2-0" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>Ensure python (&gt;= 3.2) is installed on the source host</li>
<li>Use &quot;cdist config host&quot; instead of &quot;cdist-deploy-to host&quot;</li>
<li>Use &quot;cdist config -p host1 host2&quot; instead of &quot;cdist-mass-deploy&quot;</li>
<li>Use &quot;cdist banner&quot; for fun</li>
<li>Use <strong>__object_name</strong> instead of <strong>__self</strong> in manifests</li>
<li><p>Ensure python (&gt;= 3.2) is installed on the source host</p></li>
<li><p>Use &quot;cdist config host&quot; instead of &quot;cdist-deploy-to host&quot;</p></li>
<li><p>Use &quot;cdist config -p host1 host2&quot; instead of &quot;cdist-mass-deploy&quot;</p></li>
<li><p>Use &quot;cdist banner&quot; for fun</p></li>
<li><p>Use <strong>__object_name</strong> instead of <strong>__self</strong> in manifests</p></li>
</ul>
</div>
<div class="section" id="updating-from-1-6-to-1-7">
<h3>5.3.7. Updating from 1.6 to 1.7<a class="headerlink" href="#updating-from-1-6-to-1-7" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">5.3.7. </span>Updating from 1.6 to 1.7<a class="headerlink" href="#updating-from-1-6-to-1-7" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>If you used the global explorer <strong>hardware_type</strong>, you need to change
your code to use <strong>machine</strong> instead.</li>
<li><p>If you used the global explorer <strong>hardware_type</strong>, you need to change
your code to use <strong>machine</strong> instead.</p></li>
</ul>
</div>
<div class="section" id="updating-from-1-5-to-1-6">
<h3>5.3.8. Updating from 1.5 to 1.6<a class="headerlink" href="#updating-from-1-5-to-1-6" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">5.3.8. </span>Updating from 1.5 to 1.6<a class="headerlink" href="#updating-from-1-5-to-1-6" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>If you used <strong>__package_apt --preseed</strong>, you need to use the new
type <strong>__debconf_set_selections</strong> instead.</li>
<li>The <strong>__package</strong> types accepted either --state deinstalled or
--state uninstaaled. Starting with 1.6, it was made consistently
to --state removed.</li>
<li><p>If you used <strong>__package_apt --preseed</strong>, you need to use the new
type <strong>__debconf_set_selections</strong> instead.</p></li>
<li><p>The <strong>__package</strong> types accepted either --state deinstalled or
--state uninstalled. Starting with 1.6, it was made consistently
to --state removed.</p></li>
</ul>
</div>
<div class="section" id="updating-from-1-3-to-1-5">
<h3>5.3.9. Updating from 1.3 to 1.5<a class="headerlink" href="#updating-from-1-3-to-1-5" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">5.3.9. </span>Updating from 1.3 to 1.5<a class="headerlink" href="#updating-from-1-3-to-1-5" title="Permalink to this headline"></a></h3>
<p>No incompatibilities.</p>
</div>
<div class="section" id="updating-from-1-2-to-1-3">
<h3>5.3.10. Updating from 1.2 to 1.3<a class="headerlink" href="#updating-from-1-2-to-1-3" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">5.3.10. </span>Updating from 1.2 to 1.3<a class="headerlink" href="#updating-from-1-2-to-1-3" title="Permalink to this headline"></a></h3>
<p>Rename <strong>gencode</strong> of every type to <strong>gencode-remote</strong>.</p>
</div>
<div class="section" id="updating-from-1-1-to-1-2">
<h3>5.3.11. Updating from 1.1 to 1.2<a class="headerlink" href="#updating-from-1-1-to-1-2" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">5.3.11. </span>Updating from 1.1 to 1.2<a class="headerlink" href="#updating-from-1-1-to-1-2" title="Permalink to this headline"></a></h3>
<p>No incompatibilities.</p>
</div>
<div class="section" id="updating-from-1-0-to-1-1">
<h3>5.3.12. Updating from 1.0 to 1.1<a class="headerlink" href="#updating-from-1-0-to-1-1" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">5.3.12. </span>Updating from 1.0 to 1.1<a class="headerlink" href="#updating-from-1-0-to-1-1" title="Permalink to this headline"></a></h3>
<p>In 1.1 the type <strong>__file</strong> was split into <strong>__directory</strong>, <strong>__file</strong> and
<strong>__link</strong>. The parameter <strong>--type</strong> was removed from <strong>__file</strong>. Thus you
need to replace <strong>__file</strong> calls in your manifests:</p>
<blockquote>
<div><ul class="simple">
<li>Remove --type from all __file calls</li>
<li>If type was symlink, use __link and --type symbolic</li>
<li>If type was directory, use __directory</li>
<li><p>Remove --type from all __file calls</p></li>
<li><p>If type was symlink, use __link and --type symbolic</p></li>
<li><p>If type was directory, use __directory</p></li>
</ul>
</div></blockquote>
</div>

51
src/extra/manual/beta/cdist-why.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>1. Why should I use cdist? &mdash; cdist 6.5.6 documentation</title>
<title>1. Why should I use cdist? &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -181,7 +172,7 @@
<li><a href="index.html">Docs</a> &raquo;</li>
<li>1. Why should I use cdist?</li>
<li><span class="section-number">1. </span>Why should I use cdist?</li>
<li class="wy-breadcrumbs-aside">
@ -201,11 +192,11 @@
<div itemprop="articleBody">
<div class="section" id="why-should-i-use-cdist">
<h1>1. Why should I use cdist?<a class="headerlink" href="#why-should-i-use-cdist" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">1. </span>Why should I use cdist?<a class="headerlink" href="#why-should-i-use-cdist" title="Permalink to this headline"></a></h1>
<p>There are several motivations to use cdist, these
are probably the most popular ones.</p>
<div class="section" id="known-language">
<h2>1.1. Known language<a class="headerlink" href="#known-language" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">1.1. </span>Known language<a class="headerlink" href="#known-language" title="Permalink to this headline"></a></h2>
<p>Cdist is being configured in
<a class="reference external" href="https://en.wikipedia.org/wiki/Shell_script">shell script</a>.
Shell script is used by UNIX system engineers for decades.
@ -214,22 +205,22 @@ So when cdist is introduced, your staff does not need to learn a new
or programming language.</p>
</div>
<div class="section" id="powerful-language">
<h2>1.2. Powerful language<a class="headerlink" href="#powerful-language" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">1.2. </span>Powerful language<a class="headerlink" href="#powerful-language" title="Permalink to this headline"></a></h2>
<p>Not only is shell scripting widely known by system engineers,
but it is also a very powerful language. Here are some features
which make daily work easy:</p>
<blockquote>
<div><ul class="simple">
<li>Configuration can react dynamicly on explored values</li>
<li>High level string manipulation (using sed, awk, grep)</li>
<li>Conditional support (<strong>if, case</strong>)</li>
<li>Loop support (<strong>for, while</strong>)</li>
<li>Support for dependencies between cdist types</li>
<li><p>Configuration can react dynamically on explored values</p></li>
<li><p>High level string manipulation (using sed, awk, grep)</p></li>
<li><p>Conditional support (<strong>if, case</strong>)</p></li>
<li><p>Loop support (<strong>for, while</strong>)</p></li>
<li><p>Support for dependencies between cdist types</p></li>
</ul>
</div></blockquote>
</div>
<div class="section" id="more-than-shell-scripting">
<h2>1.3. More than shell scripting<a class="headerlink" href="#more-than-shell-scripting" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">1.3. </span>More than shell scripting<a class="headerlink" href="#more-than-shell-scripting" title="Permalink to this headline"></a></h2>
<p>If you compare regular shell scripting with cdist, there is one major
difference: When using cdist types,
the results are
@ -238,17 +229,17 @@ In practise that means it does not matter in which order you
call cdist types, the result is always the same.</p>
</div>
<div class="section" id="zero-dependency-configuration-management">
<h2>1.4. Zero dependency configuration management<a class="headerlink" href="#zero-dependency-configuration-management" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">1.4. </span>Zero dependency configuration management<a class="headerlink" href="#zero-dependency-configuration-management" title="Permalink to this headline"></a></h2>
<p>Cdist requires very little on a target system. Even better,
in almost all cases all dependencies are usually fulfilled.
Cdist does not require an agent or high level programming
languages on the target host: it will run on any host that
has a <strong>ssh server running</strong> and a posix compatible shell
has a <strong>ssh server running</strong> and a POSIX compatible shell
(<strong>/bin/sh</strong>). Compared to other configuration management systems,
it does not require to open up an additional port.</p>
</div>
<div class="section" id="push-based-distribution">
<h2>1.5. Push based distribution<a class="headerlink" href="#push-based-distribution" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">1.5. </span>Push based distribution<a class="headerlink" href="#push-based-distribution" title="Permalink to this headline"></a></h2>
<p>Cdist uses the push based model for configuration. In this
scenario, one (or more) computers connect to the target hosts
and apply the configuration. That way the source host has
@ -261,7 +252,7 @@ need to connect back to the source host, which contains the
full configuration.</p>
</div>
<div class="section" id="highly-scalable">
<h2>1.6. Highly scalable<a class="headerlink" href="#highly-scalable" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">1.6. </span>Highly scalable<a class="headerlink" href="#highly-scalable" title="Permalink to this headline"></a></h2>
<p>If at some point you manage more hosts than can be handled from
a single source host, you can simply add more resources: Either
add more cores to one host or add hosts.

23
src/extra/manual/beta/genindex.html
View File

@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Index &mdash; cdist 6.5.6 documentation</title>
<title>Index &mdash; cdist 6.6.0 documentation</title>
@ -21,20 +21,11 @@
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -71,7 +62,7 @@
<div class="version">
6.5.6
6.6.0
</div>

23
src/extra/manual/beta/index.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>cdist - usable configuration management &mdash; cdist 6.5.6 documentation</title>
<title>cdist - usable configuration management &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -71,7 +62,7 @@
<div class="version">
6.5.6
6.6.0
</div>

121
src/extra/manual/beta/man1/cdist-dump.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>10. cdist-dump(1) &mdash; cdist 6.5.6 documentation</title>
<title>10. cdist-dump(1) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -183,7 +174,7 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li>10. cdist-dump(1)</li>
<li><span class="section-number">10. </span>cdist-dump(1)</li>
<li class="wy-breadcrumbs-aside">
@ -203,19 +194,19 @@
<div itemprop="articleBody">
<div class="section" id="cdist-dump-1">
<h1>10. cdist-dump(1)<a class="headerlink" href="#cdist-dump-1" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">10. </span>cdist-dump(1)<a class="headerlink" href="#cdist-dump-1" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>10.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">10.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-dump - Dump data from local cdist cache</p>
</div>
<div class="section" id="synopsis">
<h2>10.2. SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline"></a></h2>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cdist</span><span class="o">-</span><span class="n">dump</span> <span class="p">[</span><span class="n">options</span><span class="p">]</span> <span class="p">[</span><span class="n">host</span><span class="o">...</span><span class="p">]</span>
<h2><span class="section-number">10.2. </span>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline"></a></h2>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cdist</span><span class="o">-</span><span class="n">dump</span> <span class="p">[</span><span class="n">options</span><span class="p">]</span> <span class="p">[</span><span class="n">host</span><span class="o">...</span><span class="p">]</span>
</pre></div>
</div>
</div>
<div class="section" id="description">
<h2>10.3. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">10.3. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>cdist-dump is a helper script that dumps data from local cdist cache for
specified hosts. If host is not specified then all data from cache directory
is dumped. Default cache directory is '~/.cdist/cache'.</p>
@ -223,49 +214,49 @@ is dumped. Default cache directory is '~/.cdist/cache'.</p>
new types.</p>
</div>
<div class="section" id="options">
<h2>10.4. OPTIONS<a class="headerlink" href="#options" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt><strong>-a</strong></dt>
<dd>dump all</dd>
<dt><strong>-C CACHE-DIR</strong></dt>
<dd>use specified CACHE-DIR (default: ~/.cdist/cache)</dd>
<dt><strong>-c</strong></dt>
<dd>dump code-*</dd>
<dt><strong>-d DELIMITER</strong></dt>
<dd>delimiter used for filename and line number prefix (default: ':')</dd>
<dt><strong>-E</strong></dt>
<dd>dump global explorers</dd>
<dt><strong>-e</strong></dt>
<dd>dump type explorers</dd>
<dt><strong>-F</strong></dt>
<dd>disable filename prefix (enabled by default)</dd>
<dt><strong>-f</strong></dt>
<dd>enable filename prefix (default)</dd>
<dt><strong>-g</strong></dt>
<dd>dump gencode-*</dd>
<dt><strong>-h</strong></dt>
<dd>show this help screen and exit</dd>
<dt><strong>-L</strong></dt>
<dd>disable line number prefix (default)</dd>
<dt><strong>-l</strong></dt>
<dd>enable line number prefix (disabled by default)</dd>
<dt><strong>-m</strong></dt>
<dd>dump messages</dd>
<dt><strong>-o</strong></dt>
<dd>dump executions' stdout</dd>
<dt><strong>-p</strong></dt>
<dd>dump parameters</dd>
<dt><strong>-r</strong></dt>
<dd>dump executions' stderr</dd>
<dt><strong>-V</strong></dt>
<dd>show version and exit</dd>
<dt><strong>-v</strong></dt>
<dd>increase verbosity</dd>
<h2><span class="section-number">10.4. </span>OPTIONS<a class="headerlink" href="#options" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt><strong>-a</strong></dt><dd><p>dump all</p>
</dd>
<dt><strong>-C CACHE-DIR</strong></dt><dd><p>use specified CACHE-DIR (default: ~/.cdist/cache)</p>
</dd>
<dt><strong>-c</strong></dt><dd><p>dump code-*</p>
</dd>
<dt><strong>-d DELIMITER</strong></dt><dd><p>delimiter used for filename and line number prefix (default: ':')</p>
</dd>
<dt><strong>-E</strong></dt><dd><p>dump global explorers</p>
</dd>
<dt><strong>-e</strong></dt><dd><p>dump type explorers</p>
</dd>
<dt><strong>-F</strong></dt><dd><p>disable filename prefix (enabled by default)</p>
</dd>
<dt><strong>-f</strong></dt><dd><p>enable filename prefix (default)</p>
</dd>
<dt><strong>-g</strong></dt><dd><p>dump gencode-*</p>
</dd>
<dt><strong>-h</strong></dt><dd><p>show this help screen and exit</p>
</dd>
<dt><strong>-L</strong></dt><dd><p>disable line number prefix (default)</p>
</dd>
<dt><strong>-l</strong></dt><dd><p>enable line number prefix (disabled by default)</p>
</dd>
<dt><strong>-m</strong></dt><dd><p>dump messages</p>
</dd>
<dt><strong>-o</strong></dt><dd><p>dump executions' stdout</p>
</dd>
<dt><strong>-p</strong></dt><dd><p>dump parameters</p>
</dd>
<dt><strong>-r</strong></dt><dd><p>dump executions' stderr</p>
</dd>
<dt><strong>-V</strong></dt><dd><p>show version and exit</p>
</dd>
<dt><strong>-v</strong></dt><dd><p>increase verbosity</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>10.5. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># Dump all</span>
<h2><span class="section-number">10.5. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Dump all</span>
% cdist-dump -a
<span class="c1"># Dump only code-* output</span>
@ -274,15 +265,15 @@ new types.</p>
</div>
</div>
<div class="section" id="see-also">
<h2>10.6. SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">10.6. </span>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<p><strong>cdist</strong>(1)</p>
</div>
<div class="section" id="authors">
<h2>10.7. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">10.7. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Darko Poljak &lt;<a class="reference external" href="mailto:darko&#46;poljak--&#37;&#52;&#48;--ungleich&#46;ch">darko<span>&#46;</span>poljak--<span>&#64;</span>--ungleich<span>&#46;</span>ch</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>10.8. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">10.8. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2019 Darko Poljak. Free use of this software is
granted under the terms of the GNU General Public License v3 or later (GPLv3+).</p>
</div>

73
src/extra/manual/beta/man1/cdist-new-type.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>11. cdist-new-type(1) &mdash; cdist 6.5.6 documentation</title>
<title>11. cdist-new-type(1) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -183,7 +174,7 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li>11. cdist-new-type(1)</li>
<li><span class="section-number">11. </span>cdist-new-type(1)</li>
<li class="wy-breadcrumbs-aside">
@ -203,46 +194,46 @@
<div itemprop="articleBody">
<div class="section" id="cdist-new-type-1">
<h1>11. cdist-new-type(1)<a class="headerlink" href="#cdist-new-type-1" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">11. </span>cdist-new-type(1)<a class="headerlink" href="#cdist-new-type-1" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>11.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">11.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-new-type - Create new type skeleton</p>
</div>
<div class="section" id="synopsis">
<h2>11.2. SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline"></a></h2>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cdist</span><span class="o">-</span><span class="n">new</span><span class="o">-</span><span class="nb">type</span> <span class="n">TYPE</span><span class="o">-</span><span class="n">NAME</span> <span class="n">AUTHOR</span><span class="o">-</span><span class="n">NAME</span> <span class="n">AUTHOR</span><span class="o">-</span><span class="n">EMAIL</span> <span class="p">[</span><span class="n">TYPE</span><span class="o">-</span><span class="n">BASE</span><span class="o">-</span><span class="n">PATH</span><span class="p">]</span>
<h2><span class="section-number">11.2. </span>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline"></a></h2>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cdist</span><span class="o">-</span><span class="n">new</span><span class="o">-</span><span class="nb">type</span> <span class="n">TYPE</span><span class="o">-</span><span class="n">NAME</span> <span class="n">AUTHOR</span><span class="o">-</span><span class="n">NAME</span> <span class="n">AUTHOR</span><span class="o">-</span><span class="n">EMAIL</span> <span class="p">[</span><span class="n">TYPE</span><span class="o">-</span><span class="n">BASE</span><span class="o">-</span><span class="n">PATH</span><span class="p">]</span>
</pre></div>
</div>
</div>
<div class="section" id="description">
<h2>11.3. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">11.3. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>cdist-new-type is a helper script that creates new type skeleton.
It is then up to the type author to finish the type.</p>
<p>It creates skeletons for the following files:</p>
<ul class="simple">
<li>man.rst</li>
<li>manifest</li>
<li>gencode-remote.</li>
<li><p>man.rst</p></li>
<li><p>manifest</p></li>
<li><p>gencode-remote.</p></li>
</ul>
<p>Upon creation it prints the path to the newly created type directory.</p>
</div>
<div class="section" id="arguments">
<h2>11.4. ARGUMENTS<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt><strong>TYPE-NAME</strong></dt>
<dd>Name of the new type.</dd>
<dt><strong>AUTHOR-NAME</strong></dt>
<dd>Type author's full name.</dd>
<dt><strong>AUTHOR-NAME</strong></dt>
<dd>Type author's email.</dd>
<dt><strong>TYPE-BASE-PATH</strong></dt>
<dd>Path to the base directory of the type. If not set it defaults
to '$PWD/type'.</dd>
<h2><span class="section-number">11.4. </span>ARGUMENTS<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt><strong>TYPE-NAME</strong></dt><dd><p>Name of the new type.</p>
</dd>
<dt><strong>AUTHOR-NAME</strong></dt><dd><p>Type author's full name.</p>
</dd>
<dt><strong>AUTHOR-NAME</strong></dt><dd><p>Type author's email.</p>
</dd>
<dt><strong>TYPE-BASE-PATH</strong></dt><dd><p>Path to the base directory of the type. If not set it defaults
to '$PWD/type'.</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>11.5. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># Create new type __foo in ~/.cdist directory.</span>
<h2><span class="section-number">11.5. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Create new type __foo in ~/.cdist directory.</span>
$ <span class="nb">cd</span> ~/.cdist
$ cdist-new-type <span class="s1">&#39;__foo&#39;</span> <span class="s1">&#39;Foo Bar&#39;</span> <span class="s1">&#39;foo.bar at foobar.org&#39;</span>
/home/foo/.cdist/type/__foo
@ -250,18 +241,18 @@ $ cdist-new-type <span class="s1">&#39;__foo&#39;</span> <span class="s1">&#39;F
</div>
</div>
<div class="section" id="see-also">
<h2>11.6. SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">11.6. </span>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<p><strong>cdist</strong>(1)</p>
</div>
<div class="section" id="authors">
<h2>11.7. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">11.7. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">Steven Armstrong &lt;<a class="reference external" href="mailto:steven-cdist--&#37;&#52;&#48;--armstrong&#46;cc">steven-cdist--<span>&#64;</span>--armstrong<span>&#46;</span>cc</a>&gt;</div>
<div class="line">Darko Poljak &lt;<a class="reference external" href="mailto:darko&#46;poljak--&#37;&#52;&#48;--ungleich&#46;ch">darko<span>&#46;</span>poljak--<span>&#64;</span>--ungleich<span>&#46;</span>ch</a>&gt;</div>
</div>
</div>
<div class="section" id="copying">
<h2>11.8. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">11.8. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2019 Steven Armstrong, Darko Poljak. Free use of this software is
granted under the terms of the GNU General Public License v3 or later (GPLv3+).</p>
</div>

1034
src/extra/manual/beta/man1/cdist.html
View File

File diff suppressed because it is too large Load Diff

95
src/extra/manual/beta/man7/cdist-type__acl.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.1. cdist-type__acl(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.1. cdist-type__acl(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -347,9 +338,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.1. cdist-type__acl(7)</li>
<li><span class="section-number">16.1. </span>cdist-type__acl(7)</li>
<li class="wy-breadcrumbs-aside">
@ -369,58 +360,58 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-acl-7">
<h1>16.1. cdist-type__acl(7)<a class="headerlink" href="#cdist-type-acl-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.1. </span>cdist-type__acl(7)<a class="headerlink" href="#cdist-type-acl-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.1.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.1.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__acl - Set ACL entries</p>
</div>
<div class="section" id="description">
<h2>16.1.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.1.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Fully supported and tested on Linux (ext4 filesystem), partial support for FreeBSD.</p>
<p>See <code class="docutils literal"><span class="pre">setfacl</span></code> and <code class="docutils literal"><span class="pre">acl</span></code> manpages for more details.</p>
<p>See <code class="docutils literal notranslate"><span class="pre">setfacl</span></code> and <code class="docutils literal notranslate"><span class="pre">acl</span></code> manpages for more details.</p>
</div>
<div class="section" id="required-multiple-parameters">
<h2>16.1.3. REQUIRED MULTIPLE PARAMETERS<a class="headerlink" href="#required-multiple-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>entry</dt>
<dd>Set ACL entry following <code class="docutils literal"><span class="pre">getfacl</span></code> output syntax.</dd>
<h2><span class="section-number">16.1.3. </span>REQUIRED MULTIPLE PARAMETERS<a class="headerlink" href="#required-multiple-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>entry</dt><dd><p>Set ACL entry following <code class="docutils literal notranslate"><span class="pre">getfacl</span></code> output syntax.</p>
</dd>
</dl>
</div>
<div class="section" id="optional-parameters">
<h2>16.1.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>source</dt>
<dd>Read ACL entries from stdin or file.
<h2><span class="section-number">16.1.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>source</dt><dd><p>Read ACL entries from stdin or file.
Ordering of entries is not important.
When reading from file, comments and empty lines are ignored.</dd>
<dt>file</dt>
<dd>Create/change file with <code class="docutils literal"><span class="pre">__file</span></code> using <code class="docutils literal"><span class="pre">user:group:mode</span></code> pattern.</dd>
<dt>directory</dt>
<dd>Create/change directory with <code class="docutils literal"><span class="pre">__directory</span></code> using <code class="docutils literal"><span class="pre">user:group:mode</span></code> pattern.</dd>
When reading from file, comments and empty lines are ignored.</p>
</dd>
<dt>file</dt><dd><p>Create/change file with <code class="docutils literal notranslate"><span class="pre">__file</span></code> using <code class="docutils literal notranslate"><span class="pre">user:group:mode</span></code> pattern.</p>
</dd>
<dt>directory</dt><dd><p>Create/change directory with <code class="docutils literal notranslate"><span class="pre">__directory</span></code> using <code class="docutils literal notranslate"><span class="pre">user:group:mode</span></code> pattern.</p>
</dd>
</dl>
</div>
<div class="section" id="boolean-parameters">
<h2>16.1.5. BOOLEAN PARAMETERS<a class="headerlink" href="#boolean-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>default</dt>
<dd>Set all ACL entries as default too.
<h2><span class="section-number">16.1.5. </span>BOOLEAN PARAMETERS<a class="headerlink" href="#boolean-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>default</dt><dd><p>Set all ACL entries as default too.
Only directories can have default ACLs.
Setting default ACL in FreeBSD is currently not supported.</dd>
<dt>recursive</dt>
<dd>Make <code class="docutils literal"><span class="pre">setfacl</span></code> recursive (Linux only), but not <code class="docutils literal"><span class="pre">getfacl</span></code> in explorer.</dd>
<dt>remove</dt>
<dd>Remove undefined ACL entries.
<code class="docutils literal"><span class="pre">mask</span></code> and <code class="docutils literal"><span class="pre">other</span></code> entries can't be removed, but only changed.</dd>
Setting default ACL in FreeBSD is currently not supported.</p>
</dd>
<dt>recursive</dt><dd><p>Make <code class="docutils literal notranslate"><span class="pre">setfacl</span></code> recursive (Linux only), but not <code class="docutils literal notranslate"><span class="pre">getfacl</span></code> in explorer.</p>
</dd>
<dt>remove</dt><dd><p>Remove undefined ACL entries.
<code class="docutils literal notranslate"><span class="pre">mask</span></code> and <code class="docutils literal notranslate"><span class="pre">other</span></code> entries can't be removed, but only changed.</p>
</dd>
</dl>
</div>
<div class="section" id="deprecated-parameters">
<h2>16.1.6. DEPRECATED PARAMETERS<a class="headerlink" href="#deprecated-parameters" title="Permalink to this headline"></a></h2>
<p>Parameters <code class="docutils literal"><span class="pre">acl</span></code>, <code class="docutils literal"><span class="pre">user</span></code>, <code class="docutils literal"><span class="pre">group</span></code>, <code class="docutils literal"><span class="pre">mask</span></code> and <code class="docutils literal"><span class="pre">other</span></code> are deprecated and they
will be removed in future versions. Please use <code class="docutils literal"><span class="pre">entry</span></code> parameter instead.</p>
<h2><span class="section-number">16.1.6. </span>DEPRECATED PARAMETERS<a class="headerlink" href="#deprecated-parameters" title="Permalink to this headline"></a></h2>
<p>Parameters <code class="docutils literal notranslate"><span class="pre">acl</span></code>, <code class="docutils literal notranslate"><span class="pre">user</span></code>, <code class="docutils literal notranslate"><span class="pre">group</span></code>, <code class="docutils literal notranslate"><span class="pre">mask</span></code> and <code class="docutils literal notranslate"><span class="pre">other</span></code> are deprecated and they
will be removed in future versions. Please use <code class="docutils literal notranslate"><span class="pre">entry</span></code> parameter instead.</p>
</div>
<div class="section" id="examples">
<h2>16.1.7. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__acl /srv/project <span class="se">\</span>
<h2><span class="section-number">16.1.7. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>__acl /srv/project <span class="se">\</span>
--default <span class="se">\</span>
--recursive <span class="se">\</span>
--remove <span class="se">\</span>
@ -460,11 +451,11 @@ __acl /path/to/directory <span class="se">\</span>
</div>
</div>
<div class="section" id="authors">
<h2>16.1.8. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.1.8. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Ander Punnar &lt;ander-at-kvlt-dot-ee&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.1.9. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.1.9. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2018 Ander Punnar. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

52
src/extra/manual/beta/man7/cdist-type__apt_default_release.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.2. cdist-type__apt_default_release(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.2. cdist-type__apt_default_release(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -345,9 +336,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.2. cdist-type__apt_default_release(7)</li>
<li><span class="section-number">16.2. </span>cdist-type__apt_default_release(7)</li>
<li class="wy-breadcrumbs-aside">
@ -367,42 +358,41 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-apt-default-release-7">
<h1>16.2. cdist-type__apt_default_release(7)<a class="headerlink" href="#cdist-type-apt-default-release-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.2. </span>cdist-type__apt_default_release(7)<a class="headerlink" href="#cdist-type-apt-default-release-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.2.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.2.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__apt_default_release - Configure the default release for apt</p>
</div>
<div class="section" id="description">
<h2>16.2.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.2.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Configure the default release for apt, using the APT::Default-Release
configuration value.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.2.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>release</dt>
<dd><p class="first">The value to set APT::Default-Release to.</p>
<p class="last">This can contain release name, codename or release version. Examples:
<h2><span class="section-number">16.2.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl>
<dt>release</dt><dd><p>The value to set APT::Default-Release to.</p>
<p>This can contain release name, codename or release version. Examples:
'stable', 'testing', 'unstable', 'stretch', 'buster', '4.0', '5.0*'.</p>
</dd>
</dl>
</div>
<div class="section" id="optional-parameters">
<h2>16.2.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.2.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<p>None.</p>
</div>
<div class="section" id="examples">
<h2>16.2.5. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__apt_default_release --release stretch
<h2><span class="section-number">16.2.5. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>__apt_default_release --release stretch
</pre></div>
</div>
</div>
<div class="section" id="authors">
<h2>16.2.6. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.2.6. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Matthijs Kooijman &lt;<a class="reference external" href="mailto:matthijs--&#37;&#52;&#48;--stdin&#46;nl">matthijs--<span>&#64;</span>--stdin<span>&#46;</span>nl</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.2.7. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.2.7. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2017 Matthijs Kooijman. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

69
src/extra/manual/beta/man7/cdist-type__apt_key.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.3. cdist-type__apt_key(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.3. cdist-type__apt_key(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -345,9 +336,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.3. cdist-type__apt_key(7)</li>
<li><span class="section-number">16.3. </span>cdist-type__apt_key(7)</li>
<li class="wy-breadcrumbs-aside">
@ -367,38 +358,38 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-apt-key-7">
<h1>16.3. cdist-type__apt_key(7)<a class="headerlink" href="#cdist-type-apt-key-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.3. </span>cdist-type__apt_key(7)<a class="headerlink" href="#cdist-type-apt-key-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.3.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.3.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__apt_key - Manage the list of keys used by apt</p>
</div>
<div class="section" id="description">
<h2>16.3.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.3.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Manages the list of keys used by apt to authenticate packages.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.3.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.3.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<p>None.</p>
</div>
<div class="section" id="optional-parameters">
<h2>16.3.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>state</dt>
<dd>'present' or 'absent'. Defaults to 'present'</dd>
<dt>keyid</dt>
<dd>the id of the key to add. Defaults to __object_id</dd>
<dt>keyserver</dt>
<dd>the keyserver from which to fetch the key. If omitted the default set
in ./parameter/default/keyserver is used.</dd>
<dt>keydir</dt>
<dd>key save location, defaults to <code class="docutils literal"><span class="pre">/etc/apt/trusted.pgp.d</span></code></dd>
<dt>uri</dt>
<dd>the URI from which to download the key</dd>
<h2><span class="section-number">16.3.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>state</dt><dd><p>'present' or 'absent'. Defaults to 'present'</p>
</dd>
<dt>keyid</dt><dd><p>the id of the key to add. Defaults to __object_id</p>
</dd>
<dt>keyserver</dt><dd><p>the keyserver from which to fetch the key. If omitted the default set
in ./parameter/default/keyserver is used.</p>
</dd>
<dt>keydir</dt><dd><p>key save location, defaults to <code class="docutils literal notranslate"><span class="pre">/etc/apt/trusted.pgp.d</span></code></p>
</dd>
<dt>uri</dt><dd><p>the URI from which to download the key</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>16.3.5. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># Add Ubuntu Archive Automatic Signing Key</span>
<h2><span class="section-number">16.3.5. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Add Ubuntu Archive Automatic Signing Key</span>
__apt_key 437D05B5
<span class="c1"># Same thing</span>
__apt_key 437D05B5 --state present
@ -418,12 +409,12 @@ __apt_key rabbitmq <span class="se">\</span>
</div>
</div>
<div class="section" id="authors">
<h2>16.3.6. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.3.6. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Steven Armstrong &lt;<a class="reference external" href="mailto:steven-cdist--&#37;&#52;&#48;--armstrong&#46;cc">steven-cdist--<span>&#64;</span>--armstrong<span>&#46;</span>cc</a>&gt;
Ander Punnar &lt;ander-at-kvlt-dot-ee&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.3.7. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.3.7. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2011-2019 Steven Armstrong and Ander Punnar. You can
redistribute it and/or modify it under the terms of the GNU General Public
License as published by the Free Software Foundation, either version 3 of the

63
src/extra/manual/beta/man7/cdist-type__apt_key_uri.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.4. cdist-type__apt_key_uri(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.4. cdist-type__apt_key_uri(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -345,9 +336,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.4. cdist-type__apt_key_uri(7)</li>
<li><span class="section-number">16.4. </span>cdist-type__apt_key_uri(7)</li>
<li class="wy-breadcrumbs-aside">
@ -367,35 +358,35 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-apt-key-uri-7">
<h1>16.4. cdist-type__apt_key_uri(7)<a class="headerlink" href="#cdist-type-apt-key-uri-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.4. </span>cdist-type__apt_key_uri(7)<a class="headerlink" href="#cdist-type-apt-key-uri-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.4.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.4.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__apt_key_uri - Add apt key from uri</p>
</div>
<div class="section" id="description">
<h2>16.4.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.4.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Download a key from an uri and add it to the apt keyring.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.4.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>uri</dt>
<dd>the uri from which to download the key</dd>
<h2><span class="section-number">16.4.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>uri</dt><dd><p>the uri from which to download the key</p>
</dd>
</dl>
</div>
<div class="section" id="optional-parameters">
<h2>16.4.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>state</dt>
<dd>'present' or 'absent', defaults to 'present'</dd>
<dt>name</dt>
<dd>a name for this key, used when testing if it is already installed.
Defaults to __object_id</dd>
<h2><span class="section-number">16.4.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>state</dt><dd><p>'present' or 'absent', defaults to 'present'</p>
</dd>
<dt>name</dt><dd><p>a name for this key, used when testing if it is already installed.
Defaults to __object_id</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>16.4.5. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__apt_key_uri rabbitmq <span class="se">\</span>
<h2><span class="section-number">16.4.5. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>__apt_key_uri rabbitmq <span class="se">\</span>
--name <span class="s1">&#39;RabbitMQ Release Signing Key &lt;info@rabbitmq.com&gt;&#39;</span> <span class="se">\</span>
--uri http://www.rabbitmq.com/rabbitmq-signing-key-public.asc <span class="se">\</span>
--state present
@ -403,11 +394,11 @@ Defaults to __object_id</dd>
</div>
</div>
<div class="section" id="authors">
<h2>16.4.6. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.4.6. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Steven Armstrong &lt;<a class="reference external" href="mailto:steven-cdist--&#37;&#52;&#48;--armstrong&#46;cc">steven-cdist--<span>&#64;</span>--armstrong<span>&#46;</span>cc</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.4.7. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.4.7. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2011-2014 Steven Armstrong. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

57
src/extra/manual/beta/man7/cdist-type__apt_mark.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.5. cdist-type__apt_mark(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.5. cdist-type__apt_mark(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -345,9 +336,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.5. cdist-type__apt_mark(7)</li>
<li><span class="section-number">16.5. </span>cdist-type__apt_mark(7)</li>
<li class="wy-breadcrumbs-aside">
@ -367,32 +358,32 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-apt-mark-7">
<h1>16.5. cdist-type__apt_mark(7)<a class="headerlink" href="#cdist-type-apt-mark-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.5. </span>cdist-type__apt_mark(7)<a class="headerlink" href="#cdist-type-apt-mark-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.5.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.5.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__apt_mark - set package state as 'hold' or 'unhold'</p>
</div>
<div class="section" id="description">
<h2>16.5.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.5.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>See apt-mark(8) for details.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.5.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>state</dt>
<dd>Either &quot;hold&quot; or &quot;unhold&quot;.</dd>
<h2><span class="section-number">16.5.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>state</dt><dd><p>Either &quot;hold&quot; or &quot;unhold&quot;.</p>
</dd>
</dl>
</div>
<div class="section" id="optional-parameters">
<h2>16.5.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>name</dt>
<dd>If supplied, use the name and not the object id as the package name.</dd>
<h2><span class="section-number">16.5.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>name</dt><dd><p>If supplied, use the name and not the object id as the package name.</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>16.5.5. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># hold package</span>
<h2><span class="section-number">16.5.5. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># hold package</span>
__apt_mark quagga --state hold
<span class="c1"># unhold package</span>
__apt_mark quagga --state unhold
@ -400,11 +391,11 @@ __apt_mark quagga --state unhold
</div>
</div>
<div class="section" id="authors">
<h2>16.5.6. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.5.6. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Ander Punnar &lt;<a class="reference external" href="mailto:cdist--&#37;&#52;&#48;--kvlt&#46;ee">cdist--<span>&#64;</span>--kvlt<span>&#46;</span>ee</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.5.7. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.5.7. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2016 Ander Punnar. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

45
src/extra/manual/beta/man7/cdist-type__apt_norecommends.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.6. cdist-type__apt_norecommends(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.6. cdist-type__apt_norecommends(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -345,9 +336,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.6. cdist-type__apt_norecommends(7)</li>
<li><span class="section-number">16.6. </span>cdist-type__apt_norecommends(7)</li>
<li class="wy-breadcrumbs-aside">
@ -367,35 +358,35 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-apt-norecommends-7">
<h1>16.6. cdist-type__apt_norecommends(7)<a class="headerlink" href="#cdist-type-apt-norecommends-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.6. </span>cdist-type__apt_norecommends(7)<a class="headerlink" href="#cdist-type-apt-norecommends-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.6.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.6.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__apt_norecommends - Configure apt to not install recommended packages</p>
</div>
<div class="section" id="description">
<h2>16.6.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.6.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Configure apt to not install any recommended or suggested packages.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.6.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.6.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<p>None.</p>
</div>
<div class="section" id="optional-parameters">
<h2>16.6.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.6.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<p>None.</p>
</div>
<div class="section" id="examples">
<h2>16.6.5. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__apt_norecommends
<h2><span class="section-number">16.6.5. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>__apt_norecommends
</pre></div>
</div>
</div>
<div class="section" id="authors">
<h2>16.6.6. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.6.6. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Steven Armstrong &lt;<a class="reference external" href="mailto:steven-cdist--&#37;&#52;&#48;--armstrong&#46;cc">steven-cdist--<span>&#64;</span>--armstrong<span>&#46;</span>cc</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.6.7. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.6.7. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2014 Steven Armstrong. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

53
src/extra/manual/beta/man7/cdist-type__apt_ppa.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.7. cdist-type__apt_ppa(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.7. cdist-type__apt_ppa(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -345,9 +336,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.7. cdist-type__apt_ppa(7)</li>
<li><span class="section-number">16.7. </span>cdist-type__apt_ppa(7)</li>
<li class="wy-breadcrumbs-aside">
@ -367,30 +358,30 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-apt-ppa-7">
<h1>16.7. cdist-type__apt_ppa(7)<a class="headerlink" href="#cdist-type-apt-ppa-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.7. </span>cdist-type__apt_ppa(7)<a class="headerlink" href="#cdist-type-apt-ppa-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.7.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.7.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__apt_ppa - Manage ppa repositories</p>
</div>
<div class="section" id="description">
<h2>16.7.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.7.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>This cdist type allows manage ubuntu ppa repositories.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.7.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>state</dt>
<dd>The state the ppa should be in, either 'present' or 'absent'.
Defaults to 'present'</dd>
<h2><span class="section-number">16.7.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>state</dt><dd><p>The state the ppa should be in, either 'present' or 'absent'.
Defaults to 'present'</p>
</dd>
</dl>
</div>
<div class="section" id="optional-parameters">
<h2>16.7.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.7.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<p>None.</p>
</div>
<div class="section" id="examples">
<h2>16.7.5. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># Enable a ppa repository</span>
<h2><span class="section-number">16.7.5. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Enable a ppa repository</span>
__apt_ppa ppa:sans-intern/missing-bits
<span class="c1"># same as</span>
__apt_ppa ppa:sans-intern/missing-bits --state present
@ -401,11 +392,11 @@ __apt_ppa ppa:sans-intern/missing-bits --state absent
</div>
</div>
<div class="section" id="authors">
<h2>16.7.6. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.7.6. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Steven Armstrong &lt;<a class="reference external" href="mailto:steven-cdist--&#37;&#52;&#48;--armstrong&#46;cc">steven-cdist--<span>&#64;</span>--armstrong<span>&#46;</span>cc</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.7.7. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.7.7. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2011-2014 Steven Armstrong. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

79
src/extra/manual/beta/man7/cdist-type__apt_source.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.8. cdist-type__apt_source(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.8. cdist-type__apt_source(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -346,9 +337,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.8. cdist-type__apt_source(7)</li>
<li><span class="section-number">16.8. </span>cdist-type__apt_source(7)</li>
<li class="wy-breadcrumbs-aside">
@ -368,47 +359,47 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-apt-source-7">
<h1>16.8. cdist-type__apt_source(7)<a class="headerlink" href="#cdist-type-apt-source-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.8. </span>cdist-type__apt_source(7)<a class="headerlink" href="#cdist-type-apt-source-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.8.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.8.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__apt_source - Manage apt sources</p>
</div>
<div class="section" id="description">
<h2>16.8.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.8.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>This cdist type allows you to manage apt sources. It invokes index update
internally when needed so call of index updating type is not needed.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.8.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>uri</dt>
<dd>the uri to the apt repository</dd>
<h2><span class="section-number">16.8.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>uri</dt><dd><p>the uri to the apt repository</p>
</dd>
</dl>
</div>
<div class="section" id="optional-parameters">
<h2>16.8.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>arch</dt>
<dd>set this if you need to force and specific arch (ubuntu specific)</dd>
<dt>state</dt>
<dd>'present' or 'absent', defaults to 'present'</dd>
<dt>distribution</dt>
<dd>the distribution codename to use. Defaults to DISTRIB_CODENAME from
the targets /etc/lsb-release</dd>
<dt>component</dt>
<dd>space delimited list of components to enable. Defaults to an empty string.</dd>
<h2><span class="section-number">16.8.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>arch</dt><dd><p>set this if you need to force and specific arch (ubuntu specific)</p>
</dd>
<dt>state</dt><dd><p>'present' or 'absent', defaults to 'present'</p>
</dd>
<dt>distribution</dt><dd><p>the distribution codename to use. Defaults to DISTRIB_CODENAME from
the targets /etc/lsb-release</p>
</dd>
<dt>component</dt><dd><p>space delimited list of components to enable. Defaults to an empty string.</p>
</dd>
</dl>
</div>
<div class="section" id="boolean-parameters">
<h2>16.8.5. BOOLEAN PARAMETERS<a class="headerlink" href="#boolean-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>include-src</dt>
<dd>include deb-src entries</dd>
<h2><span class="section-number">16.8.5. </span>BOOLEAN PARAMETERS<a class="headerlink" href="#boolean-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>include-src</dt><dd><p>include deb-src entries</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>16.8.6. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__apt_source rabbitmq <span class="se">\</span>
<h2><span class="section-number">16.8.6. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>__apt_source rabbitmq <span class="se">\</span>
--uri http://www.rabbitmq.com/debian/ <span class="se">\</span>
--distribution testing <span class="se">\</span>
--component main <span class="se">\</span>
@ -422,11 +413,11 @@ __apt_source canonical_partner <span class="se">\</span>
</div>
</div>
<div class="section" id="authors">
<h2>16.8.7. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.8.7. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Steven Armstrong &lt;<a class="reference external" href="mailto:steven-cdist--&#37;&#52;&#48;--armstrong&#46;cc">steven-cdist--<span>&#64;</span>--armstrong<span>&#46;</span>cc</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.8.8. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.8.8. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2011-2018 Steven Armstrong. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

88
src/extra/manual/beta/man7/cdist-type__apt_unattended_upgrades.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.9. cdist-type__apt_unattended_upgrades(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.9. cdist-type__apt_unattended_upgrades(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -344,9 +335,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.9. cdist-type__apt_unattended_upgrades(7)</li>
<li><span class="section-number">16.9. </span>cdist-type__apt_unattended_upgrades(7)</li>
<li class="wy-breadcrumbs-aside">
@ -366,49 +357,48 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-apt-unattended-upgrades-7">
<h1>16.9. cdist-type__apt_unattended_upgrades(7)<a class="headerlink" href="#cdist-type-apt-unattended-upgrades-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.9. </span>cdist-type__apt_unattended_upgrades(7)<a class="headerlink" href="#cdist-type-apt-unattended-upgrades-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.9.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.9.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__apt_unattended_upgrades - automatic installation of updates</p>
</div>
<div class="section" id="description">
<h2>16.9.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.9.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Install and configure unattended-upgrades package.</p>
<p>For more information see <a class="reference external" href="https://wiki.debian.org/UnattendedUpgrades">https://wiki.debian.org/UnattendedUpgrades</a>.</p>
</div>
<div class="section" id="optional-multiple-parameters">
<h2>16.9.3. OPTIONAL MULTIPLE PARAMETERS<a class="headerlink" href="#optional-multiple-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>option</dt>
<dd><p class="first">Set options for unattended-upgrades. See examples.</p>
<h2><span class="section-number">16.9.3. </span>OPTIONAL MULTIPLE PARAMETERS<a class="headerlink" href="#optional-multiple-parameters" title="Permalink to this headline"></a></h2>
<dl>
<dt>option</dt><dd><p>Set options for unattended-upgrades. See examples.</p>
<p>Supported options with default values (as of 2020-01-17) are:</p>
<ul class="last simple">
<li>AutoFixInterruptedDpkg, default is &quot;true&quot;</li>
<li>MinimalSteps, default is &quot;true&quot;</li>
<li>InstallOnShutdown, default is &quot;false&quot;</li>
<li>Mail, default is &quot;&quot; (empty)</li>
<li>MailOnlyOnError, default is &quot;false&quot;</li>
<li>Remove-Unused-Kernel-Packages, default is &quot;true&quot;</li>
<li>Remove-New-Unused-Dependencies, default is &quot;true&quot;</li>
<li>Remove-Unused-Dependencies, default is &quot;false&quot;</li>
<li>Automatic-Reboot, default is &quot;false&quot;</li>
<li>Automatic-Reboot-WithUsers, default is &quot;true&quot;</li>
<li>Automatic-Reboot-Time, default is &quot;02:00&quot;</li>
<li>SyslogEnable, default is &quot;false&quot;</li>
<li>SyslogFacility, default is &quot;daemon&quot;</li>
<li>OnlyOnACPower, default is &quot;true&quot;</li>
<li>Skip-Updates-On-Metered-Connections, default is &quot;true&quot;</li>
<li>Verbose, default is &quot;false&quot;</li>
<li>Debug, default is &quot;false&quot;</li>
<ul class="simple">
<li><p>AutoFixInterruptedDpkg, default is &quot;true&quot;</p></li>
<li><p>MinimalSteps, default is &quot;true&quot;</p></li>
<li><p>InstallOnShutdown, default is &quot;false&quot;</p></li>
<li><p>Mail, default is &quot;&quot; (empty)</p></li>
<li><p>MailOnlyOnError, default is &quot;false&quot;</p></li>
<li><p>Remove-Unused-Kernel-Packages, default is &quot;true&quot;</p></li>
<li><p>Remove-New-Unused-Dependencies, default is &quot;true&quot;</p></li>
<li><p>Remove-Unused-Dependencies, default is &quot;false&quot;</p></li>
<li><p>Automatic-Reboot, default is &quot;false&quot;</p></li>
<li><p>Automatic-Reboot-WithUsers, default is &quot;true&quot;</p></li>
<li><p>Automatic-Reboot-Time, default is &quot;02:00&quot;</p></li>
<li><p>SyslogEnable, default is &quot;false&quot;</p></li>
<li><p>SyslogFacility, default is &quot;daemon&quot;</p></li>
<li><p>OnlyOnACPower, default is &quot;true&quot;</p></li>
<li><p>Skip-Updates-On-Metered-Connections, default is &quot;true&quot;</p></li>
<li><p>Verbose, default is &quot;false&quot;</p></li>
<li><p>Debug, default is &quot;false&quot;</p></li>
</ul>
</dd>
<dt>blacklist</dt>
<dd>Python regular expressions, matching packages to exclude from upgrading.</dd>
<dt>blacklist</dt><dd><p>Python regular expressions, matching packages to exclude from upgrading.</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>16.9.4. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__apt_unattended_upgrades <span class="se">\</span>
<h2><span class="section-number">16.9.4. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>__apt_unattended_upgrades <span class="se">\</span>
--option <span class="nv">Mail</span><span class="o">=</span>root <span class="se">\</span>
--option <span class="nv">MailOnlyOnError</span><span class="o">=</span><span class="nb">true</span> <span class="se">\</span>
--blacklist multipath-tools <span class="se">\</span>
@ -417,11 +407,11 @@
</div>
</div>
<div class="section" id="authors">
<h2>16.9.5. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.9.5. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Ander Punnar &lt;ander-at-kvlt-dot-ee&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.9.6. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.9.6. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2020 Ander Punnar. You can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the Free
Software Foundation, either version 3 of the License, or (at your option) any

45
src/extra/manual/beta/man7/cdist-type__apt_update_index.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.10. cdist-type__apt_update_index(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.10. cdist-type__apt_update_index(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -345,9 +336,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.10. cdist-type__apt_update_index(7)</li>
<li><span class="section-number">16.10. </span>cdist-type__apt_update_index(7)</li>
<li class="wy-breadcrumbs-aside">
@ -367,35 +358,35 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-apt-update-index-7">
<h1>16.10. cdist-type__apt_update_index(7)<a class="headerlink" href="#cdist-type-apt-update-index-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.10. </span>cdist-type__apt_update_index(7)<a class="headerlink" href="#cdist-type-apt-update-index-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.10.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.10.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__apt_update_index - Update apt's package index</p>
</div>
<div class="section" id="description">
<h2>16.10.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.10.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>This cdist type runs apt-get update whenever any apt sources have changed.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.10.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.10.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<p>None.</p>
</div>
<div class="section" id="optional-parameters">
<h2>16.10.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.10.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<p>None.</p>
</div>
<div class="section" id="examples">
<h2>16.10.5. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__apt_update_index
<h2><span class="section-number">16.10.5. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>__apt_update_index
</pre></div>
</div>
</div>
<div class="section" id="authors">
<h2>16.10.6. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.10.6. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Steven Armstrong &lt;<a class="reference external" href="mailto:steven-cdist--&#37;&#52;&#48;--armstrong&#46;cc">steven-cdist--<span>&#64;</span>--armstrong<span>&#46;</span>cc</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.10.7. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.10.7. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2011 Steven Armstrong. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

93
src/extra/manual/beta/man7/cdist-type__block.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.11. cdist-type__block(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.11. cdist-type__block(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -346,9 +337,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.11. cdist-type__block(7)</li>
<li><span class="section-number">16.11. </span>cdist-type__block(7)</li>
<li class="wy-breadcrumbs-aside">
@ -368,56 +359,56 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-block-7">
<h1>16.11. cdist-type__block(7)<a class="headerlink" href="#cdist-type-block-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.11. </span>cdist-type__block(7)<a class="headerlink" href="#cdist-type-block-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.11.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.11.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__block - Manage blocks of text in files</p>
</div>
<div class="section" id="description">
<h2>16.11.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.11.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Manage a block of text in an existing file.
The block is identified using the prefix and suffix parameters.
Everything between prefix and suffix is considered to be a managed block
of text.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.11.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>text</dt>
<dd>the text to manage.
If text is '-' (dash), take what was written to stdin as the text.</dd>
<h2><span class="section-number">16.11.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>text</dt><dd><p>the text to manage.
If text is '-' (dash), take what was written to stdin as the text.</p>
</dd>
</dl>
</div>
<div class="section" id="optional-parameters">
<h2>16.11.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>file</dt>
<dd>the file in which to manage the text block.
Defaults to object_id.</dd>
<dt>prefix</dt>
<dd>the prefix to add before the text.
Defaults to #cdist:__block/$__object_id</dd>
<dt>suffix</dt>
<dd>the suffix to add after the text.
Defaults to #/cdist:__block/$__object_id</dd>
<dt>state</dt>
<dd>'present' or 'absent', defaults to 'present'</dd>
<h2><span class="section-number">16.11.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>file</dt><dd><p>the file in which to manage the text block.
Defaults to object_id.</p>
</dd>
<dt>prefix</dt><dd><p>the prefix to add before the text.
Defaults to #cdist:__block/$__object_id</p>
</dd>
<dt>suffix</dt><dd><p>the suffix to add after the text.
Defaults to #/cdist:__block/$__object_id</p>
</dd>
<dt>state</dt><dd><p>'present' or 'absent', defaults to 'present'</p>
</dd>
</dl>
</div>
<div class="section" id="messages">
<h2>16.11.5. MESSAGES<a class="headerlink" href="#messages" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>add</dt>
<dd>block was added</dd>
<dt>update</dt>
<dd>block was updated/changed</dd>
<dt>remove</dt>
<dd>block was removed</dd>
<h2><span class="section-number">16.11.5. </span>MESSAGES<a class="headerlink" href="#messages" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>add</dt><dd><p>block was added</p>
</dd>
<dt>update</dt><dd><p>block was updated/changed</p>
</dd>
<dt>remove</dt><dd><p>block was removed</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>16.11.6. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># text from argument</span>
<h2><span class="section-number">16.11.6. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># text from argument</span>
__block /path/to/file <span class="se">\</span>
--prefix <span class="s1">&#39;#start&#39;</span> <span class="se">\</span>
--suffix <span class="s1">&#39;#end&#39;</span> <span class="se">\</span>
@ -434,11 +425,11 @@ __block some-id <span class="se">\</span>
</div>
</div>
<div class="section" id="authors">
<h2>16.11.7. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.11.7. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Steven Armstrong &lt;<a class="reference external" href="mailto:steven-cdist--&#37;&#52;&#48;--armstrong&#46;cc">steven-cdist--<span>&#64;</span>--armstrong<span>&#46;</span>cc</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.11.8. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.11.8. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2013 Steven Armstrong. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

87
src/extra/manual/beta/man7/cdist-type__ccollect_source.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.12. cdist-type__ccollect_source(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.12. cdist-type__ccollect_source(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -348,9 +339,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.12. cdist-type__ccollect_source(7)</li>
<li><span class="section-number">16.12. </span>cdist-type__ccollect_source(7)</li>
<li class="wy-breadcrumbs-aside">
@ -370,52 +361,52 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-ccollect-source-7">
<h1>16.12. cdist-type__ccollect_source(7)<a class="headerlink" href="#cdist-type-ccollect-source-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.12. </span>cdist-type__ccollect_source(7)<a class="headerlink" href="#cdist-type-ccollect-source-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.12.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.12.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__ccollect_source - Manage ccollect sources</p>
</div>
<div class="section" id="description">
<h2>16.12.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.12.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>This cdist type allows you to create or delete ccollect sources.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.12.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>source</dt>
<dd>The source from which to backup</dd>
<dt>destination</dt>
<dd>The destination directory</dd>
<h2><span class="section-number">16.12.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>source</dt><dd><p>The source from which to backup</p>
</dd>
<dt>destination</dt><dd><p>The destination directory</p>
</dd>
</dl>
</div>
<div class="section" id="optional-parameters">
<h2>16.12.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>state</dt>
<dd>'present' or 'absent', defaults to 'present'</dd>
<dt>ccollectconf</dt>
<dd>The CCOLLECT_CONF directory. Defaults to /etc/ccollect.</dd>
<h2><span class="section-number">16.12.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>state</dt><dd><p>'present' or 'absent', defaults to 'present'</p>
</dd>
<dt>ccollectconf</dt><dd><p>The CCOLLECT_CONF directory. Defaults to /etc/ccollect.</p>
</dd>
</dl>
</div>
<div class="section" id="optional-multiple-parameters">
<h2>16.12.5. OPTIONAL MULTIPLE PARAMETERS<a class="headerlink" href="#optional-multiple-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>exclude</dt>
<dd>Paths to exclude of backup</dd>
<h2><span class="section-number">16.12.5. </span>OPTIONAL MULTIPLE PARAMETERS<a class="headerlink" href="#optional-multiple-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>exclude</dt><dd><p>Paths to exclude of backup</p>
</dd>
</dl>
</div>
<div class="section" id="boolean-parameters">
<h2>16.12.6. BOOLEAN PARAMETERS<a class="headerlink" href="#boolean-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>verbose</dt>
<dd>Whether to report backup verbosely</dd>
<dt>create-destination</dt>
<dd>Create the directory specified in the destination parameter on the remote host</dd>
<h2><span class="section-number">16.12.6. </span>BOOLEAN PARAMETERS<a class="headerlink" href="#boolean-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>verbose</dt><dd><p>Whether to report backup verbosely</p>
</dd>
<dt>create-destination</dt><dd><p>Create the directory specified in the destination parameter on the remote host</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>16.12.7. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__ccollect_source doc.ungleich.ch <span class="se">\</span>
<h2><span class="section-number">16.12.7. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>__ccollect_source doc.ungleich.ch <span class="se">\</span>
--source doc.ungleich.ch:/ <span class="se">\</span>
--destination /backup/doc.ungleich.ch <span class="se">\</span>
--exclude <span class="s1">&#39;/proc/*&#39;</span> --exclude <span class="s1">&#39;/sys/*&#39;</span> <span class="se">\</span>
@ -431,15 +422,15 @@ __ccollect_source doc.ungleich.ch <span class="se">\</span>
</div>
</div>
<div class="section" id="see-also">
<h2>16.12.8. SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.12.8. </span>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<p><strong>ccollect</strong>(1)</p>
</div>
<div class="section" id="authors">
<h2>16.12.9. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.12.9. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Nico Schottelius &lt;<a class="reference external" href="mailto:nico-cdist--&#37;&#52;&#48;--schottelius&#46;org">nico-cdist--<span>&#64;</span>--schottelius<span>&#46;</span>org</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.12.10. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.12.10. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2014 Nico Schottelius. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

65
src/extra/manual/beta/man7/cdist-type__cdist.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.13. cdist-type__cdist(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.13. cdist-type__cdist(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -345,9 +336,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.13. cdist-type__cdist(7)</li>
<li><span class="section-number">16.13. </span>cdist-type__cdist(7)</li>
<li class="wy-breadcrumbs-aside">
@ -367,13 +358,13 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-cdist-7">
<h1>16.13. cdist-type__cdist(7)<a class="headerlink" href="#cdist-type-cdist-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.13. </span>cdist-type__cdist(7)<a class="headerlink" href="#cdist-type-cdist-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.13.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.13.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__cdist - Manage cdist installations</p>
</div>
<div class="section" id="description">
<h2>16.13.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.13.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>This cdist type allows you to easily setup cdist
on another box, to allow the other box to configure
systems.</p>
@ -383,25 +374,25 @@ other hosts.</p>
<p>This type will use git to clone</p>
</div>
<div class="section" id="required-parameters">
<h2>16.13.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.13.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="optional-parameters">
<h2>16.13.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>username</dt>
<dd>Select the user to create for the cdist installation.
Defaults to &quot;cdist&quot;.</dd>
<dt>source</dt>
<dd>Select the source from which to clone cdist from.
Defaults to &quot;<a class="reference external" href="mailto:git&#37;&#52;&#48;code&#46;ungleich&#46;ch">git<span>&#64;</span>code<span>&#46;</span>ungleich<span>&#46;</span>ch</a>:ungleich-public/cdist.git&quot;.</dd>
<dt>branch</dt>
<dd>Select the branch to checkout from.
Defaults to &quot;master&quot;.</dd>
<h2><span class="section-number">16.13.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>username</dt><dd><p>Select the user to create for the cdist installation.
Defaults to &quot;cdist&quot;.</p>
</dd>
<dt>source</dt><dd><p>Select the source from which to clone cdist from.
Defaults to &quot;<a class="reference external" href="mailto:git&#37;&#52;&#48;code&#46;ungleich&#46;ch">git<span>&#64;</span>code<span>&#46;</span>ungleich<span>&#46;</span>ch</a>:ungleich-public/cdist.git&quot;.</p>
</dd>
<dt>branch</dt><dd><p>Select the branch to checkout from.
Defaults to &quot;master&quot;.</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>16.13.5. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># Install cdist for user cdist in her home as subfolder cdist</span>
<h2><span class="section-number">16.13.5. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Install cdist for user cdist in her home as subfolder cdist</span>
__cdist /home/cdist/cdist
<span class="c1"># Use alternative source</span>
@ -410,11 +401,11 @@ __cdist --source <span class="s2">&quot;git@code.ungleich.ch:ungleich-public/cdi
</div>
</div>
<div class="section" id="authors">
<h2>16.13.6. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.13.6. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Nico Schottelius &lt;<a class="reference external" href="mailto:nico-cdist--&#37;&#52;&#48;--schottelius&#46;org">nico-cdist--<span>&#64;</span>--schottelius<span>&#46;</span>org</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.13.7. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.13.7. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2013 Nico Schottelius. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

51
src/extra/manual/beta/man7/cdist-type__cdist_preos_trigger.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.14. cdist-type__cdist_preos_trigger(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.14. cdist-type__cdist_preos_trigger(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -345,9 +336,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.14. cdist-type__cdist_preos_trigger(7)</li>
<li><span class="section-number">16.14. </span>cdist-type__cdist_preos_trigger(7)</li>
<li class="wy-breadcrumbs-aside">
@ -367,40 +358,40 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-cdist-preos-trigger-7">
<h1>16.14. cdist-type__cdist_preos_trigger(7)<a class="headerlink" href="#cdist-type-cdist-preos-trigger-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.14. </span>cdist-type__cdist_preos_trigger(7)<a class="headerlink" href="#cdist-type-cdist-preos-trigger-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.14.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.14.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__cdist_preos_trigger - configure cdist preos trigger</p>
</div>
<div class="section" id="description">
<h2>16.14.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.14.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Create cdist PreOS trigger by creating systemd unit file that will be started
at boot and will execute trigger command - connect to specified host and port.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.14.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>trigger-command</dt>
<dd>Command that will be executed as a PreOS cdist trigger.</dd>
<h2><span class="section-number">16.14.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>trigger-command</dt><dd><p>Command that will be executed as a PreOS cdist trigger.</p>
</dd>
</dl>
</div>
<div class="section" id="optional-parameters">
<h2>16.14.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.14.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<p>None</p>
</div>
<div class="section" id="examples">
<h2>16.14.5. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># Configure default curl trigger for host cdist.ungleich.ch at port 80.</span>
<h2><span class="section-number">16.14.5. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Configure default curl trigger for host cdist.ungleich.ch at port 80.</span>
__cdist_preos_trigger http --trigger-command <span class="s1">&#39;/usr/bin/curl cdist.ungleich.ch:80&#39;</span>
</pre></div>
</div>
</div>
<div class="section" id="authors">
<h2>16.14.6. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.14.6. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Darko Poljak &lt;<a class="reference external" href="mailto:darko&#46;poljak--&#37;&#52;&#48;--ungleich&#46;ch">darko<span>&#46;</span>poljak--<span>&#64;</span>--ungleich<span>&#46;</span>ch</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.14.7. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.14.7. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2016 Darko Poljak. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

59
src/extra/manual/beta/man7/cdist-type__cdistmarker.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.15. cdist-type__cdistmarker(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.15. cdist-type__cdistmarker(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -345,9 +336,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.15. cdist-type__cdistmarker(7)</li>
<li><span class="section-number">16.15. </span>cdist-type__cdistmarker(7)</li>
<li class="wy-breadcrumbs-aside">
@ -367,36 +358,36 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-cdistmarker-7">
<h1>16.15. cdist-type__cdistmarker(7)<a class="headerlink" href="#cdist-type-cdistmarker-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.15. </span>cdist-type__cdistmarker(7)<a class="headerlink" href="#cdist-type-cdistmarker-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.15.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.15.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__cdistmarker - Add a timestamped cdist marker.</p>
</div>
<div class="section" id="description">
<h2>16.15.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.15.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>This type is used to add a common marker file which indicates that a given
machine is being managed by cdist. The contents of this file consist of a
timestamp, which can be used to determine the most recent time at which cdist
was run against the machine in question.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.15.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.15.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<p>None.</p>
</div>
<div class="section" id="optional-parameters">
<h2>16.15.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>destination</dt>
<dd>The path and filename of the marker.
Default: /etc/cdist-configured</dd>
<dt>format</dt>
<dd>The format of the timestamp. This is passed directly to system 'date'.
Default: -u</dd>
<h2><span class="section-number">16.15.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>destination</dt><dd><p>The path and filename of the marker.
Default: /etc/cdist-configured</p>
</dd>
<dt>format</dt><dd><p>The format of the timestamp. This is passed directly to system 'date'.
Default: -u</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>16.15.5. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># Creates the marker as normal.</span>
<h2><span class="section-number">16.15.5. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Creates the marker as normal.</span>
__cdistmarker
<span class="c1"># Creates the marker differently.</span>
@ -405,11 +396,11 @@ __cdistmarker --destination /tmp/cdist_marker --format <span class="s1">&#39;+%s
</div>
</div>
<div class="section" id="authors">
<h2>16.15.6. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.15.6. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Daniel Maher &lt;<a class="reference external" href="mailto:phrawzty+cdist--&#37;&#52;&#48;--gmail&#46;com">phrawzty+cdist--<span>&#64;</span>--gmail<span>&#46;</span>com</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.15.7. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.15.7. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2011 Daniel Maher. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

53
src/extra/manual/beta/man7/cdist-type__check_messages.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.16. cdist-type__check_messages(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.16. cdist-type__check_messages(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -344,9 +335,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.16. cdist-type__check_messages(7)</li>
<li><span class="section-number">16.16. </span>cdist-type__check_messages(7)</li>
<li class="wy-breadcrumbs-aside">
@ -366,13 +357,13 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-check-messages-7">
<h1>16.16. cdist-type__check_messages(7)<a class="headerlink" href="#cdist-type-check-messages-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.16. </span>cdist-type__check_messages(7)<a class="headerlink" href="#cdist-type-check-messages-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.16.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.16.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__check_messages - Check messages for pattern and execute command on match.</p>
</div>
<div class="section" id="description">
<h2>16.16.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.16.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Check messages for pattern and execute command on match.</p>
<p>This type is useful if you chain together multiple related types using
dependencies and want to restart service if at least one type changes
@ -382,28 +373,28 @@ something.</p>
<a class="reference external" href="cdist-manifest.html#dependencies">cdist manifest</a> documentation.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.16.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>pattern</dt>
<dd>Extended regular expression pattern for search (passed to <code class="docutils literal"><span class="pre">grep</span> <span class="pre">-E</span></code>).</dd>
<dt>execute</dt>
<dd>Command to execute on pattern match.</dd>
<h2><span class="section-number">16.16.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>pattern</dt><dd><p>Extended regular expression pattern for search (passed to <code class="docutils literal notranslate"><span class="pre">grep</span> <span class="pre">-E</span></code>).</p>
</dd>
<dt>execute</dt><dd><p>Command to execute on pattern match.</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>16.16.4. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__check_messages munin <span class="se">\</span>
<h2><span class="section-number">16.16.4. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>__check_messages munin <span class="se">\</span>
--pattern <span class="s1">&#39;^__(file|link|line)/etc/munin/&#39;</span> <span class="se">\</span>
--execute <span class="s1">&#39;service munin-node restart&#39;</span>
</pre></div>
</div>
</div>
<div class="section" id="authors">
<h2>16.16.5. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.16.5. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Ander Punnar &lt;ander-at-kvlt-dot-ee&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.16.6. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.16.6. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2019 Ander Punnar. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

55
src/extra/manual/beta/man7/cdist-type__chroot_mount.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.17. cdist-type__chroot_mount(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.17. cdist-type__chroot_mount(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -346,9 +337,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.17. cdist-type__chroot_mount(7)</li>
<li><span class="section-number">16.17. </span>cdist-type__chroot_mount(7)</li>
<li class="wy-breadcrumbs-aside">
@ -368,37 +359,37 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-chroot-mount-7">
<h1>16.17. cdist-type__chroot_mount(7)<a class="headerlink" href="#cdist-type-chroot-mount-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.17. </span>cdist-type__chroot_mount(7)<a class="headerlink" href="#cdist-type-chroot-mount-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.17.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.17.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__chroot_mount - mount a chroot</p>
</div>
<div class="section" id="description">
<h2>16.17.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.17.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Mount and prepare a chroot for running commands within it.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.17.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.17.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<p>None</p>
</div>
<div class="section" id="optional-parameters">
<h2>16.17.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>manage-resolv-conf</dt>
<dd>manage /etc/resolv.conf inside the chroot.
<h2><span class="section-number">16.17.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>manage-resolv-conf</dt><dd><p>manage /etc/resolv.conf inside the chroot.
Use the value of this parameter as the suffix to save a copy
of the current /etc/resolv.conf to /etc/resolv.conf.$suffix.
This is used by the __chroot_umount type to restore the initial
file content when unmounting the chroot.</dd>
file content when unmounting the chroot.</p>
</dd>
</dl>
</div>
<div class="section" id="boolean-parameters">
<h2>16.17.5. BOOLEAN PARAMETERS<a class="headerlink" href="#boolean-parameters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.17.5. </span>BOOLEAN PARAMETERS<a class="headerlink" href="#boolean-parameters" title="Permalink to this headline"></a></h2>
<p>None.</p>
</div>
<div class="section" id="examples">
<h2>16.17.6. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__chroot_mount /path/to/chroot
<h2><span class="section-number">16.17.6. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>__chroot_mount /path/to/chroot
__chroot_mount /path/to/chroot <span class="se">\</span>
--manage-resolv-conf <span class="s2">&quot;some-known-string&quot;</span>
@ -406,11 +397,11 @@ __chroot_mount /path/to/chroot <span class="se">\</span>
</div>
</div>
<div class="section" id="authors">
<h2>16.17.7. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.17.7. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Steven Armstrong &lt;<a class="reference external" href="mailto:steven-cdist--&#37;&#52;&#48;--armstrong&#46;cc">steven-cdist--<span>&#64;</span>--armstrong<span>&#46;</span>cc</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.17.8. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.17.8. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2012-2017 Steven Armstrong. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

57
src/extra/manual/beta/man7/cdist-type__chroot_umount.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.18. cdist-type__chroot_umount(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.18. cdist-type__chroot_umount(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -347,9 +338,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.18. cdist-type__chroot_umount(7)</li>
<li><span class="section-number">16.18. </span>cdist-type__chroot_umount(7)</li>
<li class="wy-breadcrumbs-aside">
@ -369,37 +360,37 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-chroot-umount-7">
<h1>16.18. cdist-type__chroot_umount(7)<a class="headerlink" href="#cdist-type-chroot-umount-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.18. </span>cdist-type__chroot_umount(7)<a class="headerlink" href="#cdist-type-chroot-umount-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.18.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.18.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__chroot_umount - unmount a chroot mounted by __chroot_mount</p>
</div>
<div class="section" id="description">
<h2>16.18.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.18.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Undo what __chroot_mount did.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.18.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.18.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<p>None</p>
</div>
<div class="section" id="optional-parameters">
<h2>16.18.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>manage-resolv-conf</dt>
<dd>manage /etc/resolv.conf inside the chroot.
<h2><span class="section-number">16.18.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>manage-resolv-conf</dt><dd><p>manage /etc/resolv.conf inside the chroot.
Use the value of this parameter as the suffix to find the backup file
that was saved by the __chroot_mount.
This is used by the to restore the initial file content when unmounting
the chroot.</dd>
the chroot.</p>
</dd>
</dl>
</div>
<div class="section" id="boolean-parameters">
<h2>16.18.5. BOOLEAN PARAMETERS<a class="headerlink" href="#boolean-parameters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.18.5. </span>BOOLEAN PARAMETERS<a class="headerlink" href="#boolean-parameters" title="Permalink to this headline"></a></h2>
<p>None.</p>
</div>
<div class="section" id="examples">
<h2>16.18.6. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__chroot_umount /path/to/chroot
<h2><span class="section-number">16.18.6. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>__chroot_umount /path/to/chroot
__chroot_umount /path/to/chroot <span class="se">\</span>
--manage-resolv-conf <span class="s2">&quot;some-known-string&quot;</span>
@ -407,15 +398,15 @@ __chroot_umount /path/to/chroot <span class="se">\</span>
</div>
</div>
<div class="section" id="see-also">
<h2>16.18.7. SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.18.7. </span>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<p><strong>cdist-type__chroot_mount</strong>(7)</p>
</div>
<div class="section" id="authors">
<h2>16.18.8. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.18.8. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Steven Armstrong &lt;<a class="reference external" href="mailto:steven-cdist--&#37;&#52;&#48;--armstrong&#46;cc">steven-cdist--<span>&#64;</span>--armstrong<span>&#46;</span>cc</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.18.9. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.18.9. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2012-2017 Steven Armstrong. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

77
src/extra/manual/beta/man7/cdist-type__clean_path.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.19. cdist-type__clean_path(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.19. cdist-type__clean_path(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -345,9 +336,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.19. cdist-type__clean_path(7)</li>
<li><span class="section-number">16.19. </span>cdist-type__clean_path(7)</li>
<li class="wy-breadcrumbs-aside">
@ -367,39 +358,47 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-clean-path-7">
<h1>16.19. cdist-type__clean_path(7)<a class="headerlink" href="#cdist-type-clean-path-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.19. </span>cdist-type__clean_path(7)<a class="headerlink" href="#cdist-type-clean-path-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.19.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.19.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__clean_path - Remove files and directories which match the pattern.</p>
</div>
<div class="section" id="description">
<h2>16.19.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.19.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Remove files and directories which match the pattern.</p>
<p>Provided path (as __object_id) must be a directory.</p>
<p>Patterns are passed to <code class="docutils literal"><span class="pre">find</span></code>'s <code class="docutils literal"><span class="pre">-regex</span></code> - see <code class="docutils literal"><span class="pre">find(1)</span></code> for more details.</p>
<p>Look up of files and directories is non-recursive (<code class="docutils literal"><span class="pre">-maxdepth</span> <span class="pre">1</span></code>).</p>
<p>Parent directory is excluded (<code class="docutils literal"><span class="pre">-mindepth</span> <span class="pre">1</span></code>).</p>
<p>Provided path must be a directory.</p>
<p>Patterns are passed to <code class="docutils literal notranslate"><span class="pre">find</span></code>'s <code class="docutils literal notranslate"><span class="pre">-regex</span></code> - see <code class="docutils literal notranslate"><span class="pre">find(1)</span></code> for more details.</p>
<p>Look up of files and directories is non-recursive (<code class="docutils literal notranslate"><span class="pre">-maxdepth</span> <span class="pre">1</span></code>).</p>
<p>Parent directory is excluded (<code class="docutils literal notranslate"><span class="pre">-mindepth</span> <span class="pre">1</span></code>).</p>
<p>This type is not POSIX compatible (sorry, Solaris users).</p>
</div>
<div class="section" id="required-parameters">
<h2>16.19.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>pattern</dt>
<dd>Pattern of files which are removed from path.</dd>
<h2><span class="section-number">16.19.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>pattern</dt><dd><p>Pattern of files which are removed from path.</p>
</dd>
</dl>
</div>
<div class="section" id="optional-parameters">
<h2>16.19.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>exclude</dt>
<dd>Pattern of files which are excluded from removal.</dd>
<dt>onchange</dt>
<dd>The code to run if files or directories were removed.</dd>
<h2><span class="section-number">16.19.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>path</dt><dd><p>Path which will be cleaned. Defaults to <code class="docutils literal notranslate"><span class="pre">$__object_id</span></code>.</p>
</dd>
<dt>exclude</dt><dd><p>Pattern of files which are excluded from removal.</p>
</dd>
<dt>onchange</dt><dd><p>The code to run if files or directories were removed.</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>16.19.5. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__clean_path /etc/apache2/conf-enabled <span class="se">\</span>
<h2><span class="section-number">16.19.5. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>__clean_path /etc/apache2/conf-enabled <span class="se">\</span>
--pattern <span class="s1">&#39;.+&#39;</span> <span class="se">\</span>
--exclude <span class="s1">&#39;.+\(charset\.conf\|security\.conf\)&#39;</span> <span class="se">\</span>
--onchange <span class="s1">&#39;service apache2 restart&#39;</span>
__clean_path apache2-conf-enabled <span class="se">\</span>
--path /etc/apache2/conf-enabled <span class="se">\</span>
--pattern <span class="s1">&#39;.+&#39;</span> <span class="se">\</span>
--exclude <span class="s1">&#39;.+\(charset\.conf\|security\.conf\)&#39;</span> <span class="se">\</span>
--onchange <span class="s1">&#39;service apache2 restart&#39;</span>
@ -407,11 +406,11 @@
</div>
</div>
<div class="section" id="authors">
<h2>16.19.6. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.19.6. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Ander Punnar &lt;ander-at-kvlt-dot-ee&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.19.7. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.19.7. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2019 Ander Punnar. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

75
src/extra/manual/beta/man7/cdist-type__config_file.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.20. cdist-type__config_file(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.20. cdist-type__config_file(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -346,9 +337,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.20. cdist-type__config_file(7)</li>
<li><span class="section-number">16.20. </span>cdist-type__config_file(7)</li>
<li class="wy-breadcrumbs-aside">
@ -368,41 +359,41 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-config-file-7">
<h1>16.20. cdist-type__config_file(7)<a class="headerlink" href="#cdist-type-config-file-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.20. </span>cdist-type__config_file(7)<a class="headerlink" href="#cdist-type-config-file-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.20.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.20.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__config_file - _Manages config files</p>
</div>
<div class="section" id="description">
<h2>16.20.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.20.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Deploy config files using the file type.
Run the given code if the files changes.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.20.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.20.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<p>None.</p>
</div>
<div class="section" id="optional-parameters">
<h2>16.20.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>group</dt>
<dd>see cdist-type__file</dd>
<dt>mode</dt>
<dd>see cdist-type__file</dd>
<dt>onchange</dt>
<dd>the code to run if the file changes</dd>
<dt>owner</dt>
<dd>see cdist-type__file</dd>
<dt>source</dt>
<dd>Path to the config file.
If source is '-' (dash), take what was written to stdin as the config file content.</dd>
<dt>state</dt>
<dd>see cdist-type__file</dd>
<h2><span class="section-number">16.20.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>group</dt><dd><p>see cdist-type__file</p>
</dd>
<dt>mode</dt><dd><p>see cdist-type__file</p>
</dd>
<dt>onchange</dt><dd><p>the code to run if the file changes</p>
</dd>
<dt>owner</dt><dd><p>see cdist-type__file</p>
</dd>
<dt>source</dt><dd><p>Path to the config file.
If source is '-' (dash), take what was written to stdin as the config file content.</p>
</dd>
<dt>state</dt><dd><p>see cdist-type__file</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>16.20.5. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__config_file /etc/consul/conf.d/watch_foo.json <span class="se">\</span>
<h2><span class="section-number">16.20.5. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>__config_file /etc/consul/conf.d/watch_foo.json <span class="se">\</span>
--owner root --group consul --mode <span class="m">640</span> <span class="se">\</span>
--source <span class="s2">&quot;</span><span class="nv">$__type</span><span class="s2">/files/watch_foo.json&quot;</span> <span class="se">\</span>
--state present <span class="se">\</span>
@ -411,15 +402,15 @@ If source is '-' (dash), take what was written to stdin as the config file conte
</div>
</div>
<div class="section" id="see-also">
<h2>16.20.6. SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.20.6. </span>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<p><strong>cdist-type__file</strong>(7)</p>
</div>
<div class="section" id="authors">
<h2>16.20.7. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.20.7. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Steven Armstrong &lt;<a class="reference external" href="mailto:steven-cdist--&#37;&#52;&#48;--armstrong&#46;cc">steven-cdist--<span>&#64;</span>--armstrong<span>&#46;</span>cc</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.20.8. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.20.8. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2015 Steven Armstrong. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

73
src/extra/manual/beta/man7/cdist-type__consul.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.21. cdist-type__consul(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.21. cdist-type__consul(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -347,9 +338,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.21. cdist-type__consul(7)</li>
<li><span class="section-number">16.21. </span>cdist-type__consul(7)</li>
<li class="wy-breadcrumbs-aside">
@ -369,51 +360,51 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-consul-7">
<h1>16.21. cdist-type__consul(7)<a class="headerlink" href="#cdist-type-consul-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.21. </span>cdist-type__consul(7)<a class="headerlink" href="#cdist-type-consul-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.21.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.21.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__consul - Install consul</p>
</div>
<div class="section" id="description">
<h2>16.21.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.21.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Downloads and installs the consul binary from <a class="reference external" href="https://dl.bintray.com/mitchellh/consul">https://dl.bintray.com/mitchellh/consul</a>.
Note that the consul binary is downloaded on the server (the machine running
cdist) and then deployed to the target host using the __file type unless --direct
parameter is used.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.21.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.21.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<p>None.</p>
</div>
<div class="section" id="optional-parameters">
<h2>16.21.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>state</dt>
<dd>either 'present' or 'absent'. Defaults to 'present'</dd>
<dt>version</dt>
<dd>which version of consul to install. See ./files/versions for a list of
supported versions. Defaults to the latest known version.</dd>
<h2><span class="section-number">16.21.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>state</dt><dd><p>either 'present' or 'absent'. Defaults to 'present'</p>
</dd>
<dt>version</dt><dd><p>which version of consul to install. See ./files/versions for a list of
supported versions. Defaults to the latest known version.</p>
</dd>
</dl>
</div>
<div class="section" id="boolean-parameters">
<h2>16.21.5. BOOLEAN PARAMETERS<a class="headerlink" href="#boolean-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>direct</dt>
<dd>Download and deploy consul binary directly on the target machine.</dd>
<h2><span class="section-number">16.21.5. </span>BOOLEAN PARAMETERS<a class="headerlink" href="#boolean-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>direct</dt><dd><p>Download and deploy consul binary directly on the target machine.</p>
</dd>
</dl>
</div>
<div class="section" id="messages">
<h2>16.21.6. MESSAGES<a class="headerlink" href="#messages" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.21.6. </span>MESSAGES<a class="headerlink" href="#messages" title="Permalink to this headline"></a></h2>
<p>If consul binary is created using __staged_file then underlaying __file type messages are emitted.</p>
<p>If consul binary is created by direct method then the following messages are emitted:</p>
<dl class="docutils">
<dt>/usr/local/bin/consul created</dt>
<dd>consul binary was created</dd>
<dl class="simple">
<dt>/usr/local/bin/consul created</dt><dd><p>consul binary was created</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>16.21.7. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># just install using defaults</span>
<h2><span class="section-number">16.21.7. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># just install using defaults</span>
__consul
<span class="c1"># install by downloading consul binary directly on the target machine</span>
@ -426,14 +417,14 @@ __consul <span class="se">\</span>
</div>
</div>
<div class="section" id="authors">
<h2>16.21.8. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.21.8. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">Steven Armstrong &lt;<a class="reference external" href="mailto:steven-cdist--&#37;&#52;&#48;--armstrong&#46;cc">steven-cdist--<span>&#64;</span>--armstrong<span>&#46;</span>cc</a>&gt;</div>
<div class="line">Darko Poljak &lt;<a class="reference external" href="mailto:darko&#46;poljak--&#37;&#52;&#48;--gmail&#46;com">darko<span>&#46;</span>poljak--<span>&#64;</span>--gmail<span>&#46;</span>com</a>&gt;</div>
</div>
</div>
<div class="section" id="copying">
<h2>16.21.9. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.21.9. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2015 Steven Armstrong. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

189
src/extra/manual/beta/man7/cdist-type__consul_agent.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.22. cdist-type__consul_agent(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.22. cdist-type__consul_agent(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -347,9 +338,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.22. cdist-type__consul_agent(7)</li>
<li><span class="section-number">16.22. </span>cdist-type__consul_agent(7)</li>
<li class="wy-breadcrumbs-aside">
@ -369,101 +360,101 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-consul-agent-7">
<h1>16.22. cdist-type__consul_agent(7)<a class="headerlink" href="#cdist-type-consul-agent-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.22. </span>cdist-type__consul_agent(7)<a class="headerlink" href="#cdist-type-consul-agent-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.22.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.22.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__consul_agent - Manage the consul agent</p>
</div>
<div class="section" id="description">
<h2>16.22.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.22.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Configure and manage the consul agent.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.22.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.22.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<p>None.</p>
</div>
<div class="section" id="optional-parameters">
<h2>16.22.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>acl-datacenter</dt>
<dd>only used by servers. This designates the datacenter which is authoritative
for ACL information.</dd>
<dt>acl-default-policy</dt>
<dd>either &quot;allow&quot; or &quot;deny&quot;; defaults to &quot;allow&quot;. The default policy controls the
behavior of a token when there is no matching rule.</dd>
<dt>acl-down-policy</dt>
<dd>either &quot;allow&quot;, &quot;deny&quot; or &quot;extend-cache&quot;; &quot;extend-cache&quot; is the default.</dd>
<dt>acl-master-token</dt>
<dd>only used for servers in the acl_datacenter. This token will be created with
<h2><span class="section-number">16.22.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>acl-datacenter</dt><dd><p>only used by servers. This designates the datacenter which is authoritative
for ACL information.</p>
</dd>
<dt>acl-default-policy</dt><dd><p>either &quot;allow&quot; or &quot;deny&quot;; defaults to &quot;allow&quot;. The default policy controls the
behavior of a token when there is no matching rule.</p>
</dd>
<dt>acl-down-policy</dt><dd><p>either &quot;allow&quot;, &quot;deny&quot; or &quot;extend-cache&quot;; &quot;extend-cache&quot; is the default.</p>
</dd>
<dt>acl-master-token</dt><dd><p>only used for servers in the acl_datacenter. This token will be created with
management-level permissions if it does not exist. It allows operators to
bootstrap the ACL system with a token ID that is well-known.</dd>
<dt>acl-token</dt>
<dd>when provided, the agent will use this token when making requests to the
Consul servers.</dd>
<dt>acl-ttl</dt>
<dd>used to control Time-To-Live caching of ACLs.</dd>
<dt>bind-addr</dt>
<dd>sets the bind address for cluster communication</dd>
<dt>bootstrap-expect</dt>
<dd>sets server to expect bootstrap mode</dd>
<dt>ca-file-source</dt>
<dd>path to a PEM encoded certificate authority file which will be uploaded and
configure using the ca_file config option.</dd>
<dt>cert-file-source</dt>
<dd>path to a PEM encoded certificate file which will be uploaded and
configure using the cert_file config option.</dd>
<dt>client-addr</dt>
<dd>sets the address to bind for client access</dd>
<dt>datacenter</dt>
<dd>datacenter of the agent</dd>
<dt>encrypt</dt>
<dd>provides the gossip encryption key</dd>
<dt>group</dt>
<dd>the primary group for the agent</dd>
<dt>json-config</dt>
<dd>path to a partial json config file without leading { and trailing }.
If json-config is '-' (dash), take what was written to stdin as the file content.</dd>
<dt>key-file-source</dt>
<dd>path to a PEM encoded private key file which will be uploaded and
configure using the key_file config option.</dd>
<dt>node-name</dt>
<dd>name of this node. Must be unique in the cluster</dd>
<dt>retry-join</dt>
<dd>address to attempt joining every retry_interval until at least one join works.
Can be specified multiple times.</dd>
<dt>user</dt>
<dd>the user to run the agent as</dd>
<dt>state</dt>
<dd>if the agent is 'present' or 'absent'. Defaults to 'present'.
Currently state=absent is not working due to some dependency issues.</dd>
bootstrap the ACL system with a token ID that is well-known.</p>
</dd>
<dt>acl-token</dt><dd><p>when provided, the agent will use this token when making requests to the
Consul servers.</p>
</dd>
<dt>acl-ttl</dt><dd><p>used to control Time-To-Live caching of ACLs.</p>
</dd>
<dt>bind-addr</dt><dd><p>sets the bind address for cluster communication</p>
</dd>
<dt>bootstrap-expect</dt><dd><p>sets server to expect bootstrap mode</p>
</dd>
<dt>ca-file-source</dt><dd><p>path to a PEM encoded certificate authority file which will be uploaded and
configure using the ca_file config option.</p>
</dd>
<dt>cert-file-source</dt><dd><p>path to a PEM encoded certificate file which will be uploaded and
configure using the cert_file config option.</p>
</dd>
<dt>client-addr</dt><dd><p>sets the address to bind for client access</p>
</dd>
<dt>datacenter</dt><dd><p>datacenter of the agent</p>
</dd>
<dt>encrypt</dt><dd><p>provides the gossip encryption key</p>
</dd>
<dt>group</dt><dd><p>the primary group for the agent</p>
</dd>
<dt>json-config</dt><dd><p>path to a partial json config file without leading { and trailing }.
If json-config is '-' (dash), take what was written to stdin as the file content.</p>
</dd>
<dt>key-file-source</dt><dd><p>path to a PEM encoded private key file which will be uploaded and
configure using the key_file config option.</p>
</dd>
<dt>node-name</dt><dd><p>name of this node. Must be unique in the cluster</p>
</dd>
<dt>retry-join</dt><dd><p>address to attempt joining every retry_interval until at least one join works.
Can be specified multiple times.</p>
</dd>
<dt>user</dt><dd><p>the user to run the agent as</p>
</dd>
<dt>state</dt><dd><p>if the agent is 'present' or 'absent'. Defaults to 'present'.
Currently state=absent is not working due to some dependency issues.</p>
</dd>
</dl>
</div>
<div class="section" id="boolean-parameters">
<h2>16.22.5. BOOLEAN PARAMETERS<a class="headerlink" href="#boolean-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>disable-remote-exec</dt>
<dd>disables support for remote execution. When set to true, the agent will ignore any incoming remote exec requests.</dd>
<dt>disable-update-check</dt>
<dd>disables automatic checking for security bulletins and new version releases</dd>
<dt>leave-on-terminate</dt>
<dd>gracefully leave cluster on SIGTERM</dd>
<dt>rejoin-after-leave</dt>
<dd>rejoin the cluster using the previous state after leaving</dd>
<dt>server</dt>
<dd>used to control if an agent is in server or client mode</dd>
<dt>enable-syslog</dt>
<dd>enables logging to syslog</dd>
<dt>verify-incoming</dt>
<dd>enforce the use of TLS and verify a client's authenticity on incoming connections</dd>
<dt>verify-outgoing</dt>
<dd>enforce the use of TLS and verify the peers authenticity on outgoing connections</dd>
<dt>use-distribution-package</dt>
<dd>uses distribution package instead of upstream binary</dd>
<h2><span class="section-number">16.22.5. </span>BOOLEAN PARAMETERS<a class="headerlink" href="#boolean-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>disable-remote-exec</dt><dd><p>disables support for remote execution. When set to true, the agent will ignore any incoming remote exec requests.</p>
</dd>
<dt>disable-update-check</dt><dd><p>disables automatic checking for security bulletins and new version releases</p>
</dd>
<dt>leave-on-terminate</dt><dd><p>gracefully leave cluster on SIGTERM</p>
</dd>
<dt>rejoin-after-leave</dt><dd><p>rejoin the cluster using the previous state after leaving</p>
</dd>
<dt>server</dt><dd><p>used to control if an agent is in server or client mode</p>
</dd>
<dt>enable-syslog</dt><dd><p>enables logging to syslog</p>
</dd>
<dt>verify-incoming</dt><dd><p>enforce the use of TLS and verify a client's authenticity on incoming connections</p>
</dd>
<dt>verify-outgoing</dt><dd><p>enforce the use of TLS and verify the peers authenticity on outgoing connections</p>
</dd>
<dt>use-distribution-package</dt><dd><p>uses distribution package instead of upstream binary</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>16.22.6. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># configure as server, bootstrap and rejoin</span>
<h2><span class="section-number">16.22.6. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># configure as server, bootstrap and rejoin</span>
<span class="nv">hostname</span><span class="o">=</span><span class="s2">&quot;</span><span class="k">$(</span>cat <span class="s2">&quot;</span><span class="nv">$__global</span><span class="s2">/explorer/hostname&quot;</span><span class="k">)</span><span class="s2">&quot;</span>
__consul_agent <span class="se">\</span>
--datacenter dc1 <span class="se">\</span>
@ -506,15 +497,15 @@ __consul_agent <span class="se">\</span>
</div>
</div>
<div class="section" id="see-also">
<h2>16.22.7. SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.22.7. </span>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<p>consul documentation at: &lt;<a class="reference external" href="http://www.consul.io/docs/agent/options.html">http://www.consul.io/docs/agent/options.html</a>&gt;.</p>
</div>
<div class="section" id="authors">
<h2>16.22.8. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.22.8. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Steven Armstrong &lt;<a class="reference external" href="mailto:steven-cdist--&#37;&#52;&#48;--armstrong&#46;cc">steven-cdist--<span>&#64;</span>--armstrong<span>&#46;</span>cc</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.22.9. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.22.9. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2015 Steven Armstrong. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

111
src/extra/manual/beta/man7/cdist-type__consul_check.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.23. cdist-type__consul_check(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.23. cdist-type__consul_check(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -346,9 +337,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.23. cdist-type__consul_check(7)</li>
<li><span class="section-number">16.23. </span>cdist-type__consul_check(7)</li>
<li class="wy-breadcrumbs-aside">
@ -368,60 +359,60 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-consul-check-7">
<h1>16.23. cdist-type__consul_check(7)<a class="headerlink" href="#cdist-type-consul-check-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.23. </span>cdist-type__consul_check(7)<a class="headerlink" href="#cdist-type-consul-check-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.23.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.23.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__consul_check - Manages consul checks</p>
</div>
<div class="section" id="description">
<h2>16.23.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.23.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Generate and deploy check definitions for a consul agent.
See <a class="reference external" href="http://www.consul.io/docs/agent/checks.html">http://www.consul.io/docs/agent/checks.html</a> for parameter documentation.</p>
<p>Use either script together with interval, or use ttl.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.23.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.23.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<p>None.</p>
</div>
<div class="section" id="optional-parameters">
<h2>16.23.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>docker-container-id</dt>
<dd>the id of the docker container to run</dd>
<dt>http</dt>
<dd>the url to check</dd>
<dt>id</dt>
<dd>The id of this check.</dd>
<dt>interval</dt>
<dd>the interval in which the check should run</dd>
<dt>name</dt>
<dd>The name of this check. Defaults to __object_id</dd>
<dt>notes</dt>
<dd>human readable description</dd>
<dt>script</dt>
<dd>the shell command to run</dd>
<dt>service-id</dt>
<dd>the id of the service this check is bound to</dd>
<dt>shell</dt>
<dd>the shell to run inside the docker container</dd>
<dt>state</dt>
<dd>if this check is 'present' or 'absent'. Defaults to 'present'.</dd>
<dt>status</dt>
<dd>specify the initial state of this health check</dd>
<dt>tcp</dt>
<dd>the host and port to check</dd>
<dt>timeout</dt>
<dd>after how long to timeout checks which take to long</dd>
<dt>token</dt>
<dd>ACL token to use for interacting with the catalog</dd>
<dt>ttl</dt>
<dd>how long a TTL check is considered healthy without being updated through the
HTTP interface</dd>
<h2><span class="section-number">16.23.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>docker-container-id</dt><dd><p>the id of the docker container to run</p>
</dd>
<dt>http</dt><dd><p>the url to check</p>
</dd>
<dt>id</dt><dd><p>The id of this check.</p>
</dd>
<dt>interval</dt><dd><p>the interval in which the check should run</p>
</dd>
<dt>name</dt><dd><p>The name of this check. Defaults to __object_id</p>
</dd>
<dt>notes</dt><dd><p>human readable description</p>
</dd>
<dt>script</dt><dd><p>the shell command to run</p>
</dd>
<dt>service-id</dt><dd><p>the id of the service this check is bound to</p>
</dd>
<dt>shell</dt><dd><p>the shell to run inside the docker container</p>
</dd>
<dt>state</dt><dd><p>if this check is 'present' or 'absent'. Defaults to 'present'.</p>
</dd>
<dt>status</dt><dd><p>specify the initial state of this health check</p>
</dd>
<dt>tcp</dt><dd><p>the host and port to check</p>
</dd>
<dt>timeout</dt><dd><p>after how long to timeout checks which take to long</p>
</dd>
<dt>token</dt><dd><p>ACL token to use for interacting with the catalog</p>
</dd>
<dt>ttl</dt><dd><p>how long a TTL check is considered healthy without being updated through the
HTTP interface</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>16.23.5. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__consul_check redis <span class="se">\</span>
<h2><span class="section-number">16.23.5. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>__consul_check redis <span class="se">\</span>
--script /usr/local/bin/check_redis.py <span class="se">\</span>
--interval 10s
@ -434,15 +425,15 @@ __consul_check some-object-id <span class="se">\</span>
</div>
</div>
<div class="section" id="see-also">
<h2>16.23.6. SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.23.6. </span>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<p><strong>cdist-type__consul_agent</strong>(7)</p>
</div>
<div class="section" id="authors">
<h2>16.23.7. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.23.7. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Steven Armstrong &lt;<a class="reference external" href="mailto:steven-cdist--&#37;&#52;&#48;--armstrong&#46;cc">steven-cdist--<span>&#64;</span>--armstrong<span>&#46;</span>cc</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.23.8. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.23.8. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2015-2016 Steven Armstrong. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

45
src/extra/manual/beta/man7/cdist-type__consul_reload.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.24. cdist-type__consul_reload(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.24. cdist-type__consul_reload(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -345,9 +336,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.24. cdist-type__consul_reload(7)</li>
<li><span class="section-number">16.24. </span>cdist-type__consul_reload(7)</li>
<li class="wy-breadcrumbs-aside">
@ -367,35 +358,35 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-consul-reload-7">
<h1>16.24. cdist-type__consul_reload(7)<a class="headerlink" href="#cdist-type-consul-reload-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.24. </span>cdist-type__consul_reload(7)<a class="headerlink" href="#cdist-type-consul-reload-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.24.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.24.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__consul_reload - Reload consul</p>
</div>
<div class="section" id="description">
<h2>16.24.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.24.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Reload consul after configuration changes.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.24.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.24.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<p>None.</p>
</div>
<div class="section" id="optional-parameters">
<h2>16.24.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.24.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<p>None.</p>
</div>
<div class="section" id="examples">
<h2>16.24.5. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__consul_reload
<h2><span class="section-number">16.24.5. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>__consul_reload
</pre></div>
</div>
</div>
<div class="section" id="authors">
<h2>16.24.6. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.24.6. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Steven Armstrong &lt;<a class="reference external" href="mailto:steven-cdist--&#37;&#52;&#48;--armstrong&#46;cc">steven-cdist--<span>&#64;</span>--armstrong<span>&#46;</span>cc</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.24.7. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.24.7. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2015 Steven Armstrong. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

87
src/extra/manual/beta/man7/cdist-type__consul_service.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.25. cdist-type__consul_service(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.25. cdist-type__consul_service(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -346,9 +337,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.25. cdist-type__consul_service(7)</li>
<li><span class="section-number">16.25. </span>cdist-type__consul_service(7)</li>
<li class="wy-breadcrumbs-aside">
@ -368,48 +359,48 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-consul-service-7">
<h1>16.25. cdist-type__consul_service(7)<a class="headerlink" href="#cdist-type-consul-service-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.25. </span>cdist-type__consul_service(7)<a class="headerlink" href="#cdist-type-consul-service-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.25.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.25.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__consul_service - Manages consul services</p>
</div>
<div class="section" id="description">
<h2>16.25.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.25.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Generate and deploy service definitions for a consul agent.
See <a class="reference external" href="http://www.consul.io/docs/agent/services.html">http://www.consul.io/docs/agent/services.html</a> for parameter documentation.</p>
<p>Use either script together with interval, or use ttl.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.25.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.25.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<p>None.</p>
</div>
<div class="section" id="optional-parameters">
<h2>16.25.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>check-interval</dt>
<dd>the interval in which the script given with --check-script should be run</dd>
<dt>check-http</dt>
<dd>the URL to check for HTTP 200-ish status every --check-interval</dd>
<dt>check-script</dt>
<dd>the shell command to run every --check-interval</dd>
<dt>check-ttl</dt>
<dd>how long a service is considered healthy without being updated through the
HTTP interfave</dd>
<dt>id</dt>
<dd>Defaults to --name</dd>
<dt>name</dt>
<dd>The name of this service. Defaults to __object_id</dd>
<dt>port</dt>
<dd>the port at which this service can be reached</dd>
<dt>state</dt>
<dd>if this service is 'present' or 'absent'. Defaults to 'present'.</dd>
<dt>tag</dt>
<dd>a tag to add to this service. Can be specified multiple times.</dd>
<h2><span class="section-number">16.25.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>check-interval</dt><dd><p>the interval in which the script given with --check-script should be run</p>
</dd>
<dt>check-http</dt><dd><p>the URL to check for HTTP 200-ish status every --check-interval</p>
</dd>
<dt>check-script</dt><dd><p>the shell command to run every --check-interval</p>
</dd>
<dt>check-ttl</dt><dd><p>how long a service is considered healthy without being updated through the
HTTP interfave</p>
</dd>
<dt>id</dt><dd><p>Defaults to --name</p>
</dd>
<dt>name</dt><dd><p>The name of this service. Defaults to __object_id</p>
</dd>
<dt>port</dt><dd><p>the port at which this service can be reached</p>
</dd>
<dt>state</dt><dd><p>if this service is 'present' or 'absent'. Defaults to 'present'.</p>
</dd>
<dt>tag</dt><dd><p>a tag to add to this service. Can be specified multiple times.</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>16.25.5. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__consul_service redis <span class="se">\</span>
<h2><span class="section-number">16.25.5. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>__consul_service redis <span class="se">\</span>
--tag master <span class="se">\</span>
--tag production <span class="se">\</span>
--port <span class="m">8000</span> <span class="se">\</span>
@ -423,15 +414,15 @@ __consul_service webapp <span class="se">\</span>
</div>
</div>
<div class="section" id="see-also">
<h2>16.25.6. SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.25.6. </span>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<p><strong>cdist-type__consul_agent</strong>(7)</p>
</div>
<div class="section" id="authors">
<h2>16.25.7. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.25.7. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Steven Armstrong &lt;<a class="reference external" href="mailto:steven-cdist--&#37;&#52;&#48;--armstrong&#46;cc">steven-cdist--<span>&#64;</span>--armstrong<span>&#46;</span>cc</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.25.8. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.25.8. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2015 Steven Armstrong. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

165
src/extra/manual/beta/man7/cdist-type__consul_template.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.26. cdist-type__consul_template(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.26. cdist-type__consul_template(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -347,9 +338,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.26. cdist-type__consul_template(7)</li>
<li><span class="section-number">16.26. </span>cdist-type__consul_template(7)</li>
<li class="wy-breadcrumbs-aside">
@ -369,13 +360,13 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-consul-template-7">
<h1>16.26. cdist-type__consul_template(7)<a class="headerlink" href="#cdist-type-consul-template-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.26. </span>cdist-type__consul_template(7)<a class="headerlink" href="#cdist-type-consul-template-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.26.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.26.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__consul_template - Manage the consul-template service</p>
</div>
<div class="section" id="description">
<h2>16.26.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.26.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Downloads and installs the consul-template binary from
<a class="reference external" href="https://github.com/hashicorp/consul-template/releases/download/">https://github.com/hashicorp/consul-template/releases/download/</a>.
Generates a global config file and creates directory for per template config files.
@ -383,81 +374,81 @@ Note that the consul-template binary is downloaded on the server (the machine ru
cdist) and then deployed to the target host using the __file type.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.26.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.26.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<p>None.</p>
</div>
<div class="section" id="optional-parameters">
<h2>16.26.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>auth-username</dt>
<dd>specify a username for basic authentication.</dd>
<dt>auth-password</dt>
<dd>specify a password for basic authentication.</dd>
<dt>batch-size</dt>
<dd>the size of the batch when polling multiple dependencies.</dd>
<dt>consul</dt>
<dd>the location of the Consul instance to query (may be an IP address or FQDN) with port.
Defaults to 'localhost:8500'.</dd>
<dt>log-level</dt>
<dd>The log level for output. This applies to the stdout/stderr logging as well
<h2><span class="section-number">16.26.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>auth-username</dt><dd><p>specify a username for basic authentication.</p>
</dd>
<dt>auth-password</dt><dd><p>specify a password for basic authentication.</p>
</dd>
<dt>batch-size</dt><dd><p>the size of the batch when polling multiple dependencies.</p>
</dd>
<dt>consul</dt><dd><p>the location of the Consul instance to query (may be an IP address or FQDN) with port.
Defaults to 'localhost:8500'.</p>
</dd>
<dt>log-level</dt><dd><p>The log level for output. This applies to the stdout/stderr logging as well
as syslog logging (if enabled). Valid values are &quot;debug&quot;, &quot;info&quot;, &quot;warn&quot;,
and &quot;err&quot;. The default value is &quot;warn&quot;.</dd>
<dt>max-stale</dt>
<dd>the maximum staleness of a query. If specified, Consul will distribute work among all
servers instead of just the leader.</dd>
<dt>retry</dt>
<dd>the amount of time to wait if Consul returns an error when communicating
with the API.</dd>
<dt>state</dt>
<dd>either 'present' or 'absent'. Defaults to 'present'</dd>
<dt>ssl-cert</dt>
<dd>Path to an SSL client certificate to use to authenticate to the consul server.
Useful if the consul server &quot;verify_incoming&quot; option is set.</dd>
<dt>ssl-ca-cert</dt>
<dd>Path to a CA certificate file, containing one or more CA certificates to
and &quot;err&quot;. The default value is &quot;warn&quot;.</p>
</dd>
<dt>max-stale</dt><dd><p>the maximum staleness of a query. If specified, Consul will distribute work among all
servers instead of just the leader.</p>
</dd>
<dt>retry</dt><dd><p>the amount of time to wait if Consul returns an error when communicating
with the API.</p>
</dd>
<dt>state</dt><dd><p>either 'present' or 'absent'. Defaults to 'present'</p>
</dd>
<dt>ssl-cert</dt><dd><p>Path to an SSL client certificate to use to authenticate to the consul server.
Useful if the consul server &quot;verify_incoming&quot; option is set.</p>
</dd>
<dt>ssl-ca-cert</dt><dd><p>Path to a CA certificate file, containing one or more CA certificates to
use to validate the certificate sent by the consul server to us. This is a
handy alternative to setting --ssl-no-verify if you are using your own CA.</dd>
<dt>syslog-facility</dt>
<dd>The facility to use when sending to syslog. This requires the use of --syslog.
The default value is LOCAL0.</dd>
<dt>token</dt>
<dd>the Consul API token.</dd>
<dt>vault-address</dt>
<dd>the location of the Vault instance to query (may be an IP address or FQDN) with port.</dd>
<dt>vault-token</dt>
<dd>the Vault API token.</dd>
<dt>vault-ssl-cert</dt>
<dd>Path to an SSL client certificate to use to authenticate to the vault server.</dd>
<dt>vault-ssl-ca-cert</dt>
<dd>Path to a CA certificate file, containing one or more CA certificates to
use to validate the certificate sent by the vault server to us.</dd>
<dt>version</dt>
<dd>which version of consul-template to install. See ./files/versions for a list of
supported versions. Defaults to the latest known version.</dd>
<dt>wait</dt>
<dd>the minimum(:maximum) to wait before rendering a new template to disk and
handy alternative to setting --ssl-no-verify if you are using your own CA.</p>
</dd>
<dt>syslog-facility</dt><dd><p>The facility to use when sending to syslog. This requires the use of --syslog.
The default value is LOCAL0.</p>
</dd>
<dt>token</dt><dd><p>the Consul API token.</p>
</dd>
<dt>vault-address</dt><dd><p>the location of the Vault instance to query (may be an IP address or FQDN) with port.</p>
</dd>
<dt>vault-token</dt><dd><p>the Vault API token.</p>
</dd>
<dt>vault-ssl-cert</dt><dd><p>Path to an SSL client certificate to use to authenticate to the vault server.</p>
</dd>
<dt>vault-ssl-ca-cert</dt><dd><p>Path to a CA certificate file, containing one or more CA certificates to
use to validate the certificate sent by the vault server to us.</p>
</dd>
<dt>version</dt><dd><p>which version of consul-template to install. See ./files/versions for a list of
supported versions. Defaults to the latest known version.</p>
</dd>
<dt>wait</dt><dd><p>the minimum(:maximum) to wait before rendering a new template to disk and
triggering a command, separated by a colon (:). If the optional maximum
value is omitted, it is assumed to be 4x the required minimum value.</dd>
value is omitted, it is assumed to be 4x the required minimum value.</p>
</dd>
</dl>
</div>
<div class="section" id="boolean-parameters">
<h2>16.26.5. BOOLEAN PARAMETERS<a class="headerlink" href="#boolean-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>ssl</dt>
<dd>use HTTPS while talking to Consul. Requires the Consul server to be configured to serve secure connections.</dd>
<dt>ssl-no-verify</dt>
<dd>ignore certificate warnings. Only used if ssl is enabled.</dd>
<dt>syslog</dt>
<dd>Send log output to syslog (in addition to stdout and stderr).</dd>
<dt>vault-ssl</dt>
<dd>use HTTPS while talking to Vault. Requires the Vault server to be configured to serve secure connections.</dd>
<dt>vault-ssl-no-verify</dt>
<dd>ignore certificate warnings. Only used if vault is enabled.</dd>
<h2><span class="section-number">16.26.5. </span>BOOLEAN PARAMETERS<a class="headerlink" href="#boolean-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>ssl</dt><dd><p>use HTTPS while talking to Consul. Requires the Consul server to be configured to serve secure connections.</p>
</dd>
<dt>ssl-no-verify</dt><dd><p>ignore certificate warnings. Only used if ssl is enabled.</p>
</dd>
<dt>syslog</dt><dd><p>Send log output to syslog (in addition to stdout and stderr).</p>
</dd>
<dt>vault-ssl</dt><dd><p>use HTTPS while talking to Vault. Requires the Vault server to be configured to serve secure connections.</p>
</dd>
<dt>vault-ssl-no-verify</dt><dd><p>ignore certificate warnings. Only used if vault is enabled.</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>16.26.6. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__consul_template <span class="se">\</span>
<h2><span class="section-number">16.26.6. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>__consul_template <span class="se">\</span>
--consul consul.service.consul:8500 <span class="se">\</span>
--retry 30s
@ -469,15 +460,15 @@ __consul_template <span class="se">\</span>
</div>
</div>
<div class="section" id="see-also">
<h2>16.26.7. SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.26.7. </span>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<p>consul documentation at: &lt;<a class="reference external" href="https://github.com/hashicorp/consul-template">https://github.com/hashicorp/consul-template</a>&gt;.</p>
</div>
<div class="section" id="authors">
<h2>16.26.8. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.26.8. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Steven Armstrong &lt;<a class="reference external" href="mailto:steven-cdist--&#37;&#52;&#48;--armstrong&#46;cc">steven-cdist--<span>&#64;</span>--armstrong<span>&#46;</span>cc</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.26.9. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.26.9. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2015 Steven Armstrong. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

79
src/extra/manual/beta/man7/cdist-type__consul_template_template.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.27. cdist-type__consul_template_template(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.27. cdist-type__consul_template_template(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -346,9 +337,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.27. cdist-type__consul_template_template(7)</li>
<li><span class="section-number">16.27. </span>cdist-type__consul_template_template(7)</li>
<li class="wy-breadcrumbs-aside">
@ -368,51 +359,51 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-consul-template-template-7">
<h1>16.27. cdist-type__consul_template_template(7)<a class="headerlink" href="#cdist-type-consul-template-template-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.27. </span>cdist-type__consul_template_template(7)<a class="headerlink" href="#cdist-type-consul-template-template-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.27.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.27.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__consul_template_template - Manage consul-template templates</p>
</div>
<div class="section" id="description">
<h2>16.27.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.27.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Generate and deploy template definitions for a consul-template.
See <a class="reference external" href="https://github.com/hashicorp/consul-template#examples">https://github.com/hashicorp/consul-template#examples</a> for documentation.
Templates are written in the Go template format.
Either the --source or the --source-file parameter must be given.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.27.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>destination</dt>
<dd>the destination where the generated file should go.</dd>
<h2><span class="section-number">16.27.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>destination</dt><dd><p>the destination where the generated file should go.</p>
</dd>
</dl>
</div>
<div class="section" id="optional-parameters">
<h2>16.27.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>command</dt>
<dd>an optional command to run after rendering the template to its destination.</dd>
<dt>source</dt>
<dd>path to the template source. Conflicts --source-file.</dd>
<dt>source-file</dt>
<dd>path to a local file which is uploaded using the __file type and configured
<h2><span class="section-number">16.27.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>command</dt><dd><p>an optional command to run after rendering the template to its destination.</p>
</dd>
<dt>source</dt><dd><p>path to the template source. Conflicts --source-file.</p>
</dd>
<dt>source-file</dt><dd><p>path to a local file which is uploaded using the __file type and configured
as the source.
If source is '-' (dash), take what was written to stdin as the file content.
Conflicts --source.</dd>
<dt>state</dt>
<dd>if this template is 'present' or 'absent'. Defaults to 'present'.</dd>
<dt>wait</dt>
<dd>The <cite>minimum(:maximum)</cite> time to wait before rendering a new template to
Conflicts --source.</p>
</dd>
<dt>state</dt><dd><p>if this template is 'present' or 'absent'. Defaults to 'present'.</p>
</dd>
<dt>wait</dt><dd><p>The <cite>minimum(:maximum)</cite> time to wait before rendering a new template to
disk and triggering a command, separated by a colon (<cite>:</cite>). If the optional
maximum value is omitted, it is assumed to be 4x the required minimum value.
This is a numeric time with a unit suffix (&quot;5s&quot;). There is no default value.
The wait value for a template takes precedence over any globally-configured
wait.</dd>
wait.</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>16.27.5. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># configure template on the target</span>
<h2><span class="section-number">16.27.5. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># configure template on the target</span>
__consul_template_template nginx <span class="se">\</span>
--source /etc/my-consul-templates/nginx.ctmpl <span class="se">\</span>
--destination /etc/nginx/nginx.conf <span class="se">\</span>
@ -429,15 +420,15 @@ __consul_template_template nginx <span class="se">\</span>
</div>
</div>
<div class="section" id="see-also">
<h2>16.27.6. SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.27.6. </span>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<p><strong>cdist-type__consul_template</strong>(7), <strong>cdist-type__consul_template_config</strong>(7)</p>
</div>
<div class="section" id="authors">
<h2>16.27.7. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.27.7. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Steven Armstrong &lt;<a class="reference external" href="mailto:steven-cdist--&#37;&#52;&#48;--armstrong&#46;cc">steven-cdist--<span>&#64;</span>--armstrong<span>&#46;</span>cc</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.27.8. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.27.8. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2015-2016 Steven Armstrong. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

75
src/extra/manual/beta/man7/cdist-type__consul_watch_checks.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.28. cdist-type__consul_watch_checks(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.28. cdist-type__consul_watch_checks(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -346,9 +337,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.28. cdist-type__consul_watch_checks(7)</li>
<li><span class="section-number">16.28. </span>cdist-type__consul_watch_checks(7)</li>
<li class="wy-breadcrumbs-aside">
@ -368,41 +359,41 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-consul-watch-checks-7">
<h1>16.28. cdist-type__consul_watch_checks(7)<a class="headerlink" href="#cdist-type-consul-watch-checks-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.28. </span>cdist-type__consul_watch_checks(7)<a class="headerlink" href="#cdist-type-consul-watch-checks-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.28.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.28.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__consul_watch_checks - Manages consul checks watches</p>
</div>
<div class="section" id="description">
<h2>16.28.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.28.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Generate and deploy watch definitions of type 'checks' for a consul agent.
See <a class="reference external" href="http://www.consul.io/docs/agent/watches.html">http://www.consul.io/docs/agent/watches.html</a> for parameter documentation.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.28.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>handler</dt>
<dd>the handler to invoke when the data view updates</dd>
<h2><span class="section-number">16.28.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>handler</dt><dd><p>the handler to invoke when the data view updates</p>
</dd>
</dl>
</div>
<div class="section" id="optional-parameters">
<h2>16.28.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>datacenter</dt>
<dd>can be provided to override the agent's default datacenter</dd>
<dt>filter-service</dt>
<dd>filter to a specific service. Conflicts with --filter-state.</dd>
<dt>filter-state</dt>
<dd>filter to a specific state. Conflicts with --filter-service.</dd>
<dt>state</dt>
<dd>if this watch is 'present' or 'absent'. Defaults to 'present'.</dd>
<dt>token</dt>
<dd>can be provided to override the agent's default ACL token</dd>
<h2><span class="section-number">16.28.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>datacenter</dt><dd><p>can be provided to override the agent's default datacenter</p>
</dd>
<dt>filter-service</dt><dd><p>filter to a specific service. Conflicts with --filter-state.</p>
</dd>
<dt>filter-state</dt><dd><p>filter to a specific state. Conflicts with --filter-service.</p>
</dd>
<dt>state</dt><dd><p>if this watch is 'present' or 'absent'. Defaults to 'present'.</p>
</dd>
<dt>token</dt><dd><p>can be provided to override the agent's default ACL token</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>16.28.5. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__consul_watch_checks some-id <span class="se">\</span>
<h2><span class="section-number">16.28.5. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>__consul_watch_checks some-id <span class="se">\</span>
--handler /usr/bin/my-handler.sh
__consul_watch_checks some-id <span class="se">\</span>
@ -416,16 +407,16 @@ __consul_watch_checks some-id <span class="se">\</span>
</div>
</div>
<div class="section" id="see-also">
<h2>16.28.6. SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.28.6. </span>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<p><strong>cdist-type__consul_agent</strong>(7)</p>
<p>consul documentation at: &lt;<a class="reference external" href="http://www.consul.io/docs/agent/watches.html">http://www.consul.io/docs/agent/watches.html</a>&gt;.</p>
</div>
<div class="section" id="authors">
<h2>16.28.7. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.28.7. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Steven Armstrong &lt;<a class="reference external" href="mailto:steven-cdist--&#37;&#52;&#48;--armstrong&#46;cc">steven-cdist--<span>&#64;</span>--armstrong<span>&#46;</span>cc</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.28.8. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.28.8. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2015 Steven Armstrong. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

71
src/extra/manual/beta/man7/cdist-type__consul_watch_event.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.29. cdist-type__consul_watch_event(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.29. cdist-type__consul_watch_event(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -346,9 +337,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.29. cdist-type__consul_watch_event(7)</li>
<li><span class="section-number">16.29. </span>cdist-type__consul_watch_event(7)</li>
<li class="wy-breadcrumbs-aside">
@ -368,39 +359,39 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-consul-watch-event-7">
<h1>16.29. cdist-type__consul_watch_event(7)<a class="headerlink" href="#cdist-type-consul-watch-event-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.29. </span>cdist-type__consul_watch_event(7)<a class="headerlink" href="#cdist-type-consul-watch-event-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.29.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.29.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__consul_watch_event - Manages consul event watches</p>
</div>
<div class="section" id="description">
<h2>16.29.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.29.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Generate and deploy watch definitions of type 'event' for a consul agent.
See <a class="reference external" href="http://www.consul.io/docs/agent/watches.html">http://www.consul.io/docs/agent/watches.html</a> for parameter documentation.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.29.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>handler</dt>
<dd>the handler to invoke when the data view updates</dd>
<h2><span class="section-number">16.29.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>handler</dt><dd><p>the handler to invoke when the data view updates</p>
</dd>
</dl>
</div>
<div class="section" id="optional-parameters">
<h2>16.29.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>datacenter</dt>
<dd>can be provided to override the agent's default datacenter</dd>
<dt>name</dt>
<dd>restrict the watch to only events with the given name</dd>
<dt>state</dt>
<dd>if this watch is 'present' or 'absent'. Defaults to 'present'.</dd>
<dt>token</dt>
<dd>can be provided to override the agent's default ACL token</dd>
<h2><span class="section-number">16.29.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>datacenter</dt><dd><p>can be provided to override the agent's default datacenter</p>
</dd>
<dt>name</dt><dd><p>restrict the watch to only events with the given name</p>
</dd>
<dt>state</dt><dd><p>if this watch is 'present' or 'absent'. Defaults to 'present'.</p>
</dd>
<dt>token</dt><dd><p>can be provided to override the agent's default ACL token</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>16.29.5. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__consul_watch_event some-id <span class="se">\</span>
<h2><span class="section-number">16.29.5. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>__consul_watch_event some-id <span class="se">\</span>
--handler /usr/bin/my-handler.sh
__consul_watch_event some-id <span class="se">\</span>
@ -410,16 +401,16 @@ __consul_watch_event some-id <span class="se">\</span>
</div>
</div>
<div class="section" id="see-also">
<h2>16.29.6. SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.29.6. </span>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<p><strong>cdist-type__consul_agent</strong>(7)</p>
<p>consul documentation at: &lt;<a class="reference external" href="http://www.consul.io/docs/agent/watches.html">http://www.consul.io/docs/agent/watches.html</a>&gt;.</p>
</div>
<div class="section" id="authors">
<h2>16.29.7. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.29.7. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Steven Armstrong &lt;<a class="reference external" href="mailto:steven-cdist--&#37;&#52;&#48;--armstrong&#46;cc">steven-cdist--<span>&#64;</span>--armstrong<span>&#46;</span>cc</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.29.8. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.29.8. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2015 Steven Armstrong. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

71
src/extra/manual/beta/man7/cdist-type__consul_watch_key.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.30. cdist-type__consul_watch_key(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.30. cdist-type__consul_watch_key(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -346,9 +337,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.30. cdist-type__consul_watch_key(7)</li>
<li><span class="section-number">16.30. </span>cdist-type__consul_watch_key(7)</li>
<li class="wy-breadcrumbs-aside">
@ -368,55 +359,55 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-consul-watch-key-7">
<h1>16.30. cdist-type__consul_watch_key(7)<a class="headerlink" href="#cdist-type-consul-watch-key-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.30. </span>cdist-type__consul_watch_key(7)<a class="headerlink" href="#cdist-type-consul-watch-key-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.30.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.30.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__consul_watch_key - Manages consul key watches</p>
</div>
<div class="section" id="description">
<h2>16.30.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.30.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Generate and deploy watch definitions of type 'key' for a consul agent.
See <a class="reference external" href="http://www.consul.io/docs/agent/watches.html">http://www.consul.io/docs/agent/watches.html</a> for parameter documentation.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.30.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>handler</dt>
<dd>the handler to invoke when the data view updates</dd>
<dt>key</dt>
<dd>the key to watch for changes</dd>
<h2><span class="section-number">16.30.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>handler</dt><dd><p>the handler to invoke when the data view updates</p>
</dd>
<dt>key</dt><dd><p>the key to watch for changes</p>
</dd>
</dl>
</div>
<div class="section" id="optional-parameters">
<h2>16.30.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>datacenter</dt>
<dd>can be provided to override the agent's default datacenter</dd>
<dt>state</dt>
<dd>if this watch is 'present' or 'absent'. Defaults to 'present'.</dd>
<dt>token</dt>
<dd>can be provided to override the agent's default ACL token</dd>
<h2><span class="section-number">16.30.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>datacenter</dt><dd><p>can be provided to override the agent's default datacenter</p>
</dd>
<dt>state</dt><dd><p>if this watch is 'present' or 'absent'. Defaults to 'present'.</p>
</dd>
<dt>token</dt><dd><p>can be provided to override the agent's default ACL token</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>16.30.5. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__consul_watch_key some-id <span class="se">\</span>
<h2><span class="section-number">16.30.5. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>__consul_watch_key some-id <span class="se">\</span>
--key foo/bar/baz <span class="se">\</span>
--handler /usr/bin/my-key-handler.sh
</pre></div>
</div>
</div>
<div class="section" id="see-also">
<h2>16.30.6. SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.30.6. </span>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<p><strong>cdist-type__consul_agent</strong>(7)</p>
<p>consul documentation at: &lt;<a class="reference external" href="http://www.consul.io/docs/agent/watches.html">http://www.consul.io/docs/agent/watches.html</a>&gt;.</p>
</div>
<div class="section" id="authors">
<h2>16.30.7. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.30.7. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Steven Armstrong &lt;<a class="reference external" href="mailto:steven-cdist--&#37;&#52;&#48;--armstrong&#46;cc">steven-cdist--<span>&#64;</span>--armstrong<span>&#46;</span>cc</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.30.8. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.30.8. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2015 Steven Armstrong. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

71
src/extra/manual/beta/man7/cdist-type__consul_watch_keyprefix.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.31. cdist-type__consul_watch_keyprefix(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.31. cdist-type__consul_watch_keyprefix(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -346,9 +337,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.31. cdist-type__consul_watch_keyprefix(7)</li>
<li><span class="section-number">16.31. </span>cdist-type__consul_watch_keyprefix(7)</li>
<li class="wy-breadcrumbs-aside">
@ -368,55 +359,55 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-consul-watch-keyprefix-7">
<h1>16.31. cdist-type__consul_watch_keyprefix(7)<a class="headerlink" href="#cdist-type-consul-watch-keyprefix-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.31. </span>cdist-type__consul_watch_keyprefix(7)<a class="headerlink" href="#cdist-type-consul-watch-keyprefix-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.31.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.31.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__consul_watch_keyprefix - Manages consul keyprefix watches</p>
</div>
<div class="section" id="description">
<h2>16.31.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.31.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Generate and deploy watch definitions of type 'keyprefix' for a consul agent.
See <a class="reference external" href="http://www.consul.io/docs/agent/watches.html">http://www.consul.io/docs/agent/watches.html</a> for parameter documentation.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.31.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>handler</dt>
<dd>the handler to invoke when the data view updates</dd>
<dt>prefix</dt>
<dd>the prefix of keys to watch for changes</dd>
<h2><span class="section-number">16.31.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>handler</dt><dd><p>the handler to invoke when the data view updates</p>
</dd>
<dt>prefix</dt><dd><p>the prefix of keys to watch for changes</p>
</dd>
</dl>
</div>
<div class="section" id="optional-parameters">
<h2>16.31.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>datacenter</dt>
<dd>can be provided to override the agent's default datacenter</dd>
<dt>state</dt>
<dd>if this watch is 'present' or 'absent'. Defaults to 'present'.</dd>
<dt>token</dt>
<dd>can be provided to override the agent's default ACL token</dd>
<h2><span class="section-number">16.31.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>datacenter</dt><dd><p>can be provided to override the agent's default datacenter</p>
</dd>
<dt>state</dt><dd><p>if this watch is 'present' or 'absent'. Defaults to 'present'.</p>
</dd>
<dt>token</dt><dd><p>can be provided to override the agent's default ACL token</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>16.31.5. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__consul_watch_keyprefix some-id <span class="se">\</span>
<h2><span class="section-number">16.31.5. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>__consul_watch_keyprefix some-id <span class="se">\</span>
--prefix foo/ <span class="se">\</span>
--handler /usr/bin/my-prefix-handler.sh
</pre></div>
</div>
</div>
<div class="section" id="see-also">
<h2>16.31.6. SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.31.6. </span>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<p><strong>cdist-type__consul_agent</strong>(7)</p>
<p>consul documentation at: &lt;<a class="reference external" href="http://www.consul.io/docs/agent/watches.html">http://www.consul.io/docs/agent/watches.html</a>&gt;.</p>
</div>
<div class="section" id="authors">
<h2>16.31.7. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.31.7. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Steven Armstrong &lt;<a class="reference external" href="mailto:steven-cdist--&#37;&#52;&#48;--armstrong&#46;cc">steven-cdist--<span>&#64;</span>--armstrong<span>&#46;</span>cc</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.31.8. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.31.8. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2015 Steven Armstrong. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

67
src/extra/manual/beta/man7/cdist-type__consul_watch_nodes.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.32. cdist-type__consul_watch_nodes(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.32. cdist-type__consul_watch_nodes(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -346,9 +337,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.32. cdist-type__consul_watch_nodes(7)</li>
<li><span class="section-number">16.32. </span>cdist-type__consul_watch_nodes(7)</li>
<li class="wy-breadcrumbs-aside">
@ -368,52 +359,52 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-consul-watch-nodes-7">
<h1>16.32. cdist-type__consul_watch_nodes(7)<a class="headerlink" href="#cdist-type-consul-watch-nodes-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.32. </span>cdist-type__consul_watch_nodes(7)<a class="headerlink" href="#cdist-type-consul-watch-nodes-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.32.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.32.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__consul_watch_nodes - Manages consul nodes watches</p>
</div>
<div class="section" id="description">
<h2>16.32.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.32.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Generate and deploy watch definitions of type 'nodes' for a consul agent.
See <a class="reference external" href="http://www.consul.io/docs/agent/watches.html">http://www.consul.io/docs/agent/watches.html</a> for parameter documentation.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.32.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>handler</dt>
<dd>the handler to invoke when the data view updates</dd>
<h2><span class="section-number">16.32.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>handler</dt><dd><p>the handler to invoke when the data view updates</p>
</dd>
</dl>
</div>
<div class="section" id="optional-parameters">
<h2>16.32.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>datacenter</dt>
<dd>can be provided to override the agent's default datacenter</dd>
<dt>state</dt>
<dd>if this watch is 'present' or 'absent'. Defaults to 'present'.</dd>
<dt>token</dt>
<dd>can be provided to override the agent's default ACL token</dd>
<h2><span class="section-number">16.32.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>datacenter</dt><dd><p>can be provided to override the agent's default datacenter</p>
</dd>
<dt>state</dt><dd><p>if this watch is 'present' or 'absent'. Defaults to 'present'.</p>
</dd>
<dt>token</dt><dd><p>can be provided to override the agent's default ACL token</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>16.32.5. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__consul_watch_nodes some-id <span class="se">\</span>
<h2><span class="section-number">16.32.5. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>__consul_watch_nodes some-id <span class="se">\</span>
--handler /usr/bin/my-key-handler.sh
</pre></div>
</div>
</div>
<div class="section" id="see-also">
<h2>16.32.6. SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.32.6. </span>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<p><strong>cdist-type__consul_agent</strong>(7)</p>
<p>consul documentation at: &lt;<a class="reference external" href="http://www.consul.io/docs/agent/watches.html">http://www.consul.io/docs/agent/watches.html</a>&gt;.</p>
</div>
<div class="section" id="authors">
<h2>16.32.7. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.32.7. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Steven Armstrong &lt;<a class="reference external" href="mailto:steven-cdist--&#37;&#52;&#48;--armstrong&#46;cc">steven-cdist--<span>&#64;</span>--armstrong<span>&#46;</span>cc</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.32.8. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.32.8. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2015 Steven Armstrong. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

83
src/extra/manual/beta/man7/cdist-type__consul_watch_service.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.33. cdist-type__consul_watch_service(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.33. cdist-type__consul_watch_service(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -347,9 +338,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.33. cdist-type__consul_watch_service(7)</li>
<li><span class="section-number">16.33. </span>cdist-type__consul_watch_service(7)</li>
<li class="wy-breadcrumbs-aside">
@ -369,48 +360,48 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-consul-watch-service-7">
<h1>16.33. cdist-type__consul_watch_service(7)<a class="headerlink" href="#cdist-type-consul-watch-service-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.33. </span>cdist-type__consul_watch_service(7)<a class="headerlink" href="#cdist-type-consul-watch-service-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.33.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.33.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__consul_watch_service - Manages consul service watches</p>
</div>
<div class="section" id="description">
<h2>16.33.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.33.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Generate and deploy watch definitions of type 'service' for a consul agent.
See <a class="reference external" href="http://www.consul.io/docs/agent/watches.html">http://www.consul.io/docs/agent/watches.html</a> for parameter documentation.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.33.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>handler</dt>
<dd>the handler to invoke when the data view updates</dd>
<dt>service</dt>
<dd>the service to watch for changes</dd>
<h2><span class="section-number">16.33.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>handler</dt><dd><p>the handler to invoke when the data view updates</p>
</dd>
<dt>service</dt><dd><p>the service to watch for changes</p>
</dd>
</dl>
</div>
<div class="section" id="optional-parameters">
<h2>16.33.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>datacenter</dt>
<dd>can be provided to override the agent's default datacenter</dd>
<dt>state</dt>
<dd>if this watch is 'present' or 'absent'. Defaults to 'present'.</dd>
<dt>token</dt>
<dd>can be provided to override the agent's default ACL token</dd>
<dt>tag</dt>
<dd>filter by tag</dd>
<h2><span class="section-number">16.33.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>datacenter</dt><dd><p>can be provided to override the agent's default datacenter</p>
</dd>
<dt>state</dt><dd><p>if this watch is 'present' or 'absent'. Defaults to 'present'.</p>
</dd>
<dt>token</dt><dd><p>can be provided to override the agent's default ACL token</p>
</dd>
<dt>tag</dt><dd><p>filter by tag</p>
</dd>
</dl>
</div>
<div class="section" id="boolean-parameters">
<h2>16.33.5. BOOLEAN PARAMETERS<a class="headerlink" href="#boolean-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>passingonly</dt>
<dd>specifies if only hosts passing all checks are displayed</dd>
<h2><span class="section-number">16.33.5. </span>BOOLEAN PARAMETERS<a class="headerlink" href="#boolean-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>passingonly</dt><dd><p>specifies if only hosts passing all checks are displayed</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>16.33.6. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__consul_watch_service some-id <span class="se">\</span>
<h2><span class="section-number">16.33.6. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>__consul_watch_service some-id <span class="se">\</span>
--service consul <span class="se">\</span>
--handler /usr/bin/my-handler.sh
@ -428,16 +419,16 @@ __consul_watch_service some-id <span class="se">\</span>
</div>
</div>
<div class="section" id="see-also">
<h2>16.33.7. SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.33.7. </span>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<p><strong>cdist-type__consul_agent</strong>(7)</p>
<p>consul documentation at: &lt;<a class="reference external" href="http://www.consul.io/docs/agent/watches.html">http://www.consul.io/docs/agent/watches.html</a>&gt;.</p>
</div>
<div class="section" id="authors">
<h2>16.33.8. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.33.8. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Steven Armstrong &lt;<a class="reference external" href="mailto:steven-cdist--&#37;&#52;&#48;--armstrong&#46;cc">steven-cdist--<span>&#64;</span>--armstrong<span>&#46;</span>cc</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.33.9. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.33.9. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2015 Steven Armstrong. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

67
src/extra/manual/beta/man7/cdist-type__consul_watch_services.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.34. cdist-type__consul_watch_services(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.34. cdist-type__consul_watch_services(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -346,9 +337,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.34. cdist-type__consul_watch_services(7)</li>
<li><span class="section-number">16.34. </span>cdist-type__consul_watch_services(7)</li>
<li class="wy-breadcrumbs-aside">
@ -368,52 +359,52 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-consul-watch-services-7">
<h1>16.34. cdist-type__consul_watch_services(7)<a class="headerlink" href="#cdist-type-consul-watch-services-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.34. </span>cdist-type__consul_watch_services(7)<a class="headerlink" href="#cdist-type-consul-watch-services-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.34.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.34.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__consul_watch_services - Manages consul services watches</p>
</div>
<div class="section" id="description">
<h2>16.34.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.34.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Generate and deploy watch definitions of type 'services' for a consul agent.
See <a class="reference external" href="http://www.consul.io/docs/agent/watches.html">http://www.consul.io/docs/agent/watches.html</a> for parameter documentation.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.34.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>handler</dt>
<dd>the handler to invoke when the data view updates</dd>
<h2><span class="section-number">16.34.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>handler</dt><dd><p>the handler to invoke when the data view updates</p>
</dd>
</dl>
</div>
<div class="section" id="optional-parameters">
<h2>16.34.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>datacenter</dt>
<dd>can be provided to override the agent's default datacenter</dd>
<dt>state</dt>
<dd>if this watch is 'present' or 'absent'. Defaults to 'present'.</dd>
<dt>token</dt>
<dd>can be provided to override the agent's default ACL token</dd>
<h2><span class="section-number">16.34.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>datacenter</dt><dd><p>can be provided to override the agent's default datacenter</p>
</dd>
<dt>state</dt><dd><p>if this watch is 'present' or 'absent'. Defaults to 'present'.</p>
</dd>
<dt>token</dt><dd><p>can be provided to override the agent's default ACL token</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>16.34.5. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__consul_watch_services some-id <span class="se">\</span>
<h2><span class="section-number">16.34.5. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>__consul_watch_services some-id <span class="se">\</span>
--handler /usr/bin/my-key-handler.sh
</pre></div>
</div>
</div>
<div class="section" id="see-also">
<h2>16.34.6. SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.34.6. </span>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<p><strong>cdist-type__consul_agent</strong>(7)</p>
<p>consul documentation at: &lt;<a class="reference external" href="http://www.consul.io/docs/agent/watches.html">http://www.consul.io/docs/agent/watches.html</a>&gt;.</p>
</div>
<div class="section" id="authors">
<h2>16.34.7. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.34.7. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Steven Armstrong &lt;<a class="reference external" href="mailto:steven-cdist--&#37;&#52;&#48;--armstrong&#46;cc">steven-cdist--<span>&#64;</span>--armstrong<span>&#46;</span>cc</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.34.8. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.34.8. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2015 Steven Armstrong. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

101
src/extra/manual/beta/man7/cdist-type__cron.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.35. cdist-type__cron(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.35. cdist-type__cron(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -346,9 +337,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.35. cdist-type__cron(7)</li>
<li><span class="section-number">16.35. </span>cdist-type__cron(7)</li>
<li class="wy-breadcrumbs-aside">
@ -368,58 +359,58 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-cron-7">
<h1>16.35. cdist-type__cron(7)<a class="headerlink" href="#cdist-type-cron-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.35. </span>cdist-type__cron(7)<a class="headerlink" href="#cdist-type-cron-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.35.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.35.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__cron - Installs and manages cron jobs</p>
</div>
<div class="section" id="description">
<h2>16.35.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.35.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>This cdist type allows you to manage entries in a users crontab.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.35.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>user</dt>
<dd>The user who's crontab is edited</dd>
<dt>command</dt>
<dd>The command to run.</dd>
<h2><span class="section-number">16.35.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>user</dt><dd><p>The user who's crontab is edited</p>
</dd>
<dt>command</dt><dd><p>The command to run.</p>
</dd>
</dl>
</div>
<div class="section" id="optional-parameters">
<h2>16.35.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<p><strong>NOTE</strong>: All time-related parameters (<code class="docutils literal"><span class="pre">--minute</span></code>, <code class="docutils literal"><span class="pre">--hour</span></code>, <code class="docutils literal"><span class="pre">--day_of_month</span></code>
<code class="docutils literal"><span class="pre">--month</span></code> and <code class="docutils literal"><span class="pre">--day_of_week</span></code>) defaults to <code class="docutils literal"><span class="pre">*</span></code>, which means to execute it
<strong>always</strong>. If you set <code class="docutils literal"><span class="pre">--hour</span> <span class="pre">0</span></code> to execute the cronjob only at midnight, it
<h2><span class="section-number">16.35.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<p><strong>NOTE</strong>: All time-related parameters (<code class="docutils literal notranslate"><span class="pre">--minute</span></code>, <code class="docutils literal notranslate"><span class="pre">--hour</span></code>, <code class="docutils literal notranslate"><span class="pre">--day_of_month</span></code>
<code class="docutils literal notranslate"><span class="pre">--month</span></code> and <code class="docutils literal notranslate"><span class="pre">--day_of_week</span></code>) defaults to <code class="docutils literal notranslate"><span class="pre">*</span></code>, which means to execute it
<strong>always</strong>. If you set <code class="docutils literal notranslate"><span class="pre">--hour</span> <span class="pre">0</span></code> to execute the cronjob only at midnight, it
will execute <strong>every</strong> minute in the first hour of the morning all days.</p>
<dl class="docutils">
<dt>state</dt>
<dd>Either present or absent. Defaults to present.</dd>
<dt>minute</dt>
<dd>See crontab(5). Defaults to *</dd>
<dt>hour</dt>
<dd>See crontab(5). Defaults to *</dd>
<dt>day_of_month</dt>
<dd>See crontab(5). Defaults to *</dd>
<dt>month</dt>
<dd>See crontab(5). Defaults to *</dd>
<dt>day_of_week</dt>
<dd>See crontab(5). Defaults to *</dd>
<dt>raw</dt>
<dd>Take whatever the user has given instead of time and date fields.
<dl class="simple">
<dt>state</dt><dd><p>Either present or absent. Defaults to present.</p>
</dd>
<dt>minute</dt><dd><p>See crontab(5). Defaults to *</p>
</dd>
<dt>hour</dt><dd><p>See crontab(5). Defaults to *</p>
</dd>
<dt>day_of_month</dt><dd><p>See crontab(5). Defaults to *</p>
</dd>
<dt>month</dt><dd><p>See crontab(5). Defaults to *</p>
</dd>
<dt>day_of_week</dt><dd><p>See crontab(5). Defaults to *</p>
</dd>
<dt>raw</dt><dd><p>Take whatever the user has given instead of time and date fields.
If given, all other time and date fields are ignored.
Can for example be used to specify cron EXTENSIONS like reboot, yearly etc.
See crontab(5) for the extensions if any that your cron implementation
implements.</dd>
<dt>raw_command</dt>
<dd>Take whatever the user has given in the command and ignore everything else.
implements.</p>
</dd>
<dt>raw_command</dt><dd><p>Take whatever the user has given in the command and ignore everything else.
If given, the command will be added to crontab.
Can for example be used to define variables like SHELL or MAILTO.</dd>
Can for example be used to define variables like SHELL or MAILTO.</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>16.35.5. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># run Monday to Saturday at 23:15</span>
<h2><span class="section-number">16.35.5. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># run Monday to Saturday at 23:15</span>
__cron some-id --user root --command <span class="s2">&quot;/path/to/script&quot;</span> <span class="se">\</span>
--hour <span class="m">23</span> --minute <span class="m">15</span> --day_of_week <span class="m">1</span>-6
@ -437,15 +428,15 @@ __cron some-id --user root --raw_command --command <span class="s2">&quot;SHELL=
</div>
</div>
<div class="section" id="see-also">
<h2>16.35.6. SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.35.6. </span>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<p><strong>crontab</strong>(5)</p>
</div>
<div class="section" id="authors">
<h2>16.35.7. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.35.7. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Steven Armstrong &lt;<a class="reference external" href="mailto:steven-cdist--&#37;&#52;&#48;--armstrong&#46;cc">steven-cdist--<span>&#64;</span>--armstrong<span>&#46;</span>cc</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.35.8. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.35.8. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2011-2013 Steven Armstrong. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

65
src/extra/manual/beta/man7/cdist-type__daemontools.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.36. cdist-type__daemontools(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.36. cdist-type__daemontools(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -347,9 +338,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.36. cdist-type__daemontools(7)</li>
<li><span class="section-number">16.36. </span>cdist-type__daemontools(7)</li>
<li class="wy-breadcrumbs-aside">
@ -369,51 +360,51 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-daemontools-7">
<h1>16.36. cdist-type__daemontools(7)<a class="headerlink" href="#cdist-type-daemontools-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.36. </span>cdist-type__daemontools(7)<a class="headerlink" href="#cdist-type-daemontools-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.36.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.36.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__daemontools - Install daemontools</p>
</div>
<div class="section" id="description">
<h2>16.36.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.36.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Install djb daemontools and (optionally) an init script.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.36.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.36.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<p>None.</p>
</div>
<div class="section" id="optional-parameters">
<h2>16.36.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>from-package</dt>
<dd>Package to install. Must be compatible with the original daemontools. Example: daemontools-encore. Default: daemontools.</dd>
<dt>servicedir</dt>
<dd>Directory to scan for services. Default: <cite>/service</cite></dd>
<h2><span class="section-number">16.36.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>from-package</dt><dd><p>Package to install. Must be compatible with the original daemontools. Example: daemontools-encore. Default: daemontools.</p>
</dd>
<dt>servicedir</dt><dd><p>Directory to scan for services. Default: <cite>/service</cite></p>
</dd>
</dl>
</div>
<div class="section" id="boolean-parameters">
<h2>16.36.5. BOOLEAN PARAMETERS<a class="headerlink" href="#boolean-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>install-init-script</dt>
<dd>Add an init script and set it to start on boot.</dd>
<h2><span class="section-number">16.36.5. </span>BOOLEAN PARAMETERS<a class="headerlink" href="#boolean-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>install-init-script</dt><dd><p>Add an init script and set it to start on boot.</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>16.36.6. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__daemontools --from-package daemontools-encore <span class="c1"># if you prefer</span>
<h2><span class="section-number">16.36.6. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>__daemontools --from-package daemontools-encore <span class="c1"># if you prefer</span>
</pre></div>
</div>
</div>
<div class="section" id="see-also">
<h2>16.36.7. SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.36.7. </span>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<p><strong>cdist-type__daemontools_service</strong>(7)</p>
</div>
<div class="section" id="authors">
<h2>16.36.8. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.36.8. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Kamila Součková &lt;<a class="reference external" href="mailto:kamila--&#37;&#52;&#48;--ksp&#46;sk">kamila--<span>&#64;</span>--ksp<span>&#46;</span>sk</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.36.9. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.36.9. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2017 Kamila Součková. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

73
src/extra/manual/beta/man7/cdist-type__daemontools_service.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.37. cdist-type__daemontools_service(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.37. cdist-type__daemontools_service(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -347,9 +338,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.37. cdist-type__daemontools_service(7)</li>
<li><span class="section-number">16.37. </span>cdist-type__daemontools_service(7)</li>
<li class="wy-breadcrumbs-aside">
@ -369,65 +360,63 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-daemontools-service-7">
<h1>16.37. cdist-type__daemontools_service(7)<a class="headerlink" href="#cdist-type-daemontools-service-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.37. </span>cdist-type__daemontools_service(7)<a class="headerlink" href="#cdist-type-daemontools-service-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.37.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.37.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__daemontools_service - Create a daemontools-compatible service dir.</p>
</div>
<div class="section" id="description">
<h2>16.37.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.37.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Create a directory structure compatible with daemontools-like service management.</p>
<p>Note that svc must be present on the target system.</p>
<p>The object ID will be used as the service name.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.37.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.37.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<p>None.</p>
</div>
<div class="section" id="optional-parameters">
<h2>16.37.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>run</dt>
<dd><p class="first">Command to run. exec-ing and stderr redirection will be added. One of run, run-file must be specified.</p>
<p class="last">Example: <cite>my-program</cite></p>
<h2><span class="section-number">16.37.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl>
<dt>run</dt><dd><p>Command to run. exec-ing and stderr redirection will be added. One of run, run-file must be specified.</p>
<p>Example: <cite>my-program</cite></p>
</dd>
<dt>run-file</dt>
<dd><p class="first">File to save as &lt;servicedir&gt;/run. One of run, run-file must be specified.</p>
<p class="last">Example:</p>
<dt>run-file</dt><dd><p>File to save as &lt;servicedir&gt;/run. One of run, run-file must be specified.</p>
<p>Example:</p>
</dd>
</dl>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="ch">#!/bin/sh</span>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="ch">#!/bin/sh</span>
<span class="nb">exec</span> <span class="m">2</span>&gt;<span class="p">&amp;</span><span class="m">1</span>
<span class="nb">exec</span> my_program
</pre></div>
</div>
<dl class="docutils">
<dt>log-run</dt>
<dd>Command to run for log consumption. Default: <cite>multilog t ./main</cite></dd>
<dt>servicedir</dt>
<dd>Directory to install into. Default: <cite>/service</cite></dd>
<dl class="simple">
<dt>log-run</dt><dd><p>Command to run for log consumption. Default: <cite>multilog t ./main</cite></p>
</dd>
<dt>servicedir</dt><dd><p>Directory to install into. Default: <cite>/service</cite></p>
</dd>
</dl>
</div>
<div class="section" id="boolean-parameters">
<h2>16.37.5. BOOLEAN PARAMETERS<a class="headerlink" href="#boolean-parameters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.37.5. </span>BOOLEAN PARAMETERS<a class="headerlink" href="#boolean-parameters" title="Permalink to this headline"></a></h2>
<p>None.</p>
</div>
<div class="section" id="examples">
<h2>16.37.6. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="nv">require</span><span class="o">=</span><span class="s2">&quot;__daemontools&quot;</span> __daemontools_service prometheus --run <span class="s2">&quot;setuidgid prometheus </span><span class="nv">$GOBIN</span><span class="s2">/prometheus </span><span class="nv">$FLAGS</span><span class="s2">&quot;</span>
<h2><span class="section-number">16.37.6. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">require</span><span class="o">=</span><span class="s2">&quot;__daemontools&quot;</span> __daemontools_service prometheus --run <span class="s2">&quot;setuidgid prometheus </span><span class="nv">$GOBIN</span><span class="s2">/prometheus </span><span class="nv">$FLAGS</span><span class="s2">&quot;</span>
</pre></div>
</div>
</div>
<div class="section" id="see-also">
<h2>16.37.7. SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.37.7. </span>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<p><strong>cdist-type__daemontools</strong>(7)</p>
</div>
<div class="section" id="authors">
<h2>16.37.8. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.37.8. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Kamila Součková &lt;<a class="reference external" href="mailto:kamila--&#37;&#52;&#48;--ksp&#46;sk">kamila--<span>&#64;</span>--ksp<span>&#46;</span>sk</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.37.9. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.37.9. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2017 Kamila Součková. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

53
src/extra/manual/beta/man7/cdist-type__debconf_set_selections.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.38. cdist-type__debconf_set_selections(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.38. cdist-type__debconf_set_selections(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -345,9 +336,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.38. cdist-type__debconf_set_selections(7)</li>
<li><span class="section-number">16.38. </span>cdist-type__debconf_set_selections(7)</li>
<li class="wy-breadcrumbs-aside">
@ -367,27 +358,27 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-debconf-set-selections-7">
<h1>16.38. cdist-type__debconf_set_selections(7)<a class="headerlink" href="#cdist-type-debconf-set-selections-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.38. </span>cdist-type__debconf_set_selections(7)<a class="headerlink" href="#cdist-type-debconf-set-selections-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.38.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.38.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__debconf_set_selections - Setup debconf selections</p>
</div>
<div class="section" id="description">
<h2>16.38.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.38.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>On Debian and alike systems debconf-set-selections(1) can be used
to setup configuration parameters.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.38.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>file</dt>
<dd>Use the given filename as input for debconf-set-selections(1)
If filename is &quot;-&quot;, read from stdin.</dd>
<h2><span class="section-number">16.38.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>file</dt><dd><p>Use the given filename as input for debconf-set-selections(1)
If filename is &quot;-&quot;, read from stdin.</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>16.38.4. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># Setup configuration for nslcd</span>
<h2><span class="section-number">16.38.4. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Setup configuration for nslcd</span>
__debconf_set_selections nslcd --file /path/to/file
<span class="c1"># Setup configuration for nslcd from another type</span>
@ -400,15 +391,15 @@ __debconf_set_selections nslcd --file - <span class="s">&lt;&lt; eof</span>
</div>
</div>
<div class="section" id="see-also">
<h2>16.38.5. SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.38.5. </span>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<p><strong>debconf-set-selections</strong>(1), <strong>cdist-type__update_alternatives</strong>(7)</p>
</div>
<div class="section" id="authors">
<h2>16.38.6. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.38.6. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Nico Schottelius &lt;<a class="reference external" href="mailto:nico-cdist--&#37;&#52;&#48;--schottelius&#46;org">nico-cdist--<span>&#64;</span>--schottelius<span>&#46;</span>org</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.38.7. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.38.7. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2011-2014 Nico Schottelius. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

127
src/extra/manual/beta/man7/cdist-type__directory.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.39. cdist-type__directory(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.39. cdist-type__directory(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -347,9 +338,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.39. cdist-type__directory(7)</li>
<li><span class="section-number">16.39. </span>cdist-type__directory(7)</li>
<li class="wy-breadcrumbs-aside">
@ -369,79 +360,77 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-directory-7">
<h1>16.39. cdist-type__directory(7)<a class="headerlink" href="#cdist-type-directory-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.39. </span>cdist-type__directory(7)<a class="headerlink" href="#cdist-type-directory-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.39.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.39.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__directory - Manage a directory</p>
</div>
<div class="section" id="description">
<h2>16.39.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.39.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>This cdist type allows you to create or remove directories on the target.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.39.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.39.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<p>None.</p>
</div>
<div class="section" id="optional-parameters">
<h2>16.39.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>state</dt>
<dd><p class="first">'present', 'absent', 'exists' or 'pre-exists', defaults to 'present' where:</p>
<dl class="last docutils">
<dt>present</dt>
<dd>the directory exists and the given attributes are set.</dd>
<dt>absent</dt>
<dd>the directory does not exist.</dd>
<dt>exists</dt>
<dd>the directory exists, but its attributes are not altered if it already
existed.</dd>
<dt>pre-exists</dt>
<dd>check that the directory exists and is indeed a directory, but do not
create or modify it.</dd>
<h2><span class="section-number">16.39.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl>
<dt>state</dt><dd><p>'present', 'absent', 'exists' or 'pre-exists', defaults to 'present' where:</p>
<dl class="simple">
<dt>present</dt><dd><p>the directory exists and the given attributes are set.</p>
</dd>
<dt>absent</dt><dd><p>the directory does not exist.</p>
</dd>
<dt>exists</dt><dd><p>the directory exists, but its attributes are not altered if it already
existed.</p>
</dd>
<dt>pre-exists</dt><dd><p>check that the directory exists and is indeed a directory, but do not
create or modify it.</p>
</dd>
</dl>
</dd>
<dt>group</dt>
<dd>Group to chgrp to.</dd>
<dt>mode</dt>
<dd>Unix permissions, suitable for chmod.</dd>
<dt>owner</dt>
<dd>User to chown to.</dd>
<dt>group</dt><dd><p>Group to chgrp to.</p>
</dd>
<dt>mode</dt><dd><p>Unix permissions, suitable for chmod.</p>
</dd>
<dt>owner</dt><dd><p>User to chown to.</p>
</dd>
</dl>
</div>
<div class="section" id="boolean-parameters">
<h2>16.39.5. BOOLEAN PARAMETERS<a class="headerlink" href="#boolean-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>parents</dt>
<dd><p class="first">Whether to create parents as well (mkdir -p behaviour).
<h2><span class="section-number">16.39.5. </span>BOOLEAN PARAMETERS<a class="headerlink" href="#boolean-parameters" title="Permalink to this headline"></a></h2>
<dl>
<dt>parents</dt><dd><p>Whether to create parents as well (mkdir -p behaviour).
Warning: all intermediate directory permissions default
to whatever mkdir -p does.</p>
<p class="last">Usually this means root:root, 0700.</p>
<p>Usually this means root:root, 0700.</p>
</dd>
<dt>recursive</dt><dd><p>If supplied the chgrp and chown call will run recursively.
This does <em>not</em> influence the behaviour of chmod.</p>
</dd>
<dt>recursive</dt>
<dd>If supplied the chgrp and chown call will run recursively.
This does <em>not</em> influence the behaviour of chmod.</dd>
</dl>
</div>
<div class="section" id="messages">
<h2>16.39.6. MESSAGES<a class="headerlink" href="#messages" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>chgrp &lt;group&gt;</dt>
<dd>Changed group membership</dd>
<dt>chown &lt;owner&gt;</dt>
<dd>Changed owner</dd>
<dt>chmod &lt;mode&gt;</dt>
<dd>Changed mode</dd>
<dt>create</dt>
<dd>Empty directory was created</dd>
<dt>remove</dt>
<dd>Directory exists, but state is absent, directory will be removed by generated code.</dd>
<dt>remove non directory</dt>
<dd>Something other than a directory with the same name exists and was removed prior to create.</dd>
<h2><span class="section-number">16.39.6. </span>MESSAGES<a class="headerlink" href="#messages" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>chgrp &lt;group&gt;</dt><dd><p>Changed group membership</p>
</dd>
<dt>chown &lt;owner&gt;</dt><dd><p>Changed owner</p>
</dd>
<dt>chmod &lt;mode&gt;</dt><dd><p>Changed mode</p>
</dd>
<dt>create</dt><dd><p>Empty directory was created</p>
</dd>
<dt>remove</dt><dd><p>Directory exists, but state is absent, directory will be removed by generated code.</p>
</dd>
<dt>remove non directory</dt><dd><p>Something other than a directory with the same name exists and was removed prior to create.</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>16.39.7. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># A silly example</span>
<h2><span class="section-number">16.39.7. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># A silly example</span>
__directory /tmp/foobar
<span class="c1"># Remove a directory</span>
@ -466,11 +455,11 @@ __directory /home/services/kvm --recursive --parents <span class="se">\</span>
</div>
</div>
<div class="section" id="authors">
<h2>16.39.8. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.39.8. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Nico Schottelius &lt;<a class="reference external" href="mailto:nico-cdist--&#37;&#52;&#48;--schottelius&#46;org">nico-cdist--<span>&#64;</span>--schottelius<span>&#46;</span>org</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.39.9. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.39.9. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2011 Nico Schottelius. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

59
src/extra/manual/beta/man7/cdist-type__docker.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.40. cdist-type__docker(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.40. cdist-type__docker(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -346,9 +337,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.40. cdist-type__docker(7)</li>
<li><span class="section-number">16.40. </span>cdist-type__docker(7)</li>
<li class="wy-breadcrumbs-aside">
@ -368,36 +359,36 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-docker-7">
<h1>16.40. cdist-type__docker(7)<a class="headerlink" href="#cdist-type-docker-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.40. </span>cdist-type__docker(7)<a class="headerlink" href="#cdist-type-docker-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.40.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.40.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__docker - install Docker CE</p>
</div>
<div class="section" id="description">
<h2>16.40.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.40.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Installs latest Docker Community Edition package.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.40.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.40.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<p>None.</p>
</div>
<div class="section" id="optional-parameters">
<h2>16.40.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>state</dt>
<dd>'present' or 'absent', defaults to 'present'</dd>
<dt>version</dt>
<dd>The specific version to install. Defaults to the special value 'latest',
meaning the version the package manager will install by default.</dd>
<h2><span class="section-number">16.40.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>state</dt><dd><p>'present' or 'absent', defaults to 'present'</p>
</dd>
<dt>version</dt><dd><p>The specific version to install. Defaults to the special value 'latest',
meaning the version the package manager will install by default.</p>
</dd>
</dl>
</div>
<div class="section" id="boolean-parameters">
<h2>16.40.5. BOOLEAN PARAMETERS<a class="headerlink" href="#boolean-parameters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.40.5. </span>BOOLEAN PARAMETERS<a class="headerlink" href="#boolean-parameters" title="Permalink to this headline"></a></h2>
<p>None.</p>
</div>
<div class="section" id="examples">
<h2>16.40.6. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># Install docker</span>
<h2><span class="section-number">16.40.6. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Install docker</span>
__docker
<span class="c1"># Remove docker</span>
@ -409,11 +400,11 @@ __docker --state present --version <span class="m">18</span>.03.0.ce
</div>
</div>
<div class="section" id="authors">
<h2>16.40.7. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.40.7. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Steven Armstrong &lt;<a class="reference external" href="mailto:steven-cdist--&#37;&#52;&#48;--armstrong&#46;cc">steven-cdist--<span>&#64;</span>--armstrong<span>&#46;</span>cc</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.40.8. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.40.8. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2016 Steven Armstrong. Free use of this software is
granted under the terms of the GNU General Public License version 3 (GPLv3).</p>
</div>

57
src/extra/manual/beta/man7/cdist-type__docker_compose.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.41. cdist-type__docker_compose(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.41. cdist-type__docker_compose(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -346,9 +337,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.41. cdist-type__docker_compose(7)</li>
<li><span class="section-number">16.41. </span>cdist-type__docker_compose(7)</li>
<li class="wy-breadcrumbs-aside">
@ -368,37 +359,37 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-docker-compose-7">
<h1>16.41. cdist-type__docker_compose(7)<a class="headerlink" href="#cdist-type-docker-compose-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.41. </span>cdist-type__docker_compose(7)<a class="headerlink" href="#cdist-type-docker-compose-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.41.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.41.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__docker_compose - install docker-compose</p>
</div>
<div class="section" id="description">
<h2>16.41.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.41.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Installs docker-compose package.
State 'absent' will not remove docker binary itself,
only docker-compose binary will be removed</p>
</div>
<div class="section" id="required-parameters">
<h2>16.41.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.41.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<p>None.</p>
</div>
<div class="section" id="optional-parameters">
<h2>16.41.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>version</dt>
<dd>Define docker_compose version, defaults to &quot;1.9.0&quot;</dd>
<dt>state</dt>
<dd>'present' or 'absent', defaults to 'present'</dd>
<h2><span class="section-number">16.41.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>version</dt><dd><p>Define docker_compose version, defaults to &quot;1.9.0&quot;</p>
</dd>
<dt>state</dt><dd><p>'present' or 'absent', defaults to 'present'</p>
</dd>
</dl>
</div>
<div class="section" id="boolean-parameters">
<h2>16.41.5. BOOLEAN PARAMETERS<a class="headerlink" href="#boolean-parameters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.41.5. </span>BOOLEAN PARAMETERS<a class="headerlink" href="#boolean-parameters" title="Permalink to this headline"></a></h2>
<p>None.</p>
</div>
<div class="section" id="examples">
<h2>16.41.6. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># Install docker-compose</span>
<h2><span class="section-number">16.41.6. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Install docker-compose</span>
__docker_compose
<span class="c1"># Install version 1.9.0-rc4</span>
@ -410,11 +401,11 @@ __docker_compose --state absent
</div>
</div>
<div class="section" id="authors">
<h2>16.41.7. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.41.7. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Dominique Roux &lt;<a class="reference external" href="mailto:dominique&#46;roux--&#37;&#52;&#48;--ungleich&#46;ch">dominique<span>&#46;</span>roux--<span>&#64;</span>--ungleich<span>&#46;</span>ch</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.41.8. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.41.8. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2016 Dominique Roux. Free use of this software is
granted under the terms of the GNU General Public License version 3 or later (GPLv3+).</p>
</div>

64
src/extra/manual/beta/man7/cdist-type__docker_config.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.42. cdist-type__docker_config(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.42. cdist-type__docker_config(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -345,9 +336,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.42. cdist-type__docker_config(7)</li>
<li><span class="section-number">16.42. </span>cdist-type__docker_config(7)</li>
<li class="wy-breadcrumbs-aside">
@ -367,50 +358,49 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-docker-config-7">
<h1>16.42. cdist-type__docker_config(7)<a class="headerlink" href="#cdist-type-docker-config-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.42. </span>cdist-type__docker_config(7)<a class="headerlink" href="#cdist-type-docker-config-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.42.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.42.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__docker_config - Manage Docker configs</p>
</div>
<div class="section" id="description">
<h2>16.42.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.42.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>This type manages Docker configs.</p>
</div>
<div class="section" id="optional-parameters">
<h2>16.42.3. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>source</dt>
<dd>Path to the source file. If it is '-' (dash), read standard input.</dd>
<dt>state</dt>
<dd><p class="first">'present' or 'absent', defaults to 'present' where:</p>
<dl class="last docutils">
<dt>present</dt>
<dd>if the config does not exist, it is created</dd>
<dt>absent</dt>
<dd>the config is removed</dd>
<h2><span class="section-number">16.42.3. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl>
<dt>source</dt><dd><p>Path to the source file. If it is '-' (dash), read standard input.</p>
</dd>
<dt>state</dt><dd><p>'present' or 'absent', defaults to 'present' where:</p>
<dl class="simple">
<dt>present</dt><dd><p>if the config does not exist, it is created</p>
</dd>
<dt>absent</dt><dd><p>the config is removed</p>
</dd>
</dl>
</dd>
</dl>
</div>
<div class="section" id="caveats">
<h2>16.42.4. CAVEATS<a class="headerlink" href="#caveats" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.42.4. </span>CAVEATS<a class="headerlink" href="#caveats" title="Permalink to this headline"></a></h2>
<p>Since Docker configs cannot be updated once created, this type tries removing
and recreating the config if it changes. If the config is used by a service at
the time of removing, then this type will fail.</p>
</div>
<div class="section" id="examples">
<h2>16.42.5. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># Creates &quot;foo&quot; config from &quot;bar&quot; source file</span>
<h2><span class="section-number">16.42.5. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Creates &quot;foo&quot; config from &quot;bar&quot; source file</span>
__docker_config foo --source bar
</pre></div>
</div>
</div>
<div class="section" id="authors">
<h2>16.42.6. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.42.6. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Ľubomír Kučera &lt;lubomir.kucera.jr at gmail.com&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.42.7. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.42.7. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2018 Ľubomír Kučera. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

64
src/extra/manual/beta/man7/cdist-type__docker_secret.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.43. cdist-type__docker_secret(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.43. cdist-type__docker_secret(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -345,9 +336,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.43. cdist-type__docker_secret(7)</li>
<li><span class="section-number">16.43. </span>cdist-type__docker_secret(7)</li>
<li class="wy-breadcrumbs-aside">
@ -367,49 +358,48 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-docker-secret-7">
<h1>16.43. cdist-type__docker_secret(7)<a class="headerlink" href="#cdist-type-docker-secret-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.43. </span>cdist-type__docker_secret(7)<a class="headerlink" href="#cdist-type-docker-secret-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.43.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.43.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__docker_secret - Manage Docker secrets</p>
</div>
<div class="section" id="description">
<h2>16.43.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.43.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>This type manages Docker secrets.</p>
</div>
<div class="section" id="optional-parameters">
<h2>16.43.3. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>source</dt>
<dd>Path to the source file. If it is '-' (dash), read standard input.</dd>
<dt>state</dt>
<dd><p class="first">'present' or 'absent', defaults to 'present' where:</p>
<dl class="last docutils">
<dt>present</dt>
<dd>if the secret does not exist, it is created</dd>
<dt>absent</dt>
<dd>the secret is removed</dd>
<h2><span class="section-number">16.43.3. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl>
<dt>source</dt><dd><p>Path to the source file. If it is '-' (dash), read standard input.</p>
</dd>
<dt>state</dt><dd><p>'present' or 'absent', defaults to 'present' where:</p>
<dl class="simple">
<dt>present</dt><dd><p>if the secret does not exist, it is created</p>
</dd>
<dt>absent</dt><dd><p>the secret is removed</p>
</dd>
</dl>
</dd>
</dl>
</div>
<div class="section" id="caveats">
<h2>16.43.4. CAVEATS<a class="headerlink" href="#caveats" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.43.4. </span>CAVEATS<a class="headerlink" href="#caveats" title="Permalink to this headline"></a></h2>
<p>Since Docker secrets cannot be updated once created, this type takes no action
if the specified secret already exists.</p>
</div>
<div class="section" id="examples">
<h2>16.43.5. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># Creates &quot;foo&quot; secret from &quot;bar&quot; source file</span>
<h2><span class="section-number">16.43.5. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Creates &quot;foo&quot; secret from &quot;bar&quot; source file</span>
__docker_secret foo --source bar
</pre></div>
</div>
</div>
<div class="section" id="authors">
<h2>16.43.6. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.43.6. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Ľubomír Kučera &lt;lubomir.kucera.jr at gmail.com&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.43.7. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.43.7. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2018 Ľubomír Kučera. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

66
src/extra/manual/beta/man7/cdist-type__docker_stack.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.44. cdist-type__docker_stack(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.44. cdist-type__docker_stack(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -344,9 +335,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.44. cdist-type__docker_stack(7)</li>
<li><span class="section-number">16.44. </span>cdist-type__docker_stack(7)</li>
<li class="wy-breadcrumbs-aside">
@ -366,51 +357,50 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-docker-stack-7">
<h1>16.44. cdist-type__docker_stack(7)<a class="headerlink" href="#cdist-type-docker-stack-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.44. </span>cdist-type__docker_stack(7)<a class="headerlink" href="#cdist-type-docker-stack-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.44.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.44.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__docker_stack - Manage Docker stacks</p>
</div>
<div class="section" id="description">
<h2>16.44.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.44.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>This type manages service stacks.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Since there is no easy way to tell whether a stack needs to be updated,
<p class="admonition-title">Note</p>
<p>Since there is no easy way to tell whether a stack needs to be updated,
<cite>docker stack deploy</cite> is being run every time this type is invoked.
However, it does not mean this type is not idempotent. If Docker does not
detect changes, the existing stack will not be updated.</p>
</div>
</div>
<div class="section" id="optional-parameters">
<h2>16.44.3. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>compose-file</dt>
<dd>Path to the compose file. If it is '-' (dash), read standard input.</dd>
<dt>state</dt>
<dd><p class="first">'present' or 'absent', defaults to 'present' where:</p>
<dl class="last docutils">
<dt>present</dt>
<dd>the stack is deployed</dd>
<dt>absent</dt>
<dd>the stack is removed</dd>
<h2><span class="section-number">16.44.3. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl>
<dt>compose-file</dt><dd><p>Path to the compose file. If it is '-' (dash), read standard input.</p>
</dd>
<dt>state</dt><dd><p>'present' or 'absent', defaults to 'present' where:</p>
<dl class="simple">
<dt>present</dt><dd><p>the stack is deployed</p>
</dd>
<dt>absent</dt><dd><p>the stack is removed</p>
</dd>
</dl>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>16.44.4. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># Deploys &#39;foo&#39; stack defined in &#39;docker-compose.yml&#39; compose file</span>
<h2><span class="section-number">16.44.4. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Deploys &#39;foo&#39; stack defined in &#39;docker-compose.yml&#39; compose file</span>
__docker_stack foo --compose-file docker-compose.yml
</pre></div>
</div>
</div>
<div class="section" id="authors">
<h2>16.44.5. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.44.5. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Ľubomír Kučera &lt;lubomir.kucera.jr at gmail.com&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.44.6. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.44.6. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2018 Ľubomír Kučera. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

58
src/extra/manual/beta/man7/cdist-type__docker_swarm.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.45. cdist-type__docker_swarm(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.45. cdist-type__docker_swarm(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -344,9 +335,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.45. cdist-type__docker_swarm(7)</li>
<li><span class="section-number">16.45. </span>cdist-type__docker_swarm(7)</li>
<li class="wy-breadcrumbs-aside">
@ -366,33 +357,32 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-docker-swarm-7">
<h1>16.45. cdist-type__docker_swarm(7)<a class="headerlink" href="#cdist-type-docker-swarm-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.45. </span>cdist-type__docker_swarm(7)<a class="headerlink" href="#cdist-type-docker-swarm-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.45.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.45.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__docker_swarm - Manage Swarm</p>
</div>
<div class="section" id="description">
<h2>16.45.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.45.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>This type can initialize Docker swarm mode. For more information about swarm
mode, see <a class="reference external" href="https://docs.docker.com/engine/swarm/">Swarm mode overview</a>.</p>
</div>
<div class="section" id="optional-parameters">
<h2>16.45.3. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>state</dt>
<dd><p class="first">'present' or 'absent', defaults to 'present' where:</p>
<dl class="last docutils">
<dt>present</dt>
<dd>Swarm is initialized</dd>
<dt>absent</dt>
<dd>Swarm is left</dd>
<h2><span class="section-number">16.45.3. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl>
<dt>state</dt><dd><p>'present' or 'absent', defaults to 'present' where:</p>
<dl class="simple">
<dt>present</dt><dd><p>Swarm is initialized</p>
</dd>
<dt>absent</dt><dd><p>Swarm is left</p>
</dd>
</dl>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>16.45.4. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># Initializes a swarm</span>
<h2><span class="section-number">16.45.4. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Initializes a swarm</span>
__docker_swarm
<span class="c1"># Leaves a swarm</span>
@ -401,11 +391,11 @@ __docker_swarm --state absent
</div>
</div>
<div class="section" id="authors">
<h2>16.45.5. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.45.5. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Ľubomír Kučera &lt;lubomir.kucera.jr at gmail.com&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.45.6. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.45.6. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2018 Ľubomír Kučera. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

56
src/extra/manual/beta/man7/cdist-type__dog_vdi.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.46. cdist-type__dog_vdi(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.46. cdist-type__dog_vdi(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -345,9 +336,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.46. cdist-type__dog_vdi(7)</li>
<li><span class="section-number">16.46. </span>cdist-type__dog_vdi(7)</li>
<li class="wy-breadcrumbs-aside">
@ -367,30 +358,29 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-dog-vdi-7">
<h1>16.46. cdist-type__dog_vdi(7)<a class="headerlink" href="#cdist-type-dog-vdi-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.46. </span>cdist-type__dog_vdi(7)<a class="headerlink" href="#cdist-type-dog-vdi-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.46.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.46.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__dog_vdi - Manage Sheepdog VM images</p>
</div>
<div class="section" id="description">
<h2>16.46.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.46.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>The dog program is used to create images for sheepdog
to be used in qemu.</p>
</div>
<div class="section" id="optional-parameters">
<h2>16.46.3. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>state</dt>
<dd>Either &quot;present&quot; or &quot;absent&quot;, defaults to &quot;present&quot;</dd>
<dt>size</dt>
<dd><p class="first">Size of the image in &quot;dog vdi&quot; compatible units.</p>
<p class="last">Required if state is &quot;present&quot;.</p>
<h2><span class="section-number">16.46.3. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl>
<dt>state</dt><dd><p>Either &quot;present&quot; or &quot;absent&quot;, defaults to &quot;present&quot;</p>
</dd>
<dt>size</dt><dd><p>Size of the image in &quot;dog vdi&quot; compatible units.</p>
<p>Required if state is &quot;present&quot;.</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>16.46.4. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># Create a 50G size image</span>
<h2><span class="section-number">16.46.4. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Create a 50G size image</span>
__dog_vdi nico-privat.sky.ungleich.ch --size 50G
<span class="c1"># Create a 50G size image (more explicit)</span>
@ -405,15 +395,15 @@ __dog_vdi nico-privat.sky.ungleich.ch --size 50G --state absent
</div>
</div>
<div class="section" id="see-also">
<h2>16.46.5. SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.46.5. </span>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<p><strong>qemu</strong>(1), <strong>dog</strong>(8)</p>
</div>
<div class="section" id="authors">
<h2>16.46.6. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.46.6. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Nico Schottelius &lt;<a class="reference external" href="mailto:nico-cdist--&#37;&#52;&#48;--schottelius&#46;org">nico-cdist--<span>&#64;</span>--schottelius<span>&#46;</span>org</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.46.7. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.46.7. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2014 Nico Schottelius. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

67
src/extra/manual/beta/man7/cdist-type__dot_file.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.47. cdist-type__dot_file(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.47. cdist-type__dot_file(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -346,9 +337,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.47. cdist-type__dot_file(7)</li>
<li><span class="section-number">16.47. </span>cdist-type__dot_file(7)</li>
<li class="wy-breadcrumbs-aside">
@ -368,13 +359,13 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-dot-file-7">
<h1>16.47. cdist-type__dot_file(7)<a class="headerlink" href="#cdist-type-dot-file-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.47. </span>cdist-type__dot_file(7)<a class="headerlink" href="#cdist-type-dot-file-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.47.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.47.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__dot_file - install file under user's home directory</p>
</div>
<div class="section" id="description">
<h2>16.47.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.47.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>This type installs a file (=<em>__object_id</em>) under user's home directory,
providing a way to install per-user configuration files. File owner
and group is deduced from user, for who file is installed.</p>
@ -382,31 +373,31 @@ and group is deduced from user, for who file is installed.</p>
where user's home directory is.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.47.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>user</dt>
<dd>User, for who file is installed</dd>
<h2><span class="section-number">16.47.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>user</dt><dd><p>User, for who file is installed</p>
</dd>
</dl>
</div>
<div class="section" id="optional-parameters">
<h2>16.47.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>mode</dt>
<dd>forwarded to <strong>__file</strong> type</dd>
<dt>state</dt>
<dd>forwarded to <strong>__file</strong> type</dd>
<dt>source</dt>
<dd>forwarded to <strong>__file</strong> type</dd>
<h2><span class="section-number">16.47.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>mode</dt><dd><p>forwarded to <strong>__file</strong> type</p>
</dd>
<dt>state</dt><dd><p>forwarded to <strong>__file</strong> type</p>
</dd>
<dt>source</dt><dd><p>forwarded to <strong>__file</strong> type</p>
</dd>
</dl>
</div>
<div class="section" id="messages">
<h2>16.47.5. MESSAGES<a class="headerlink" href="#messages" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.47.5. </span>MESSAGES<a class="headerlink" href="#messages" title="Permalink to this headline"></a></h2>
<p>This type inherits all messages from <strong>file</strong> type, and do not add
any new.</p>
</div>
<div class="section" id="examples">
<h2>16.47.6. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># Install .forward file for user &#39;alice&#39;. Since state is &#39;present&#39;,</span>
<h2><span class="section-number">16.47.6. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Install .forward file for user &#39;alice&#39;. Since state is &#39;present&#39;,</span>
<span class="c1"># user is not meant to edit this file, all changes will be overridden.</span>
<span class="c1"># It is good idea to put warning about it in file itself.</span>
__dot_file .forward --user alice --source <span class="s2">&quot;</span><span class="nv">$__files</span><span class="s2">/forward&quot;</span>
@ -422,11 +413,11 @@ __dot_file .xmonad/xmonad.hs --user eve --state exists --source <span class="s2"
</div>
</div>
<div class="section" id="see-also">
<h2>16.47.7. SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.47.7. </span>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<p><strong>cdist-type__file</strong>(7)</p>
</div>
<div class="section" id="copying">
<h2>16.47.8. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.47.8. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2015 Dmitry Bogatov. Free use of this software is granted
under the terms of the GNU General Public License version 3 or later
(GPLv3+).</p>

141
src/extra/manual/beta/man7/cdist-type__file_old.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.48. cdist-type__file(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.48. cdist-type__file(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -346,9 +337,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.48. cdist-type__file(7)</li>
<li><span class="section-number">16.48. </span>cdist-type__file(7)</li>
<li class="wy-breadcrumbs-aside">
@ -368,29 +359,28 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-file-7">
<h1>16.48. cdist-type__file(7)<a class="headerlink" href="#cdist-type-file-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.48. </span>cdist-type__file(7)<a class="headerlink" href="#cdist-type-file-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.48.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.48.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__file - Manage files.</p>
</div>
<div class="section" id="description">
<h2>16.48.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.48.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>This cdist type allows you to create files, remove files and set file
attributes on the target.</p>
<p>If the file already exists on the target, then if it is a:</p>
<dl class="docutils">
<dt>regular file, and state is:</dt>
<dd><dl class="first last docutils">
<dt>present</dt>
<dd>replace it with the source file if they are not equal</dd>
<dt>exists</dt>
<dd>do nothing</dd>
<dl class="simple">
<dt>regular file, and state is:</dt><dd><dl class="simple">
<dt>present</dt><dd><p>replace it with the source file if they are not equal</p>
</dd>
<dt>exists</dt><dd><p>do nothing</p>
</dd>
</dl>
</dd>
<dt>symlink</dt>
<dd>replace it with the source file</dd>
<dt>directory</dt>
<dd>replace it with the source file</dd>
<dt>symlink</dt><dd><p>replace it with the source file</p>
</dd>
<dt>directory</dt><dd><p>replace it with the source file</p>
</dd>
</dl>
<p>One exception is that when state is pre-exists, an error is raised if
the file would have been created otherwise (e.g. it is not present or
@ -398,60 +388,59 @@ not a regular file).</p>
<p>In any case, make sure that the file attributes are as specified.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.48.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.48.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<p>None.</p>
</div>
<div class="section" id="optional-parameters">
<h2>16.48.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>state</dt>
<dd><p class="first">'present', 'absent', 'exists' or 'pre-exists', defaults to 'present' where:</p>
<dl class="last docutils">
<dt>present</dt>
<dd>the file is exactly the one from source</dd>
<dt>absent</dt>
<dd>the file does not exist</dd>
<dt>exists</dt>
<dd>the file from source but only if it doesn't already exist</dd>
<dt>pre-exists</dt>
<dd>check that the file exists and is a regular file, but do not
create or modify it</dd>
<h2><span class="section-number">16.48.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl>
<dt>state</dt><dd><p>'present', 'absent', 'exists' or 'pre-exists', defaults to 'present' where:</p>
<dl class="simple">
<dt>present</dt><dd><p>the file is exactly the one from source</p>
</dd>
<dt>absent</dt><dd><p>the file does not exist</p>
</dd>
<dt>exists</dt><dd><p>the file from source but only if it doesn't already exist</p>
</dd>
<dt>pre-exists</dt><dd><p>check that the file exists and is a regular file, but do not
create or modify it</p>
</dd>
</dl>
</dd>
<dt>group</dt>
<dd>Group to chgrp to. Defaults to <code class="docutils literal"><span class="pre">root</span></code>.</dd>
<dt>mode</dt>
<dd>Unix permissions, suitable for chmod. Defaults to a very secure <code class="docutils literal"><span class="pre">0600</span></code>.</dd>
<dt>owner</dt>
<dd>User to chown to. Defaults to <code class="docutils literal"><span class="pre">root</span></code>.</dd>
<dt>source</dt>
<dd>If supplied, copy this file from the host running cdist to the target.
<dt>group</dt><dd><p>Group to chgrp to. Defaults to <code class="docutils literal notranslate"><span class="pre">root</span></code>.</p>
</dd>
<dt>mode</dt><dd><p>Unix permissions, suitable for chmod. Defaults to a very secure <code class="docutils literal notranslate"><span class="pre">0600</span></code>.</p>
</dd>
<dt>owner</dt><dd><p>User to chown to. Defaults to <code class="docutils literal notranslate"><span class="pre">root</span></code>.</p>
</dd>
<dt>source</dt><dd><p>If supplied, copy this file from the host running cdist to the target.
If not supplied, an empty file or directory will be created.
If source is '-' (dash), take what was written to stdin as the file content.</dd>
<dt>onchange</dt>
<dd>The code to run if file is modified.</dd>
If source is '-' (dash), take what was written to stdin as the file content.</p>
</dd>
<dt>onchange</dt><dd><p>The code to run if file is modified.</p>
</dd>
</dl>
</div>
<div class="section" id="messages">
<h2>16.48.5. MESSAGES<a class="headerlink" href="#messages" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>chgrp &lt;group&gt;</dt>
<dd>Changed group membership</dd>
<dt>chown &lt;owner&gt;</dt>
<dd>Changed owner</dd>
<dt>chmod &lt;mode&gt;</dt>
<dd>Changed mode</dd>
<dt>create</dt>
<dd>Empty file was created (no --source specified)</dd>
<dt>remove</dt>
<dd>File exists, but state is absent, file will be removed by generated code.</dd>
<dt>upload</dt>
<dd>File was uploaded</dd>
<h2><span class="section-number">16.48.5. </span>MESSAGES<a class="headerlink" href="#messages" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>chgrp &lt;group&gt;</dt><dd><p>Changed group membership</p>
</dd>
<dt>chown &lt;owner&gt;</dt><dd><p>Changed owner</p>
</dd>
<dt>chmod &lt;mode&gt;</dt><dd><p>Changed mode</p>
</dd>
<dt>create</dt><dd><p>Empty file was created (no --source specified)</p>
</dd>
<dt>remove</dt><dd><p>File exists, but state is absent, file will be removed by generated code.</p>
</dd>
<dt>upload</dt><dd><p>File was uploaded</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>16.48.6. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># Create /etc/cdist-configured as an empty file</span>
<h2><span class="section-number">16.48.6. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Create /etc/cdist-configured as an empty file</span>
__file /etc/cdist-configured
<span class="c1"># The same thing</span>
__file /etc/cdist-configured --state present
@ -477,11 +466,11 @@ __file /tmp/whatever --owner root --group root --mode <span class="m">644</span>
</div>
</div>
<div class="section" id="authors">
<h2>16.48.7. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.48.7. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Nico Schottelius &lt;<a class="reference external" href="mailto:nico-cdist--&#37;&#52;&#48;--schottelius&#46;org">nico-cdist--<span>&#64;</span>--schottelius<span>&#46;</span>org</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.48.8. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.48.8. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2011-2013 Nico Schottelius. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the

84
src/extra/manual/beta/man7/cdist-type__filesystem.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.49. cdist-type__filesystem(7) &mdash; cdist 6.5.6 documentation</title>
<title>16.49. cdist-type__filesystem(7) &mdash; cdist 6.6.0 documentation</title>
@ -20,20 +20,11 @@
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.5.6',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
@ -72,7 +63,7 @@
<div class="version">
6.5.6
6.6.0
</div>
@ -347,9 +338,9 @@
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../cdist-types.html">16. cdist types</a> &raquo;</li>
<li><a href="../cdist-types.html"><span class="section-number">16. </span>cdist types</a> &raquo;</li>
<li>16.49. cdist-type__filesystem(7)</li>
<li><span class="section-number">16.49. </span>cdist-type__filesystem(7)</li>
<li class="wy-breadcrumbs-aside">
@ -369,13 +360,13 @@
<div itemprop="articleBody">
<div class="section" id="cdist-type-filesystem-7">
<h1>16.49. cdist-type__filesystem(7)<a class="headerlink" href="#cdist-type-filesystem-7" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">16.49. </span>cdist-type__filesystem(7)<a class="headerlink" href="#cdist-type-filesystem-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<h2>16.49.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.49.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist-type__filesystem - Create Filesystems.</p>
</div>
<div class="section" id="description">
<h2>16.49.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.49.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>This cdist type allows you to create filesystems on devices.</p>
<p>If the device is mounted on target, it refuses to do anything.</p>
<p>If the device has a filesystem other then the specified and/or
@ -383,19 +374,18 @@ the label is not correct, it only makes a new filesystem
if you have specified --force option.</p>
</div>
<div class="section" id="required-parameters">
<h2>16.49.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>fstype</dt>
<dd>Filesystem type, for example 'ext3', 'btrfs' or 'xfs'.</dd>
<h2><span class="section-number">16.49.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>fstype</dt><dd><p>Filesystem type, for example 'ext3', 'btrfs' or 'xfs'.</p>
</dd>
</dl>
</div>
<div class="section" id="optional-parameters">
<h2>16.49.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>device</dt>
<dd><p class="first">Blockdevice for filesystem, Defaults to object_id.
<h2><span class="section-number">16.49.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl>
<dt>device</dt><dd><p>Blockdevice for filesystem, Defaults to object_id.
On linux, it can be any lsblk accepted device notation.</p>
<div class="last line-block">
<div class="line-block">
<div class="line"><br /></div>
<div class="line">For example:</div>
<div class="line-block">
@ -405,32 +395,32 @@ On linux, it can be any lsblk accepted device notation.</p>
</div>
</div>
</dd>
<dt>label</dt>
<dd>Label which should be applied on the filesystem.</dd>
<dt>mkfsoptions</dt>
<dd>Additional options which are inserted to the mkfs.xxx call.</dd>
<dt>label</dt><dd><p>Label which should be applied on the filesystem.</p>
</dd>
<dt>mkfsoptions</dt><dd><p>Additional options which are inserted to the mkfs.xxx call.</p>
</dd>
</dl>
</div>
<div class="section" id="boolean-parameters">
<h2>16.49.5. BOOLEAN PARAMETERS<a class="headerlink" href="#boolean-parameters" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>force</dt>
<dd>Normally, this type does nothing if a filesystem is found
<h2><span class="section-number">16.49.5. </span>BOOLEAN PARAMETERS<a class="headerlink" href="#boolean-parameters" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>force</dt><dd><p>Normally, this type does nothing if a filesystem is found
on the target device. If you specify force, it's formatted
if the filesystem type or label differs from parameters.
Warning: This option can easily lead into data loss!</dd>
Warning: This option can easily lead into data loss!</p>
</dd>
</dl>
</div>
<div class="section" id="messages">
<h2>16.49.6. MESSAGES<a class="headerlink" href="#messages" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>filesystem &lt;fstype&gt; on &lt;device&gt; <span class="classifier-delimiter">:</span> <span class="classifier">&lt;discoverd device&gt; created</span></dt>
<dd>Filesystem was created on &lt;discoverd device&gt;</dd>
<h2><span class="section-number">16.49.6. </span>MESSAGES<a class="headerlink" href="#messages" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>filesystem &lt;fstype&gt; on &lt;device&gt;<span class="classifier">&lt;discoverd device&gt; created</span></dt><dd><p>Filesystem was created on &lt;discoverd device&gt;</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
<h2>16.49.7. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># Ensures that device /dev/sdb is formatted with xfs</span>
<h2><span class="section-number">16.49.7. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Ensures that device /dev/sdb is formatted with xfs</span>
__filesystem /dev/sdb --fstype xfs --label Testdisk1
<span class="c1"># The same thing with btrfs and disk spezified by pci path to disk 1:0 on vmware</span>
__filesystem dev_sdb --fstype btrfs --device /dev/disk/by-path/pci-0000:0b:00.0-scsi-0:0:0:0 --label Testdisk2
@ -440,11 +430,11 @@ __filesystem dev_sdb --fstype xfs --device /dev/mapper/360060e80432f560050202f22
</div>
</div>
<div class="section" id="authors">
<h2>16.49.8. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.49.8. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Daniel Heule &lt;<a class="reference external" href="mailto:hda--&#37;&#52;&#48;--sfs&#46;biz">hda--<span>&#64;</span>--sfs<span>&#46;</span>biz</a>&gt;</p>
</div>
<div class="section" id="copying">
<h2>16.49.9. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">16.49.9. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2016 Daniel Heule. Free use of this software is
granted under the terms of the GNU General Public License version 3 or any later version (GPLv3+).</p>
</div>

Some files were not shown because too many files have changed in this diff Show More