Update cdist beta docs

This commit is contained in:
Darko Poljak 2021-04-20 07:50:28 +02:00
parent ca3bd79543
commit 5f5afffaac
215 changed files with 6450 additions and 4412 deletions

View file

@ -61,6 +61,14 @@ Object cache overview
~~~~~~~~~~~~~~~~~~~~~
Each object under :strong:`object` directory has its own structure.
autorequire
file containing a list of object auto requirements
children
file containing a list of object children, i.e. objects of types that this
type reuses (along with 'parents' it is used for maintaining parent-child
relationship graph)
code-local
code generated from gencode-local, present only if something is
generated
@ -80,6 +88,15 @@ parameter
directory containing type parameter named files containing parameter
values
parents
file containing a list of object parents, i.e. objects of types that reuse
this type (along with 'children' it is used for maintaining parent-child
relationship graph); objects without parents are objects specified in init
manifest
require
file containing a list of object requirements
source
this type's source (init manifest)

View file

@ -8,9 +8,6 @@ cdist-type__download - Download a file
DESCRIPTION
-----------
Destination (``$__object_id``) in target host must be persistent storage
in order to calculate checksum and decide if file must be (re-)downloaded.
By default type will try to use ``wget``, ``curl`` or ``fetch``.
If download happens in target (see ``--download``) then type will
fallback to (and install) ``wget``.
@ -25,14 +22,14 @@ REQUIRED PARAMETERS
url
File's URL.
sum
Checksum of file going to be downloaded.
By default output of ``cksum`` without filename is expected.
Other hash formats supported with prefixes: ``md5:``, ``sha1:`` and ``sha256:``.
OPTIONAL PARAMETERS
-------------------
sum
Checksum is used to decide if existing destination file must be redownloaded.
By default output of ``cksum`` without filename is expected.
Other hash formats supported with prefixes: ``md5:``, ``sha1:`` and ``sha256:``.
download
If ``local`` (default), then download file to local storage and copy
it to target host. If ``remote``, then download happens in target.
@ -81,7 +78,7 @@ Ander Punnar <ander-at-kvlt-dot-ee>
COPYING
-------
Copyright \(C) 2020 Ander Punnar. You can redistribute it
Copyright \(C) 2021 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 later version.

View file

@ -61,7 +61,7 @@ EXAMPLES
__pyvenv /home/foo/fooenv --pyvenv /usr/local/bin/pyvenv-3.4
# Create python virtualenv for user foo.
__pyvenv /home/foo/fooenv --group foo --user foo
__pyvenv /home/foo/fooenv --group foo --owner foo
# Create python virtualenv with specific parameters.
__pyvenv /home/services/djangoenv --venvparams "--copies --system-site-packages"

View file

@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- basic theme.
*
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/

View file

@ -4,7 +4,7 @@
*
* Sphinx JavaScript utilities for all documentation.
*
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@ -29,9 +29,14 @@ if (!window.console || !console.firebug) {
/**
* small helper function to urldecode strings
*
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
*/
jQuery.urldecode = function(x) {
return decodeURIComponent(x).replace(/\+/g, ' ');
if (!x) {
return x
}
return decodeURIComponent(x.replace(/\+/g, ' '));
};
/**

View file

@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '6.9.5',
VERSION: '6.9.6',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
BUILDER: 'html',

View file

@ -5,7 +5,7 @@
* 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.
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@ -13,7 +13,8 @@
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 */
/* Non-minified version is copied as a separate JS file, is available */
/**
* Porter Stemmer
*/
@ -199,7 +200,6 @@ var Stemmer = function() {
var splitChars = (function() {
var result = {};
var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648,

View file

@ -4,7 +4,7 @@
*
* Sphinx JavaScript utilities for the full-text search.
*
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@ -248,7 +248,7 @@ var Search = {
// results left, load the summary and display it
if (results.length) {
var item = results.pop();
var listItem = $('<li style="display:none"></li>');
var listItem = $('<li></li>');
var requestUrl = "";
var linkUrl = "";
if (DOCUMENTATION_OPTIONS.BUILDER === 'dirhtml') {
@ -273,9 +273,9 @@ var Search = {
if (item[3]) {
listItem.append($('<span> (' + item[3] + ')</span>'));
Search.output.append(listItem);
listItem.slideDown(5, function() {
setTimeout(function() {
displayNextItem();
});
}, 5);
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
$.ajax({url: requestUrl,
dataType: "text",
@ -285,16 +285,16 @@ var Search = {
listItem.append(Search.makeSearchSummary(data, searchterms, hlterms));
}
Search.output.append(listItem);
listItem.slideDown(5, function() {
setTimeout(function() {
displayNextItem();
});
}, 5);
}});
} else {
// no source available, just display title
Search.output.append(listItem);
listItem.slideDown(5, function() {
setTimeout(function() {
displayNextItem();
});
}, 5);
}
}
// search finished, update title and status message
@ -379,6 +379,13 @@ var Search = {
return results;
},
/**
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
*/
escapeRegExp : function(string) {
return string.replace(/[.*+\-?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
},
/**
* search for full-text terms in the index
*/
@ -402,13 +409,14 @@ var Search = {
];
// add support for partial matches
if (word.length > 2) {
var word_regex = this.escapeRegExp(word);
for (var w in terms) {
if (w.match(word) && !terms[word]) {
if (w.match(word_regex) && !terms[word]) {
_o.push({files: terms[w], score: Scorer.partialTerm})
}
}
for (var w in titleterms) {
if (w.match(word) && !titleterms[word]) {
if (w.match(word_regex) && !titleterms[word]) {
_o.push({files: titleterms[w], score: Scorer.partialTitle})
}
}

File diff suppressed because it is too large Load diff

File diff suppressed because one or more lines are too long

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>25. Best practice &mdash; cdist 6.9.5 documentation</title>
<title>25. Best practice &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -199,17 +199,17 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="best-practice">
<section id="best-practice">
<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">
<section id="passwordless-connections">
<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">
</section>
<section id="speeding-up-ssh-connections">
<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
@ -222,16 +222,16 @@ ControlPersist=2h</cite>).</p>
<p>Note that the sshd_config on the server can configure the maximum number of
parallel multiplexed connections this with <cite>MaxSessions N</cite> (N defaults to 10
for OpenSSH v7.4).</p>
</div>
<div class="section" id="speeding-up-shell-execution">
</section>
<section id="speeding-up-shell-execution">
<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 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">
</section>
<section id="multi-master-or-environment-setups">
<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
@ -256,8 +256,8 @@ you can clone it multiple times:</p>
<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">
</section>
<section id="separating-work-by-groups">
<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
@ -269,8 +269,8 @@ their manifests. You can use the following snippet in
<span class="n">sh</span> <span class="o">-</span><span class="n">e</span> <span class="s2">&quot;$__manifest/cbrg&quot;</span>
</pre></div>
</div>
</div>
<div class="section" id="maintaining-multiple-configurations">
</section>
<section id="maintaining-multiple-configurations">
<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.
@ -328,8 +328,8 @@ Including a possible common base that is reused across the different sites:</p>
</pre></div>
</div>
<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">
</section>
<section id="multiple-developers-with-different-trust">
<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
@ -348,8 +348,8 @@ implement this scenario with a gateway host and sudo:</p>
</li>
</ul>
<p>For more details consult sudoers(5)</p>
</div>
<div class="section" id="templating">
</section>
<section id="templating">
<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><p>create directory files/ in your type (convention)</p></li>
@ -386,8 +386,8 @@ cat <span class="s">&lt;&lt; EOF</span>
<span class="go"> --source &quot;$__object/files/basic.conf&quot;</span>
</pre></div>
</div>
</div>
<div class="section" id="testing-a-new-type">
</section>
<section id="testing-a-new-type">
<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
@ -405,8 +405,8 @@ of cdist:</p>
cdist config --initial-manifest - cdist-dev-01.ungleich.ch
</pre></div>
</div>
</div>
<div class="section" id="other-content-in-cdist-repository">
</section>
<section id="other-content-in-cdist-repository">
<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
@ -418,8 +418,8 @@ in the repository for such content: It allows you to
easily distinguish what is used by cdist and what is not
and also to store all important files in one
repository.</p>
</div>
<div class="section" id="notes-on-cdist-order-dependency">
</section>
<section id="notes-on-cdist-order-dependency">
<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
@ -427,7 +427,7 @@ on the previously created object.</p>
<p>It essentially helps you to build up blocks of code that build upon each other
(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">
<section id="cdist-order-dependency-kills-parallelization">
<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>
@ -460,9 +460,9 @@ __file /tmp/file3
<span class="nb">unset</span> CDIST_ORDER_DEPENDENCY
</pre></div>
</div>
</div>
</div>
</div>
</section>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>12. Bootstrap &mdash; cdist 6.9.5 documentation</title>
<title>12. Bootstrap &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -189,12 +189,12 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="bootstrap">
<section id="bootstrap">
<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">
<section id="location">
<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
@ -207,8 +207,8 @@ relies on is recommended, for use as backup as well as to allow easy collaborati
with others.</p>
<p>For more sophisticated setups developing cdist configurations with multiple
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">
</section>
<section id="setup-working-directory-and-branch">
<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).
@ -255,8 +255,8 @@ ethz-systems, localch, customerX, ... But this is pretty much up to you.</p>
</pre></div>
</div>
<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">
</section>
<section id="publishing-the-configuration">
<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
@ -283,8 +283,8 @@ reachable via ssh and has git installed:</p>
<p>Now you have setup the git repository to synchronise the <strong>mycompany</strong>
branch with the <strong>master</strong> branch on the host <strong>loch</strong>. Thus you can commit
as usual in your branch and push out changes by entering <strong>git push</strong>.</p>
</div>
<div class="section" id="updating-from-origin">
</section>
<section id="updating-from-origin">
<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 notranslate"><div class="highlight"><pre><span></span><span class="c1"># Update git repository with latest changes from origin</span>
@ -297,8 +297,8 @@ as usual in your branch and push out changes by entering <strong>git push</stron
<span class="n">cdist</span><span class="o">%</span> <span class="n">git</span> <span class="n">merge</span> <span class="n">origin</span><span class="o">/</span><span class="mf">2.0</span>
</pre></div>
</div>
</div>
</div>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>27. Local cache overview &mdash; cdist 6.9.5 documentation</title>
<title>27. Local cache overview &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -190,9 +190,9 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="local-cache-overview">
<section id="local-cache-overview">
<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">
<section id="description">
<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.
@ -205,8 +205,8 @@ configuration option or by using <strong>CDIST_CACHE_PATH_PATTERN</strong>
environment variable.</p>
<p>For more info on cache path pattern see <strong>CACHE PATH PATTERN FORMAT</strong>
section in cdist man page.</p>
</div>
<div class="section" id="cache-overview">
</section>
<section id="cache-overview">
<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>
@ -235,10 +235,16 @@ cdist</p>
<dt>typeorder</dt><dd><p>file containing types in order of execution.</p>
</dd>
</dl>
<div class="section" id="object-cache-overview">
<section id="object-cache-overview">
<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>autorequire</dt><dd><p>file containing a list of object auto requirements</p>
</dd>
<dt>children</dt><dd><p>file containing a list of object children, i.e. objects of types that this
type reuses (along with 'parents' it is used for maintaining parent-child
relationship graph)</p>
</dd>
<dt>code-local</dt><dd><p>code generated from gencode-local, present only if something is
generated</p>
</dd>
@ -253,6 +259,13 @@ after running on target host</p>
<dt>parameter</dt><dd><p>directory containing type parameter named files containing parameter
values</p>
</dd>
<dt>parents</dt><dd><p>file containing a list of object parents, i.e. objects of types that reuse
this type (along with 'children' it is used for maintaining parent-child
relationship graph); objects without parents are objects specified in init
manifest</p>
</dd>
<dt>require</dt><dd><p>file containing a list of object requirements</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>
@ -266,9 +279,9 @@ outputs</p>
outputs.</p>
</dd>
</dl>
</div>
</div>
</div>
</section>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>13. Configuration &mdash; cdist 6.9.5 documentation</title>
<title>13. Configuration &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -187,9 +187,9 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="configuration">
<section id="configuration">
<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">
<section id="description">
<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>
@ -215,8 +215,8 @@ then ~/.cdist.cfg is used.</p>
<p>For a per-project configuration, particular environment variables or better,
CDIST_CONFIG_FILE environment variable or -g CONFIG_FILE command line option,
can be used.</p>
</div>
<div class="section" id="config-file-format">
</section>
<section id="config-file-format">
<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>
@ -307,8 +307,8 @@ only [GLOBAL] section.</p>
<span class="c1"># verbosity = INFO</span>
</pre></div>
</div>
</div>
</div>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>17. Explorer &mdash; cdist 6.9.5 documentation</title>
<title>17. Explorer &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -187,9 +187,9 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="explorer">
<section id="explorer">
<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">
<section id="description">
<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
@ -212,8 +212,8 @@ the type specific below the object.</p>
error message on stderr, which will cause cdist to abort.</p>
<p>You can also use stderr for debugging purposes while developing a new
explorer.</p>
</div>
<div class="section" id="examples">
</section>
<section id="examples">
<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 notranslate"><div class="highlight"><pre><span></span><span class="n">hostname</span>
@ -231,8 +231,8 @@ explorer.</p>
dpkg -s <span class="s2">&quot;</span><span class="nv">$name</span><span class="s2">&quot;</span> <span class="m">2</span>&gt;/dev/null <span class="o">||</span> <span class="nb">exit</span> <span class="m">0</span>
</pre></div>
</div>
</div>
</div>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>2. Features &mdash; cdist 6.9.5 documentation</title>
<title>2. Features &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -183,7 +183,7 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="features">
<section id="features">
<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="simple">
@ -221,7 +221,7 @@ Batteries included: A lot of requirements can be solved using standard types</p>
<dt>UNIX, simplicity, familiar environment</dt><dd><p>cdist is configured in POSIX shell</p>
</dd>
</dl>
</div>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>30. Hacking &mdash; cdist 6.9.5 documentation</title>
<title>30. Hacking &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -191,9 +191,9 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="hacking">
<section id="hacking">
<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">
<section id="welcome">
<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>
@ -201,20 +201,20 @@ get into the usable configuration management system, cdist.</p>
you by people who care about how code looks like and who think
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">
</section>
<section id="reporting-bugs">
<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">
</section>
<section id="coding-conventions-everywhere">
<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">
</section>
<section id="how-to-submit-stuff-for-inclusion-into-upstream-cdist">
<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>
@ -241,8 +241,8 @@ the other needs to be improved.</p></li>
<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">
</section>
<section id="how-to-submit-a-new-type">
<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
@ -253,8 +253,8 @@ AND the manpage builds (<cite>make man</cite>).</p>
<strong>gencode</strong> will not be accepted, because they are of no use. Every type can output
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">
</section>
<section id="example-git-workflow">
<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 notranslate"><div class="highlight"><pre><span></span><span class="c1"># get latest upstream master branch</span>
@ -326,8 +326,8 @@ git merge origin/master</p>
</div></blockquote>
<p>(you can repeat the code above for as many features as you want to develop
in parallel)</p>
</div>
</div>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>4. How to install cdist &mdash; cdist 6.9.5 documentation</title>
<title>4. How to install cdist &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -200,11 +200,11 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="how-to-install-cdist">
<section id="how-to-install-cdist">
<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">
<section id="requirements">
<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">
<section id="source-host">
<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>
@ -215,8 +215,8 @@
<li><p>sphinx (for building html docs and/or the man pages)</p></li>
</ul>
</div></blockquote>
</div>
<div class="section" id="target-hosts">
</section>
<section id="target-hosts">
<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">
@ -224,11 +224,11 @@
<li><p>SSH server</p></li>
</ul>
</div></blockquote>
</div>
</div>
<div class="section" id="install-cdist">
</section>
</section>
<section id="install-cdist">
<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">
<section id="from-git">
<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
@ -262,7 +262,7 @@ Or directly with distutils:</p>
</pre></div>
</div>
<p>Note that <cite>bin/cdist-build-helper</cite> script is intended for cdist maintainers.</p>
<div class="section" id="available-versions-in-git">
<section id="available-versions-in-git">
<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">
@ -280,8 +280,8 @@ git checkout -b &lt;localbranchname&gt; origin/&lt;branchname&gt;
<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">
</section>
<section id="building-and-using-documentation-man-and-html">
<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 notranslate"><div class="highlight"><pre><span></span>make docs
@ -318,17 +318,17 @@ some other custom .cdist directory, e.g. /opt/cdist then use:</p>
</div>
<p>Note that <cite>dotman</cite>-target has to be built before a <cite>make docs</cite>-run, otherwise
the custom man-pages are not picked up.</p>
</div>
</div>
<div class="section" id="python-package">
</section>
</section>
<section id="python-package">
<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 notranslate"><div class="highlight"><pre><span></span>pip install cdist
</pre></div>
</div>
</div>
<div class="section" id="installing-from-source-with-signature-verification">
</section>
<section id="installing-from-source-with-signature-verification">
<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>
@ -345,9 +345,9 @@ gpg: Good signature from <span class="s2">&quot;ungleich GmbH (ungleich FOSS) &l
</pre></div>
</div>
<p>Further steps are the same as for <a class="reference external" href="cdist-install.html#from-git">installing from git</a>.</p>
</div>
</div>
</div>
</section>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>23. cdist integration / using cdist as library &mdash; cdist 6.9.5 documentation</title>
<title>23. cdist integration / using cdist as library &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -187,9 +187,9 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cdist-integration-using-cdist-as-library">
<section id="cdist-integration-using-cdist-as-library">
<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">
<section id="description">
<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
@ -208,8 +208,8 @@ path to cdist executable, if it is <cite>None</cite> then functions will try to
find it first from local lib directory and then in PATH.</p>
<p>In case of cdist error <strong>cdist.Error</strong> exception is raised.</p>
<p><strong>WARNING</strong>: cdist integration helper functions are not yet stable!</p>
</div>
<div class="section" id="examples">
</section>
<section id="examples">
<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
@ -229,8 +229,8 @@ find it first from local lib directory and then in PATH.</p>
... <span class="s1">&#39;~/.cdist/manifest/init&#39;</span><span class="o">)</span>
</pre></div>
</div>
</div>
</div>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>20. Inventory &mdash; cdist 6.9.5 documentation</title>
<title>20. Inventory &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -192,16 +192,16 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="inventory">
<section id="inventory">
<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">
<section id="introduction">
<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">
</section>
<section id="description">
<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
@ -213,21 +213,21 @@ context mean that host has two tags and it is selected by specifying that both
tags are present.</p>
<p>This inventory is <strong>KISS</strong> cdist built-in inventory database. You can maintain it
using cdist inventory interface or using standard UNIX tools.</p>
</div>
<div class="section" id="cdist-inventory-interface">
</section>
<section id="cdist-inventory-interface">
<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">
</section>
<section id="configuring-hosts-using-inventory">
<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>
<p><strong>-t</strong> means that host specifies tag - all hosts that have specified tags are
selected.</p>
</div>
<div class="section" id="examples">
</section>
<section id="examples">
<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
@ -266,8 +266,8 @@ $ cdist config -b -t -a web dynamic
$ cdist config -b -A
</pre></div>
</div>
</div>
<div class="section" id="example-of-manipulating-database">
</section>
<section id="example-of-manipulating-database">
<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
@ -375,8 +375,8 @@ cloud
</pre></div>
</div>
<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">
</section>
<section id="using-external-inventory">
<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.
@ -387,8 +387,8 @@ can use it with cdist like:</p>
<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>
</div>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>14. Manifest &mdash; cdist 6.9.5 documentation</title>
<title>14. Manifest &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -193,9 +193,9 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="manifest">
<section id="manifest">
<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">
<section id="description">
<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.
@ -223,15 +223,15 @@ The resulting objects are stored in an internal database.</p>
the parameters are exactly the same.</p>
<p>In general, manifests are used to define which types are used depending
on given conditions.</p>
</div>
<div class="section" id="initial-and-type-manifests">
</section>
<section id="initial-and-type-manifests">
<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">
</section>
<section id="define-state-in-the-initial-manifest">
<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.
@ -257,8 +257,8 @@ is only created on the host <strong>localhost</strong>.</p>
<p>As you can see, there is no magic involved, the manifest is simple shell code that
utilises cdist types. Every available type can be executed like a normal
command.</p>
</div>
<div class="section" id="splitting-up-the-initial-manifest">
</section>
<section id="splitting-up-the-initial-manifest">
<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>.
@ -272,8 +272,8 @@ for manifest in $__manifest/*.sh; do
done
</pre></div>
</div>
</div>
<div class="section" id="dependencies">
</section>
<section id="dependencies">
<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
@ -324,8 +324,8 @@ from the type that is calling them. This is called &quot;autorequirement&quot; i
cdist jargon.</p>
<p>You can find a more in depth description of the flow execution of manifests
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">
</section>
<section id="create-dependencies-from-execution-order">
<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.
@ -435,8 +435,8 @@ __file /tmp/fileI
<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">
</section>
<section id="overrides">
<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.
@ -449,8 +449,8 @@ in an undefined situation.</p>
<p>If CDIST_OVERRIDE and CDIST_ORDER_DEPENDENCY are set for an object,
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">
</section>
<section id="examples">
<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 notranslate"><div class="highlight"><pre><span></span><span class="c1"># Always create this file, so other sysadmins know cdist is used.</span>
@ -514,8 +514,8 @@ __sample_type <span class="m">1</span>
__not_in_order_type <span class="m">42</span>
</pre></div>
</div>
</div>
</div>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>18. Messaging &mdash; cdist 6.9.5 documentation</title>
<title>18. Messaging &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -188,9 +188,9 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="messaging">
<section id="messaging">
<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">
<section id="description">
<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>
@ -207,8 +207,8 @@ interfere with other types.</p>
<p>The order of execution is not defined unless you create dependencies
between the different objects (see <a class="reference external" href="cdist-manifest.html">cdist manifest</a>) and thus you
can only react reliably on messages by objects that you depend on.</p>
</div>
<div class="section" id="availability">
</section>
<section id="availability">
<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">
@ -217,8 +217,8 @@ can only react reliably on messages by objects that you depend on.</p>
<li><p>type/gencode-local</p></li>
<li><p>type/gencode-remote</p></li>
</ul>
</div>
<div class="section" id="examples">
</section>
<section id="examples">
<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 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>
@ -268,8 +268,8 @@ can only react reliably on messages by objects that you depend on.</p>
<span class="k">fi</span>
</pre></div>
</div>
</div>
</div>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>3. Supported operating systems &mdash; cdist 6.9.5 documentation</title>
<title>3. Supported operating systems &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -183,7 +183,7 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="supported-operating-systems">
<section id="supported-operating-systems">
<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">
@ -202,7 +202,7 @@
<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>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>19. Parallelization &mdash; cdist 6.9.5 documentation</title>
<title>19. Parallelization &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -188,9 +188,9 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="parallelization">
<section id="parallelization">
<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">
<section id="description">
<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
@ -204,8 +204,8 @@ object preparation and object run are supported.</p>
will be processed by its own process. Within each process cdist will operate
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">
</section>
<section id="examples">
<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
@ -219,8 +219,8 @@ $ cdist config -j -f hosts.file
$ cdist config -j <span class="m">16</span> -p -f hosts.file
</pre></div>
</div>
</div>
<div class="section" id="caveats">
</section>
<section id="caveats">
<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
@ -251,8 +251,8 @@ INFO: <span class="m">78</span>.47.116.244: Finished successful run in <span cla
INFO: cdist: Total processing <span class="nb">time</span> <span class="k">for</span> <span class="m">1</span> host<span class="o">(</span>s<span class="o">)</span>: <span class="m">19</span>.159148693084717
</pre></div>
</div>
</div>
</div>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>22. PreOS &mdash; cdist 6.9.5 documentation</title>
<title>22. PreOS &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -196,16 +196,16 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="preos">
<section id="preos">
<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">
<section id="description">
<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">
</section>
<section id="preos-creation">
<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>
@ -239,8 +239,8 @@ in the previous chapter.</p>
Machine will connect to cdist trigger server. If the request is, for example,
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">
</section>
<section id="implementing-new-preos-sub-command">
<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 notranslate"><span class="pre">cdist/preos/</span></code> distribution directory and also in
@ -263,9 +263,9 @@ attribute if defined in the module/class, defaulting to the module/class name in
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 notranslate"><span class="pre">sys.argv[2:]</span></code>.</p>
<div class="section" id="example-of-writing-new-dummy-preos-sub-command">
<section id="example-of-writing-new-dummy-preos-sub-command">
<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">
<section id="module-based-preos">
<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><p>Create directory <code class="docutils literal notranslate"><span class="pre">~/.cdist/preos/</span></code> if it does not exist</p></li>
@ -289,8 +289,8 @@ $ cdist preos netbsd
NetBSD PreOS: <span class="o">[]</span>
</pre></div>
</div>
</div>
<div class="section" id="class-based-preos">
</section>
<section id="class-based-preos">
<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><p>Create directory <code class="docutils literal notranslate"><span class="pre">~/.cdist/preos/</span></code> if it does not exist</p></li>
@ -317,10 +317,10 @@ FreeBSD dummy preos: <span class="o">[]</span>
</div>
<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">
</section>
</section>
</section>
<section id="simple-tipical-use-case-for-using-preos-and-trigger">
<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">
@ -347,8 +347,8 @@ default init manifest for installation).</p>
<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>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>7. Quickstart &mdash; cdist 6.9.5 documentation</title>
<title>7. Quickstart &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -183,7 +183,7 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="quickstart">
<section id="quickstart">
<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
@ -254,7 +254,7 @@ then ~/.cdist/manifest sub-directory and create init manifest
<p>That's it, you've successfully used cdist to configure your first host!
Continue reading the next sections, to understand what you did and how
to create a more sophisticated configuration.</p>
</div>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>8. Dive into real world cdist &mdash; cdist 6.9.5 documentation</title>
<title>8. Dive into real world cdist &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -210,9 +210,9 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="dive-into-real-world-cdist">
<section id="dive-into-real-world-cdist">
<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">
<section id="introduction">
<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>.
@ -237,8 +237,8 @@ for that. This type will:</p>
to configure hosting for specified user and project. It is up to the user to
create his/her applications.</p>
<p>So let's start.</p>
</div>
<div class="section" id="creating-type-layout">
</section>
<section id="creating-type-layout">
<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
@ -251,8 +251,8 @@ new type layout:</p>
<span class="n">touch</span> <span class="n">parameter</span><span class="o">/</span><span class="n">required</span>
</pre></div>
</div>
</div>
<div class="section" id="creating-sample-bottle-hosting-type-parameters">
</section>
<section id="creating-sample-bottle-hosting-type-parameters">
<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>
@ -272,8 +272,8 @@ the following parameters:</p>
</pre></div>
</div>
<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">
</section>
<section id="creating-sample-bottle-hosting-type-manifest">
<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
@ -299,7 +299,7 @@ OS distributions like GNU/Linux distributions. There can also be a different
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">
<section id="creating-user-and-user-directories">
<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>
@ -322,8 +322,8 @@ require=&quot;__user/$user __directory/$home&quot; __directory &quot;$apphome&qu
User home directory should be created <strong>after</strong> user is created. And application
home directory is created <strong>after</strong> both user and user home directory are created.
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">
</section>
<section id="installing-packages">
<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
@ -350,8 +350,8 @@ for package in bottle bottle-pgsql; do
done
</pre></div>
</div>
</div>
<div class="section" id="creating-postgresql-database">
</section>
<section id="creating-postgresql-database">
<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>
@ -365,8 +365,8 @@ require=&quot;__postgres_role/$user __package/postgresql&quot; __postgres_databa
--owner $user
</pre></div>
</div>
</div>
<div class="section" id="configuring-uwsgi">
</section>
<section id="configuring-uwsgi">
<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 notranslate"><div class="highlight"><pre><span></span># configure uWSGI
@ -397,8 +397,8 @@ We also use stdin as file content source. For details see <a class="reference ex
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">
</section>
<section id="configuring-nginx-for-let-s-encrypt-and-https-redirection">
<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>
@ -408,8 +408,8 @@ 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">
</section>
<section id="configuring-certificate-creation">
<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.
@ -426,8 +426,8 @@ for Let's Encrypt to work:</p>
<span class="s2">&quot;$domain&quot;</span>
</pre></div>
</div>
</div>
<div class="section" id="configuring-nginx-https-server-with-uwsgi-upstream">
</section>
<section id="configuring-nginx-https-server-with-uwsgi-upstream">
<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 notranslate"><div class="highlight"><pre><span></span># configure nginx
@ -465,8 +465,8 @@ EOF
</pre></div>
</div>
<p>Now our manifest is finished.</p>
</div>
<div class="section" id="complete-sample-bottle-hosting-type-manifest-listing">
</section>
<section id="complete-sample-bottle-hosting-type-manifest-listing">
<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>
@ -588,9 +588,9 @@ server {
EOF
</pre></div>
</div>
</div>
</div>
<div class="section" id="creating-sample-bottle-hosting-type-gencode-remote">
</section>
</section>
<section id="creating-sample-bottle-hosting-type-gencode-remote">
<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
@ -600,8 +600,8 @@ configuration is active. Our gencode-remote looks like the following:</p>
</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">
</section>
<section id="creating-sample-nginx-http-letsencrypt-and-ssl-redirect-type">
<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 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>
@ -645,8 +645,8 @@ EOF
<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">
</section>
<section id="creating-init-manifest">
<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 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>
@ -659,16 +659,16 @@ Here the last positional argument <em>sample</em> is type's object id. For detai
<strong>__target_host</strong> and <strong>__object_id</strong> see
<a class="reference external" href="cdist-reference.html#environment-variables-for-reading">Environment variables (for reading)</a>
reference.</p>
</div>
<div class="section" id="configuring-host">
</section>
<section id="configuring-host">
<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 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">
</section>
<section id="creating-python-bottle-application">
<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,
@ -678,7 +678,7 @@ It is up to the user to create his/her applications.</p>
<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">
<section id="preparing-database">
<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>
@ -689,8 +689,8 @@ insert some items:</p>
<span class="n">psql</span> <span class="o">-</span><span class="n">c</span> <span class="s2">&quot;insert into items(item) values(&#39;sausage&#39;);&quot;</span>
</pre></div>
</div>
</div>
<div class="section" id="creating-application">
</section>
<section id="creating-application">
<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 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>
@ -734,8 +734,8 @@ insert some items:</p>
<p>We have configured uWSGI with <strong>touch-reload = $projectname/wsgi.py</strong> so after
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="opening-application">
</section>
<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 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>
@ -750,13 +750,13 @@ we have changed our <strong>wsgi.py</strong> file uWSGI reloads the application.
<li>eggs</li>
<li>sausage</li>
</ul></div>
</div>
</div>
<div class="section" id="what-s-next">
</section>
</section>
<section id="what-s-next">
<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>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>24. Reference &mdash; cdist 6.9.5 documentation</title>
<title>24. Reference &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -191,10 +191,10 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="reference">
<section id="reference">
<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">
<section id="explorers">
<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">
@ -218,8 +218,8 @@
<li><p>os_version</p></li>
<li><p>runlevel</p></li>
</ul>
</div>
<div class="section" id="paths">
</section>
<section id="paths">
<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.
@ -301,8 +301,8 @@ This directory is referenced by the variable __object (see below).</p>
<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">
</section>
<section id="types">
<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">
@ -476,8 +476,8 @@ This directory is referenced by the variable __object (see below).</p>
<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">
</section>
<section id="objects">
<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>
@ -493,8 +493,8 @@ code to be executed (either remote or local).</p>
when the type was called.</p>
</dd>
</dl>
</div>
<div class="section" id="environment-variables-for-reading">
</section>
<section id="environment-variables-for-reading">
<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>
@ -603,8 +603,8 @@ This variable is derived from <strong>__target_host</strong>
<p>Available for: type explorer.</p>
</dd>
</dl>
</div>
<div class="section" id="environment-variables-for-writing">
</section>
<section id="environment-variables-for-writing">
<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>
@ -676,8 +676,8 @@ Recognized values are 'always', 'never', and 'auto' (the default).</p>
<dt>CDIST_CACHE_PATH_PATTERN</dt><dd><p>Custom cache path pattern.</p>
</dd>
</dl>
</div>
</div>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>29. Remote exec and copy commands &mdash; cdist 6.9.5 documentation</title>
<title>29. Remote exec and copy commands &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -195,7 +195,7 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="remote-exec-and-copy-commands">
<section id="remote-exec-and-copy-commands">
<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">
@ -220,12 +220,12 @@ specified by enclosed in square brackets (see <strong>ssh</strong>(1) and
<p>With this simple interface the user can take total control of how cdist
interacts with the target when required, while the default implementation
remains as simple as possible.</p>
<div class="section" id="examples">
<section id="examples">
<h2><span class="section-number">29.1. </span>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<p>Here are examples of using alternative __remote_copy and __remote_exec scripts.</p>
<p>All scripts from below are present in cdist sources in <cite>other/examples/remote</cite>
directory.</p>
<div class="section" id="ssh">
<section id="ssh">
<h3><span class="section-number">29.1.1. </span>ssh<a class="headerlink" href="#ssh" title="Permalink to this headline"></a></h3>
<p>Same as cdist default.</p>
<p><strong>copy</strong></p>
@ -240,8 +240,8 @@ scp -o <span class="nv">User</span><span class="o">=</span>root -q <span class="
ssh -o <span class="nv">User</span><span class="o">=</span>root <span class="nv">$@</span>
</pre></div>
</div>
</div>
<div class="section" id="local">
</section>
<section id="local">
<h3><span class="section-number">29.1.2. </span>local<a class="headerlink" href="#local" title="Permalink to this headline"></a></h3>
<p>This effectively turns remote calling into local calling. Probably most useful
for the unit testing.</p>
@ -255,8 +255,8 @@ cp -L <span class="nv">$code</span>
<span class="nb">echo</span> <span class="s2">&quot;</span><span class="nv">$@</span><span class="s2">&quot;</span> <span class="p">|</span> /bin/sh
</pre></div>
</div>
</div>
<div class="section" id="chroot">
</section>
<section id="chroot">
<h3><span class="section-number">29.1.3. </span>chroot<a class="headerlink" href="#chroot" title="Permalink to this headline"></a></h3>
<p><strong>copy</strong></p>
<p>Usage: cdist config --remote-copy &quot;/path/to/this/script /path/to/your/chroot&quot; target-id</p>
@ -314,8 +314,8 @@ chroot <span class="s2">&quot;</span><span class="nv">$chroot</span><span class=
log <span class="s2">&quot;-----&quot;</span>
</pre></div>
</div>
</div>
<div class="section" id="rsync">
</section>
<section id="rsync">
<h3><span class="section-number">29.1.4. </span>rsync<a class="headerlink" href="#rsync" title="Permalink to this headline"></a></h3>
<p><strong>copy</strong></p>
<p>Usage: cdist config --remote-copy /path/to/this/script target_host</p>
@ -340,8 +340,8 @@ log <span class="s2">&quot;-----&quot;</span>
rsync --backup --suffix<span class="o">=</span>~cdist -e <span class="s1">&#39;ssh -o User=root&#39;</span> <span class="nv">$@</span>
</pre></div>
</div>
</div>
<div class="section" id="schroot">
</section>
<section id="schroot">
<h3><span class="section-number">29.1.5. </span>schroot<a class="headerlink" href="#schroot" title="Permalink to this headline"></a></h3>
<p>__remote_copy and __remote_exec scripts to run cdist against a chroot on the
target host over ssh.</p>
@ -396,8 +396,8 @@ log <span class="s2">&quot;code: </span><span class="nv">$code</span><span class
log <span class="s2">&quot;-----&quot;</span>
</pre></div>
</div>
</div>
<div class="section" id="schroot-uri">
</section>
<section id="schroot-uri">
<h3><span class="section-number">29.1.6. </span>schroot-uri<a class="headerlink" href="#schroot-uri" title="Permalink to this headline"></a></h3>
<p>__remote_exec/__remote_copy script to run cdist against a schroot target URI.</p>
<p>Usage:</p>
@ -523,8 +523,8 @@ log <span class="s2">&quot;code: </span><span class="nv">$code</span><span class
log <span class="s2">&quot;-----&quot;</span>
</pre></div>
</div>
</div>
<div class="section" id="sudo">
</section>
<section id="sudo">
<h3><span class="section-number">29.1.7. </span>sudo<a class="headerlink" href="#sudo" title="Permalink to this headline"></a></h3>
<p><strong>copy</strong></p>
<p>Use rsync over ssh to copy files. Uses the &quot;--rsync-path&quot; option
@ -560,9 +560,9 @@ rsync --copy-links --rsync-path<span class="o">=</span><span class="s2">&quot;su
ssh -q <span class="s2">&quot;</span><span class="nv">$host</span><span class="s2">&quot;</span> sudo sh -c <span class="se">\&quot;</span><span class="s2">&quot;</span><span class="nv">$@</span><span class="s2">&quot;</span><span class="se">\&quot;</span>
</pre></div>
</div>
</div>
</div>
</div>
</section>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>28. Saving output streams &mdash; cdist 6.9.5 documentation</title>
<title>28. Saving output streams &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -186,9 +186,9 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="saving-output-streams">
<section id="saving-output-streams">
<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">
<section id="description">
<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
@ -266,8 +266,8 @@ type: /tmp/tmpzomy0wis/75ee6a79e32da093da23fe4a13dd104b/data/conf/type/__myline
ERROR: cdist: Failed to configure the following hosts: <span class="m">185</span>.203.112.42
</pre></div>
</div>
</div>
</div>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>26. Execution stages &mdash; cdist 6.9.5 documentation</title>
<title>26. Execution stages &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -194,35 +194,35 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="execution-stages">
<section id="execution-stages">
<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">
<section id="description">
<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">
</section>
<section id="stage-1-target-information-retrieval">
<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">
</section>
<section id="stage-2-run-the-initial-manifest">
<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,
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">
</section>
<section id="stage-3-object-information-retrieval">
<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">
</section>
<section id="stage-4-run-the-object-manifest">
<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,
@ -232,29 +232,29 @@ contain a manifest script, which creates new objects of type __file.</p>
<p>The newly created objects are merged back into the existing tree. No conflicts
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">
</section>
<section id="stage-5-code-generation">
<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">
</section>
<section id="stage-6-code-execution">
<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">
</section>
<section id="stage-7-cache">
<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">
</section>
<section id="summary">
<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>
</div>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>6. Support &mdash; cdist 6.9.5 documentation</title>
<title>6. Support &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -189,30 +189,30 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="support">
<section id="support">
<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">
<section id="chat">
<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">
</section>
<section id="mailing-list">
<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">
</section>
<section id="linkedin">
<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">
</section>
<section id="commercial-support">
<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>
</div>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>21. Trigger &mdash; cdist 6.9.5 documentation</title>
<title>21. Trigger &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -186,9 +186,9 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="trigger">
<section id="trigger">
<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">
<section id="description">
<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>
@ -216,8 +216,8 @@ host name is resolved then IP address is used.</p>
<li><p>599 for cdist run errors</p></li>
<li><p>500 for cdist/server errors.</p></li>
</ul>
</div>
</div>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>31. Troubleshooting &mdash; cdist 6.9.5 documentation</title>
<title>31. Troubleshooting &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -62,7 +62,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -186,9 +186,9 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="troubleshooting">
<section id="troubleshooting">
<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">
<section id="error-in-manifest-is-not-considered-an-error-by-cdist">
<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.
@ -224,8 +224,8 @@ you write to use the -e flag:</p>
...
</pre></div>
</div>
</div>
<div class="section" id="using-debug-dump-helper-script">
</section>
<section id="using-debug-dump-helper-script">
<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,
@ -238,8 +238,8 @@ is a helper script that dumps data from local cache,
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>./scripts/cdist-dump -h
</pre></div>
</div>
</div>
</div>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>15. cdist type &mdash; cdist 6.9.5 documentation</title>
<title>15. cdist type &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -214,22 +214,22 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cdist-type">
<section id="cdist-type">
<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">
<section id="description">
<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">
</section>
<section id="synopsis">
<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">
</section>
<section id="how-to-use-a-type">
<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>
@ -241,8 +241,8 @@ __package tree --state installed
</pre></div>
</div>
<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">
</section>
<section id="singleton-types">
<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
@ -255,25 +255,25 @@ __issue
__myfancysingleton --colour green
</pre></div>
</div>
</div>
<div class="section" id="config-types">
</section>
<section id="config-types">
<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">
</section>
<section id="install-types">
<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">
</section>
<section id="nonparallel-types">
<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">
</section>
<section id="deprecated-types">
<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
@ -293,8 +293,8 @@ $ <span class="nb">echo</span> <span class="s1">&#39;__bar foo&#39;</span> <span
WARNING: <span class="m">185</span>.203.112.26: Type __bar is deprecated.
</pre></div>
</div>
</div>
<div class="section" id="how-to-write-a-new-type">
</section>
<section id="how-to-write-a-new-type">
<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">
@ -314,8 +314,8 @@ they are written in shell so they are executed using '/bin/sh -e' or 'CDIST_LOCA
<p>For executable shell code it is suggested that shebang is '#!/bin/sh -e'.</p>
<p>For creating type skeleton you can use helper script
<a class="reference external" href="man1/cdist-new-type.html">cdist-new-type</a>.</p>
</div>
<div class="section" id="defining-parameters">
</section>
<section id="defining-parameters">
<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>,
@ -338,8 +338,8 @@ mkdir cdist/conf/type/__nginx_vhost/parameter/default
<span class="nb">echo</span> use_ssl &gt;&gt; cdist/conf/type/__nginx_vhost/parameter/boolean
</pre></div>
</div>
</div>
<div class="section" id="using-parameters">
</section>
<section id="using-parameters">
<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
@ -371,8 +371,8 @@ file does not exist -&gt; False</p>
<span class="k">fi</span>
</pre></div>
</div>
</div>
<div class="section" id="deprecated-parameters">
</section>
<section id="deprecated-parameters">
<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>
@ -392,8 +392,8 @@ WARNING: <span class="m">185</span>.203.112.26: spam parameter of <span class="n
WARNING: <span class="m">185</span>.203.112.26: eggs parameter of <span class="nb">type</span> __foo is deprecated: eggs parameter is deprecated, please use multiple egg parameter.
</pre></div>
</div>
</div>
<div class="section" id="input-from-stdin">
</section>
<section id="input-from-stdin">
<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>
@ -416,7 +416,7 @@ about &quot;here documents&quot;.</p>
....
</pre></div>
</div>
<div class="section" id="stdin-inside-a-loop">
<section id="stdin-inside-a-loop">
<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
@ -469,9 +469,9 @@ stdin from <em>/dev/null</em>:</p>
<span class="k">fi</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="writing-the-manifest">
</section>
</section>
<section id="writing-the-manifest">
<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
@ -494,8 +494,8 @@ __package_<span class="nv">$type</span> <span class="s2">&quot;</span><span clas
which are documented in <a class="reference external" href="cdist-reference.html">cdist reference</a>.</p>
<p>Always ensure the manifest is executable, otherwise cdist will not be able
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">
</section>
<section id="singleton-one-instance-only">
<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
@ -509,8 +509,8 @@ directory:</p>
</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">
</section>
<section id="install-type-with-install-command">
<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>
@ -518,8 +518,8 @@ install: create the (empty) file &quot;install&quot; in your type directory:</p>
</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">
</section>
<section id="nonparallel-only-one-instance-can-be-run-at-a-time">
<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;
@ -528,8 +528,8 @@ in your type directory:</p>
</pre></div>
</div>
<p>For example, package types are nonparallel types.</p>
</div>
<div class="section" id="the-type-explorers">
</section>
<section id="the-type-explorers">
<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>
@ -547,8 +547,8 @@ client, like this (shortened version from the type __file):</p>
<span class="k">fi</span>
</pre></div>
</div>
</div>
<div class="section" id="writing-the-gencode-script">
</section>
<section id="writing-the-gencode-script">
<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
@ -570,8 +570,8 @@ then for IPv6 address with __remote_copy execution you should enclose IPv6
address in square brackets. The same applies to __remote_exec if it behaves
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">
</section>
<section id="variable-access-from-the-generated-scripts">
<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">
@ -588,8 +588,8 @@ files after the script execution.</p>
<span class="k">fi</span>
</pre></div>
</div>
</div>
<div class="section" id="environment-variable-usage-idiom">
</section>
<section id="environment-variable-usage-idiom">
<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>
@ -598,8 +598,8 @@ parameter expansion.</p>
<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">
</section>
<section id="log-level-in-types">
<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>
@ -640,14 +640,14 @@ parameter expansion.</p>
</div></blockquote>
<p>It is available for initial manifest, explorer, type manifest,
type explorer, type gencode.</p>
</div>
<div class="section" id="detecting-dry-run">
</section>
<section id="detecting-dry-run">
<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">
</section>
<section id="hints-for-typewriters">
<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
@ -660,14 +660,14 @@ cdist will not touch this directory.</p>
<p>If your type contains static files, it's also recommended to place them in
a folder named &quot;files&quot; within the type (again, because cdist guarantees to
never ever touch this folder).</p>
</div>
<div class="section" id="how-to-include-a-type-into-upstream-cdist">
</section>
<section id="how-to-include-a-type-into-upstream-cdist">
<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">
</section>
<section id="python-types">
<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
@ -744,8 +744,8 @@ your config.</p>
<p>Also, this documenation is only an introduction, and not a complete guide to python
types. Currently, it is just a short introduction so one can start to write and use
python types.</p>
</div>
</div>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16. cdist types &mdash; cdist 6.9.5 documentation</title>
<title>16. cdist types &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -354,7 +354,7 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cdist-types">
<section id="cdist-types">
<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>
@ -529,7 +529,7 @@
<li class="toctree-l1"><a class="reference internal" href="man7/cdist-type__zypper_service.html">16.169. __zypper_service</a></li>
</ul>
</div>
</div>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>5. How to upgrade cdist &mdash; cdist 6.9.5 documentation</title>
<title>5. How to upgrade cdist &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -205,9 +205,9 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="how-to-upgrade-cdist">
<section id="how-to-upgrade-cdist">
<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">
<section id="update-the-git-installation">
<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 notranslate"><div class="highlight"><pre><span></span>git pull
@ -220,7 +220,7 @@ make man
<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">
<section id="safely-upgrading-to-new-versions">
<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>
@ -252,32 +252,32 @@ git checkout master
<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">
</section>
</section>
<section id="update-the-python-package">
<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">
</section>
<section id="general-update-instructions">
<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">
<section id="updating-from-3-0-to-3-1">
<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">
</section>
<section id="updating-from-2-3-to-3-0">
<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">
</section>
<section id="updating-from-2-2-to-2-3">
<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">
</section>
<section id="updating-from-2-1-to-2-2">
<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>
@ -294,8 +294,8 @@ snippet (currently untested, please report back if it works for you):</p>
<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">
</section>
<section id="updating-from-2-0-to-2-1">
<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>
@ -325,8 +325,8 @@ Support for the variable <strong>__object_name</strong> is already present in 2.
</li>
</ul>
</div></blockquote>
</div>
<div class="section" id="updating-from-1-7-to-2-0">
</section>
<section id="updating-from-1-7-to-2-0">
<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><p>Ensure python (&gt;= 3.2) is installed on the source host</p></li>
@ -335,15 +335,15 @@ Support for the variable <strong>__object_name</strong> is already present in 2.
<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">
</section>
<section id="updating-from-1-6-to-1-7">
<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><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">
</section>
<section id="updating-from-1-5-to-1-6">
<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><p>If you used <strong>__package_apt --preseed</strong>, you need to use the new
@ -352,20 +352,20 @@ type <strong>__debconf_set_selections</strong> instead.</p></li>
--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">
</section>
<section id="updating-from-1-3-to-1-5">
<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">
</section>
<section id="updating-from-1-2-to-1-3">
<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">
</section>
<section id="updating-from-1-1-to-1-2">
<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">
</section>
<section id="updating-from-1-0-to-1-1">
<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
@ -377,9 +377,9 @@ need to replace <strong>__file</strong> calls in your manifests:</p>
<li><p>If type was directory, use __directory</p></li>
</ul>
</div></blockquote>
</div>
</div>
</div>
</section>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>1. Why should I use cdist? &mdash; cdist 6.9.5 documentation</title>
<title>1. Why should I use cdist? &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -191,11 +191,11 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="why-should-i-use-cdist">
<section id="why-should-i-use-cdist">
<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">
<section id="known-language">
<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>.
@ -203,8 +203,8 @@ Shell script is used by UNIX system engineers for decades.
So when cdist is introduced, your staff does not need to learn a new
<a class="reference external" href="https://en.wikipedia.org/wiki/Domain-specific_language">DSL</a>
or programming language.</p>
</div>
<div class="section" id="powerful-language">
</section>
<section id="powerful-language">
<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
@ -218,8 +218,8 @@ which make daily work easy:</p>
<li><p>Support for dependencies between cdist types</p></li>
</ul>
</div></blockquote>
</div>
<div class="section" id="more-than-shell-scripting">
</section>
<section id="more-than-shell-scripting">
<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,
@ -227,8 +227,8 @@ the results are
<a class="reference external" href="https://en.wikipedia.org/wiki/Idempotence">idempotent</a>.
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">
</section>
<section id="zero-dependency-configuration-management">
<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.
@ -237,8 +237,8 @@ languages on the target host: it will run on any host that
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">
</section>
<section id="push-based-distribution">
<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
@ -250,15 +250,15 @@ limited amount of resources.</p>
needs access to the target hosts. No target hosts will ever
need to connect back to the source host, which contains the
full configuration.</p>
</div>
<div class="section" id="highly-scalable">
</section>
<section id="highly-scalable">
<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.
Cdist will utilise the given resources in parallel.</p>
</div>
</div>
</section>
</section>
</div>

View file

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Index &mdash; cdist 6.9.5 documentation</title>
<title>Index &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +24,6 @@
<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>
@ -61,7 +60,7 @@
<div class="version">
6.9.5
6.9.6
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>cdist - usable configuration management &mdash; cdist 6.9.5 documentation</title>
<title>cdist - usable configuration management &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -62,7 +62,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -182,7 +182,7 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cdist-usable-configuration-management">
<section id="cdist-usable-configuration-management">
<h1>cdist - usable configuration management<a class="headerlink" href="#cdist-usable-configuration-management" title="Permalink to this headline"></a></h1>
<p>cdist is a usable configuration management system.
It adheres to the KISS principle and
@ -190,7 +190,7 @@ is being used in small up to enterprise grade environments.
It natively supports IPv6 since the first release.</p>
<div class="toctree-wrapper compound">
</div>
</div>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>10. cdist-dump(1) &mdash; cdist 6.9.5 documentation</title>
<title>10. cdist-dump(1) &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -193,27 +193,27 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cdist-dump-1">
<section id="cdist-dump-1">
<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">
<section id="name">
<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">
</section>
<section id="synopsis">
<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">
</section>
<section id="description">
<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>
<p>cdist-dump can be used for debugging existing types, host configuration and
new types.</p>
</div>
<div class="section" id="options">
</section>
<section id="options">
<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>
@ -253,8 +253,8 @@ new types.</p>
<dt><strong>-v</strong></dt><dd><p>increase verbosity</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
</section>
<section id="examples">
<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
@ -263,21 +263,21 @@ new types.</p>
% cdist-dump -c
</pre></div>
</div>
</div>
<div class="section" id="see-also">
</section>
<section id="see-also">
<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">
</section>
<section id="authors">
<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">
</section>
<section id="copying">
<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>
</div>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>11. cdist-new-type(1) &mdash; cdist 6.9.5 documentation</title>
<title>11. cdist-new-type(1) &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -193,19 +193,19 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cdist-new-type-1">
<section id="cdist-new-type-1">
<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">
<section id="name">
<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">
</section>
<section id="synopsis">
<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">
</section>
<section id="description">
<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>
@ -216,8 +216,8 @@ It is then up to the type author to finish the type.</p>
<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">
</section>
<section id="arguments">
<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>
@ -230,8 +230,8 @@ It is then up to the type author to finish the type.</p>
to '$PWD/type'.</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
</section>
<section id="examples">
<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
@ -239,24 +239,24 @@ $ cdist-new-type <span class="s1">&#39;__foo&#39;</span> <span class="s1">&#39;F
/home/foo/.cdist/type/__foo
</pre></div>
</div>
</div>
<div class="section" id="see-also">
</section>
<section id="see-also">
<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">
</section>
<section id="authors">
<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">
</section>
<section id="copying">
<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>
</div>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>9. cdist(1) &mdash; cdist 6.9.5 documentation</title>
<title>9. cdist(1) &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -219,13 +219,13 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cdist-1">
<section id="cdist-1">
<h1><span class="section-number">9. </span>cdist(1)<a class="headerlink" href="#cdist-1" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<section id="name">
<h2><span class="section-number">9.1. </span>NAME<a class="headerlink" href="#name" title="Permalink to this headline"></a></h2>
<p>cdist - Usable Configuration Management</p>
</div>
<div class="section" id="synopsis">
</section>
<section id="synopsis">
<h2><span class="section-number">9.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="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">V</span><span class="p">]</span> <span class="p">{</span><span class="n">banner</span><span class="p">,</span><span class="n">config</span><span class="p">,</span><span class="n">install</span><span class="p">,</span><span class="n">inventory</span><span class="p">,</span><span class="n">preos</span><span class="p">,</span><span class="n">shell</span><span class="p">,</span><span class="n">info</span><span class="p">,</span><span class="n">trigger</span><span class="p">}</span> <span class="o">...</span>
@ -315,15 +315,15 @@
<span class="p">[</span><span class="o">-</span><span class="n">S</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">D</span> <span class="n">DIRECTORY</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">H</span> <span class="n">HTTP_PORT</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">ipv6</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">O</span> <span class="n">SOURCE</span><span class="p">]</span>
</pre></div>
</div>
</div>
<div class="section" id="description">
</section>
<section id="description">
<h2><span class="section-number">9.3. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>cdist is the frontend executable to the cdist configuration management.
It supports different subcommands as explained below.</p>
<p>It is written in Python so it requires <strong>python</strong>(1) to be installed.
It requires a minimal Python version 3.5.</p>
</div>
<div class="section" id="general">
</section>
<section id="general">
<h2><span class="section-number">9.4. </span>GENERAL<a class="headerlink" href="#general" title="Permalink to this headline"></a></h2>
<p>All commands accept the following options:</p>
<dl>
@ -355,13 +355,13 @@ last set value.</p>
<dt><strong>-V, --version</strong></dt><dd><p>Show version and exit.</p>
</dd>
</dl>
</div>
<div class="section" id="banner">
</section>
<section id="banner">
<h2><span class="section-number">9.5. </span>BANNER<a class="headerlink" href="#banner" title="Permalink to this headline"></a></h2>
<p>Displays the cdist banner. Useful for printing
cdist posters - a must have for every office.</p>
</div>
<div class="section" id="config-install">
</section>
<section id="config-install">
<h2><span class="section-number">9.6. </span>CONFIG/INSTALL<a class="headerlink" href="#config-install" title="Permalink to this headline"></a></h2>
<p>Configure/install one or more hosts.
Install command is currently in beta.</p>
@ -443,7 +443,7 @@ all hosts that contain any of specified tags.
Currently in beta.</p>
</dd>
</dl>
<div class="section" id="hostfile-format">
<section id="hostfile-format">
<h3><span class="section-number">9.6.1. </span>HOSTFILE FORMAT<a class="headerlink" href="#hostfile-format" title="Permalink to this headline"></a></h3>
<p>The HOSTFILE contains one host per line.
A comment is started with '#' and continues to the end of the line.
@ -453,8 +453,8 @@ Empty lines are ignored/skipped.</p>
removed. Then all leading and trailing whitespace characters are stripped.
If such a line results in empty line it is ignored/skipped. Otherwise,
host string is used.</p>
</div>
<div class="section" id="cache-path-pattern-format">
</section>
<section id="cache-path-pattern-format">
<h3><span class="section-number">9.6.2. </span>CACHE PATH PATTERN FORMAT<a class="headerlink" href="#cache-path-pattern-format" title="Permalink to this headline"></a></h3>
<p>Cache path pattern specifies path for a cache directory subdirectory.
In the path, '%N' will be substituted by the target host, '%h' will
@ -468,14 +468,14 @@ is used.</p>
<p>Calculated host directory is a hash of a host cdist operates on.</p>
<p>Resulting path is used to specify cache path subdirectory under which
current host cache data are saved.</p>
</div>
</div>
<div class="section" id="inventory">
</section>
</section>
<section id="inventory">
<h2><span class="section-number">9.7. </span>INVENTORY<a class="headerlink" href="#inventory" title="Permalink to this headline"></a></h2>
<p>Manage inventory database.
Currently in beta with all sub-commands.</p>
</div>
<div class="section" id="inventory-add-host">
</section>
<section id="inventory-add-host">
<h2><span class="section-number">9.8. </span>INVENTORY ADD-HOST<a class="headerlink" href="#inventory-add-host" title="Permalink to this headline"></a></h2>
<p>Add host(s) to inventory database.</p>
<dl class="simple">
@ -497,8 +497,8 @@ directory is used, if HOME env var is set then
inventory directory is used.</p>
</dd>
</dl>
</div>
<div class="section" id="inventory-add-tag">
</section>
<section id="inventory-add-tag">
<h2><span class="section-number">9.9. </span>INVENTORY ADD-TAG<a class="headerlink" href="#inventory-add-tag" title="Permalink to this headline"></a></h2>
<p>Add tag(s) to inventory database.</p>
<dl class="simple">
@ -527,8 +527,8 @@ Tagfile format is the same as config hostfile format.</p>
separated values.</p>
</dd>
</dl>
</div>
<div class="section" id="inventory-del-host">
</section>
<section id="inventory-del-host">
<h2><span class="section-number">9.10. </span>INVENTORY DEL-HOST<a class="headerlink" href="#inventory-del-host" title="Permalink to this headline"></a></h2>
<p>Delete host(s) from inventory database.</p>
<dl class="simple">
@ -552,8 +552,8 @@ directory is used, if HOME env var is set then
inventory directory is used.</p>
</dd>
</dl>
</div>
<div class="section" id="inventory-del-tag">
</section>
<section id="inventory-del-tag">
<h2><span class="section-number">9.11. </span>INVENTORY DEL-TAG<a class="headerlink" href="#inventory-del-tag" title="Permalink to this headline"></a></h2>
<p>Delete tag(s) from inventory database.</p>
<dl class="simple">
@ -585,8 +585,8 @@ Tagfile format is the same as config hostfile format.</p>
separated values.</p>
</dd>
</dl>
</div>
<div class="section" id="inventory-list">
</section>
<section id="inventory-list">
<h2><span class="section-number">9.12. </span>INVENTORY LIST<a class="headerlink" href="#inventory-list" title="Permalink to this headline"></a></h2>
<p>List inventory database.</p>
<dl class="simple">
@ -617,8 +617,8 @@ inventory directory is used.</p>
all hosts that contain any of specified tags.</p>
</dd>
</dl>
</div>
<div class="section" id="preos">
</section>
<section id="preos">
<h2><span class="section-number">9.13. </span>PREOS<a class="headerlink" href="#preos" title="Permalink to this headline"></a></h2>
<p>Create PreOS.</p>
<dl class="simple">
@ -635,8 +635,8 @@ all hosts that contain any of specified tags.</p>
<li><p>ubuntu</p></li>
<li><p>devuan</p></li>
</ul>
</div>
<div class="section" id="preos-debian-devuan">
</section>
<section id="preos-debian-devuan">
<h2><span class="section-number">9.14. </span>PREOS DEBIAN/DEVUAN<a class="headerlink" href="#preos-debian-devuan" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt><strong>target_dir</strong></dt><dd><p>target directory where PreOS will be bootstrapped</p>
@ -682,8 +682,8 @@ internal init manifest is used</p>
internal script is used</p>
</dd>
</dl>
</div>
<div class="section" id="preos-ubuntu">
</section>
<section id="preos-ubuntu">
<h2><span class="section-number">9.15. </span>PREOS UBUNTU<a class="headerlink" href="#preos-ubuntu" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt><strong>target_dir</strong></dt><dd><p>target directory where PreOS will be bootstrapped</p>
@ -729,8 +729,8 @@ internal init manifest is used</p>
internal script is used</p>
</dd>
</dl>
</div>
<div class="section" id="shell">
</section>
<section id="shell">
<h2><span class="section-number">9.16. </span>SHELL<a class="headerlink" href="#shell" title="Permalink to this headline"></a></h2>
<p>This command allows you to spawn a shell that enables access
to the types as commands. It can be thought as an
@ -741,8 +741,8 @@ usage. Its primary use is for debugging type parameters.</p>
be POSIX compatible shell.</p>
</dd>
</dl>
</div>
<div class="section" id="info">
</section>
<section id="info">
<h2><span class="section-number">9.17. </span>INFO<a class="headerlink" href="#info" title="Permalink to this headline"></a></h2>
<p>Display information for cdist (global explorers, types).</p>
<dl class="simple">
@ -766,8 +766,8 @@ used as specified, otherwise it is translated to <cite>*pattern*</cite>.</p>
<dt><strong>-t, --types</strong></dt><dd><p>Display info for types.</p>
</dd>
</dl>
</div>
<div class="section" id="trigger">
</section>
<section id="trigger">
<h2><span class="section-number">9.18. </span>TRIGGER<a class="headerlink" href="#trigger" title="Permalink to this headline"></a></h2>
<p>Start trigger (simple http server) that waits for connections. When host
connects then it triggers config or install command and then cdist
@ -839,8 +839,8 @@ like ssh).</p>
<dt><strong>-S, --disable-saving-output-streams</strong></dt><dd><p>Disable saving output streams.</p>
</dd>
</dl>
</div>
<div class="section" id="configuration">
</section>
<section id="configuration">
<h2><span class="section-number">9.19. </span>CONFIGURATION<a class="headerlink" href="#configuration" title="Permalink to this headline"></a></h2>
<p>cdist obtains configuration data from the following sources in the following
order (from higher to lower precedence):</p>
@ -854,7 +854,7 @@ order (from higher to lower precedence):</p>
<li><p>system-wide configuration file (/etc/cdist.cfg).</p></li>
</ol>
</div></blockquote>
<div class="section" id="configuration-file-format">
<section id="configuration-file-format">
<h3><span class="section-number">9.19.1. </span>CONFIGURATION FILE FORMAT<a class="headerlink" href="#configuration-file-format" title="Permalink to this headline"></a></h3>
<p>cdist configuration file is in the INI file format. Currently it supports
only [GLOBAL] section.
@ -913,9 +913,9 @@ in the format: YYYYMMDDHHMMSS.us.</p>
'ERROR', 'WARNING', 'INFO', 'VERBOSE', 'DEBUG', 'TRACE' and 'OFF'.</p>
</dd>
</dl>
</div>
</div>
<div class="section" id="files">
</section>
</section>
<section id="files">
<h2><span class="section-number">9.20. </span>FILES<a class="headerlink" href="#files" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>~/.cdist</dt><dd><p>Your personal cdist config directory. If exists it will be
@ -941,14 +941,14 @@ This path is relative to cdist installation directory.</p>
<dt>~/.cdist.cfg or $XDG_CONFIG_HOME/cdist/cdist.cfg</dt><dd><p>Local cdist configuration file, if exists.</p>
</dd>
</dl>
</div>
<div class="section" id="notes">
</section>
<section id="notes">
<h2><span class="section-number">9.21. </span>NOTES<a class="headerlink" href="#notes" title="Permalink to this headline"></a></h2>
<p>cdist detects if host is specified by IPv6 address. If so then remote_copy
command is executed with host address enclosed in square brackets
(see <strong>scp</strong>(1)).</p>
</div>
<div class="section" id="examples">
</section>
<section id="examples">
<h2><span class="section-number">9.22. </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 ikq05.ethz.ch with debug enabled</span>
% cdist config -vvv ikq05.ethz.ch
@ -1045,8 +1045,8 @@ $ cdist preos ubuntu /mnt -B -C <span class="se">\</span>
% cdist trigger -v -i ~/.cdist/manifest/init-for-triggered
</pre></div>
</div>
</div>
<div class="section" id="environment">
</section>
<section id="environment">
<h2><span class="section-number">9.23. </span>ENVIRONMENT<a class="headerlink" href="#environment" title="Permalink to this headline"></a></h2>
<dl class="simple">
<dt>TMPDIR, TEMP, TMP</dt><dd><p>Setup the base directory for the temporary directory.
@ -1081,19 +1081,19 @@ finally fixed and well defined.</p>
<dt>CDIST_CONFIG_FILE</dt><dd><p>Custom configuration file.</p>
</dd>
</dl>
</div>
<div class="section" id="exit-status">
</section>
<section id="exit-status">
<h2><span class="section-number">9.24. </span>EXIT STATUS<a class="headerlink" href="#exit-status" title="Permalink to this headline"></a></h2>
<p>The following exit values shall be returned:</p>
<p>0 Successful completion.</p>
<p>1 One or more host configurations failed.</p>
</div>
<div class="section" id="authors">
</section>
<section id="authors">
<h2><span class="section-number">9.25. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Originally written by 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;
and 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="caveats">
</section>
<section id="caveats">
<h2><span class="section-number">9.26. </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
@ -1131,13 +1131,13 @@ Warning message:
Dependency resolver could not handle dependencies as expected.
</pre></div>
</div>
</div>
<div class="section" id="copying">
</section>
<section id="copying">
<h2><span class="section-number">9.27. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>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+).</p>
</div>
</div>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.1. cdist-type__acl(7) &mdash; cdist 6.9.5 documentation</title>
<title>16.1. cdist-type__acl(7) &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -366,27 +366,27 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cdist-type-acl-7">
<section id="cdist-type-acl-7">
<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">
<section id="name">
<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">
</section>
<section id="description">
<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 notranslate"><span class="pre">setfacl</span></code> and <code class="docutils literal notranslate"><span class="pre">acl</span></code> manpages for more details.</p>
<p>One of <code class="docutils literal notranslate"><span class="pre">--entry</span></code> or <code class="docutils literal notranslate"><span class="pre">--source</span></code> must be used.</p>
</div>
<div class="section" id="optional-multiple-parameters">
</section>
<section id="optional-multiple-parameters">
<h2><span class="section-number">16.1.3. </span>OPTIONAL MULTIPLE PARAMETERS<a class="headerlink" href="#optional-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.
Must be used if <code class="docutils literal notranslate"><span class="pre">--source</span></code> is not used.</p>
</dd>
</dl>
</div>
<div class="section" id="optional-parameters">
</section>
<section id="optional-parameters">
<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.
@ -399,8 +399,8 @@ Must be used if <code class="docutils literal notranslate"><span class="pre">--e
<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">
</section>
<section id="boolean-parameters">
<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.
@ -413,8 +413,8 @@ Setting default ACL in FreeBSD is currently not supported.</p>
<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="examples">
</section>
<section id="examples">
<h2><span class="section-number">16.1.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>__acl /srv/project <span class="se">\</span>
--default <span class="se">\</span>
@ -454,19 +454,19 @@ __acl /path/to/directory <span class="se">\</span>
--entry user:nobody:rwx
</pre></div>
</div>
</div>
<div class="section" id="authors">
</section>
<section id="authors">
<h2><span class="section-number">16.1.7. </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">
</section>
<section id="copying">
<h2><span class="section-number">16.1.8. </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
License, or (at your option) any later version.</p>
</div>
</div>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.2. cdist-type__debian_backports(7) &mdash; cdist 6.9.5 documentation</title>
<title>16.2. cdist-type__debian_backports(7) &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -370,13 +370,13 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cdist-type-debian-backports-7">
<section id="cdist-type-debian-backports-7">
<h1><span class="section-number">16.2. </span>cdist-type__debian_backports(7)<a class="headerlink" href="#cdist-type-debian-backports-7" title="Permalink to this headline"></a></h1>
<div class="section" id="name">
<section id="name">
<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_backports - Install backports</p>
</div>
<div class="section" id="description">
</section>
<section id="description">
<h2><span class="section-number">16.2.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>This singleton type installs backports for the current OS release.
It aborts if backports are not supported for the specified OS or
@ -388,12 +388,12 @@ no version codename could be fetched (like Debian unstable).</p>
<li><p>Devuan</p></li>
<li><p>Ubuntu</p></li>
</ul>
</div>
<div class="section" id="required-parameters">
</section>
<section id="required-parameters">
<h2><span class="section-number">16.2.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">
</section>
<section id="optional-parameters">
<h2><span class="section-number">16.2.4. </span>OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline"></a></h2>
<dl>
<dt>state</dt><dd><p>Represents the state of the backports repository. <code class="docutils literal notranslate"><span class="pre">present</span></code> or
@ -405,16 +405,16 @@ mirror of the current OS.</p>
<p>Will be directly passed to <strong>cdist-type__apt_source</strong>(7).</p>
</dd>
</dl>
</div>
<div class="section" id="boolean-parameters">
</section>
<section id="boolean-parameters">
<h2><span class="section-number">16.2.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="messages">
</section>
<section id="messages">
<h2><span class="section-number">16.2.6. </span>MESSAGES<a class="headerlink" href="#messages" title="Permalink to this headline"></a></h2>
<p>None.</p>
</div>
<div class="section" id="examples">
</section>
<section id="examples">
<h2><span class="section-number">16.2.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"># setup the backports</span>
__apt_backports
@ -427,38 +427,38 @@ __apt_backports --state present --mirror <span class="s2">&quot;http://ftp.de.de
--target-release buster-backports
</pre></div>
</div>
</div>
<div class="section" id="aborts">
</section>
<section id="aborts">
<h2><span class="section-number">16.2.8. </span>ABORTS<a class="headerlink" href="#aborts" title="Permalink to this headline"></a></h2>
<p>Aborts if the detected os is not Debian.</p>
<p>Aborts if no distribuition codename could be detected. This is common for the
unstable distribution, but there is no backports repository for it already.</p>
</div>
<div class="section" id="caveats">
</section>
<section id="caveats">
<h2><span class="section-number">16.2.9. </span>CAVEATS<a class="headerlink" href="#caveats" title="Permalink to this headline"></a></h2>
<p>For Ubuntu, it setup all componenents for the backports repository: <code class="docutils literal notranslate"><span class="pre">main</span></code>,
<code class="docutils literal notranslate"><span class="pre">restricted</span></code>, <code class="docutils literal notranslate"><span class="pre">universe</span></code> and <code class="docutils literal notranslate"><span class="pre">multiverse</span></code>. The user may not want to
install proprietary packages, which will only be installed if the user
explicitly uses the backports target-release. The user may change this behavior
to install backports packages without the need of explicitly select it.</p>
</div>
<div class="section" id="see-also">
</section>
<section id="see-also">
<h2><span class="section-number">16.2.10. </span>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
<p><a class="reference external" href="https://backports.debian.org/">Official Debian Backports site</a></p>
<p><strong>cdist-type__apt_source</strong>(7)</p>
</div>
<div class="section" id="authors">
</section>
<section id="authors">
<h2><span class="section-number">16.2.11. </span>AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline"></a></h2>
<p>Matthias Stecher &lt;matthiasstecher at gmx.de&gt;</p>
</div>
<div class="section" id="copying">
</section>
<section id="copying">
<h2><span class="section-number">16.2.12. </span>COPYING<a class="headerlink" href="#copying" title="Permalink to this headline"></a></h2>
<p>Copyright (C) 2020 Matthias Stecher. 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 later version.</p>
</div>
</div>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.3. cdist-type__apt_default_release(7) &mdash; cdist 6.9.5 documentation</title>
<title>16.3. cdist-type__apt_default_release(7) &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -365,18 +365,18 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cdist-type-apt-default-release-7">
<section id="cdist-type-apt-default-release-7">
<h1><span class="section-number">16.3. </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">
<section id="name">
<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_default_release - Configure the default release for apt</p>
</div>
<div class="section" id="description">
</section>
<section id="description">
<h2><span class="section-number">16.3.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">
</section>
<section id="required-parameters">
<h2><span class="section-number">16.3.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>
@ -384,29 +384,29 @@ configuration value.</p>
'stable', 'testing', 'unstable', 'stretch', 'buster', '4.0', '5.0*'.</p>
</dd>
</dl>
</div>
<div class="section" id="optional-parameters">
</section>
<section id="optional-parameters">
<h2><span class="section-number">16.3.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">
</section>
<section id="examples">
<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>__apt_default_release --release stretch
</pre></div>
</div>
</div>
<div class="section" id="authors">
</section>
<section id="authors">
<h2><span class="section-number">16.3.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">
</section>
<section id="copying">
<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) 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
License, or (at your option) any later version.</p>
</div>
</div>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.4. cdist-type__apt_key(7) &mdash; cdist 6.9.5 documentation</title>
<title>16.4. cdist-type__apt_key(7) &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -365,21 +365,21 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cdist-type-apt-key-7">
<section id="cdist-type-apt-key-7">
<h1><span class="section-number">16.4. </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">
<section id="name">
<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 - Manage the list of keys used by apt</p>
</div>
<div class="section" id="description">
</section>
<section id="description">
<h2><span class="section-number">16.4.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">
</section>
<section id="required-parameters">
<h2><span class="section-number">16.4.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">
</section>
<section id="optional-parameters">
<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>
@ -394,8 +394,8 @@ in ./parameter/default/keyserver is used.</p>
<dt>uri</dt><dd><p>the URI from which to download the key</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
</section>
<section id="examples">
<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><span class="c1"># Add Ubuntu Archive Automatic Signing Key</span>
__apt_key 437D05B5
@ -415,20 +415,20 @@ __apt_key rabbitmq <span class="se">\</span>
--uri http://www.rabbitmq.com/rabbitmq-signing-key-public.asc
</pre></div>
</div>
</div>
<div class="section" id="authors">
</section>
<section id="authors">
<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;
Ander Punnar &lt;ander-at-kvlt-dot-ee&gt;</p>
</div>
<div class="section" id="copying">
</section>
<section id="copying">
<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-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
License, or (at your option) any later version.</p>
</div>
</div>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.5. cdist-type__apt_key_uri(7) &mdash; cdist 6.9.5 documentation</title>
<title>16.5. cdist-type__apt_key_uri(7) &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -365,24 +365,24 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cdist-type-apt-key-uri-7">
<section id="cdist-type-apt-key-uri-7">
<h1><span class="section-number">16.5. </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">
<section id="name">
<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_key_uri - Add apt key from uri</p>
</div>
<div class="section" id="description">
</section>
<section id="description">
<h2><span class="section-number">16.5.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">
</section>
<section id="required-parameters">
<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>uri</dt><dd><p>the uri from which to download the key</p>
</dd>
</dl>
</div>
<div class="section" id="optional-parameters">
</section>
<section id="optional-parameters">
<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>state</dt><dd><p>'present' or 'absent', defaults to 'present'</p>
@ -391,8 +391,8 @@
Defaults to __object_id</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
</section>
<section id="examples">
<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>__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>
@ -400,19 +400,19 @@ Defaults to __object_id</p>
--state present
</pre></div>
</div>
</div>
<div class="section" id="authors">
</section>
<section id="authors">
<h2><span class="section-number">16.5.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">
</section>
<section id="copying">
<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) 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
License, or (at your option) any later version.</p>
</div>
</div>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.6. cdist-type__apt_mark(7) &mdash; cdist 6.9.5 documentation</title>
<title>16.6. cdist-type__apt_mark(7) &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -365,31 +365,31 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cdist-type-apt-mark-7">
<section id="cdist-type-apt-mark-7">
<h1><span class="section-number">16.6. </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">
<section id="name">
<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_mark - set package state as 'hold' or 'unhold'</p>
</div>
<div class="section" id="description">
</section>
<section id="description">
<h2><span class="section-number">16.6.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">
</section>
<section id="required-parameters">
<h2><span class="section-number">16.6.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">
</section>
<section id="optional-parameters">
<h2><span class="section-number">16.6.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">
</section>
<section id="examples">
<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><span class="c1"># hold package</span>
__apt_mark quagga --state hold
@ -397,19 +397,19 @@ __apt_mark quagga --state hold
__apt_mark quagga --state unhold
</pre></div>
</div>
</div>
<div class="section" id="authors">
</section>
<section id="authors">
<h2><span class="section-number">16.6.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">
</section>
<section id="copying">
<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) 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
License, or (at your option) any later version.</p>
</div>
</div>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.7. cdist-type__apt_norecommends(7) &mdash; cdist 6.9.5 documentation</title>
<title>16.7. cdist-type__apt_norecommends(7) &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -365,43 +365,43 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cdist-type-apt-norecommends-7">
<section id="cdist-type-apt-norecommends-7">
<h1><span class="section-number">16.7. </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">
<section id="name">
<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_norecommends - Configure apt to not install recommended packages</p>
</div>
<div class="section" id="description">
</section>
<section id="description">
<h2><span class="section-number">16.7.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">
</section>
<section id="required-parameters">
<h2><span class="section-number">16.7.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">
</section>
<section id="optional-parameters">
<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">
</section>
<section id="examples">
<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>__apt_norecommends
</pre></div>
</div>
</div>
<div class="section" id="authors">
</section>
<section id="authors">
<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;
Dennis Camera &lt;<a class="reference external" href="mailto:dennis&#46;camera--&#37;&#52;&#48;--ssrq-sds-fds&#46;ch">dennis<span>&#46;</span>camera--<span>&#64;</span>--ssrq-sds-fds<span>&#46;</span>ch</a>&gt;</p>
</div>
<div class="section" id="copying">
</section>
<section id="copying">
<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) 2014 Steven Armstrong, 2020 Dennis Camera.
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 later version.</p>
</div>
</div>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.8. cdist-type__apt_ppa(7) &mdash; cdist 6.9.5 documentation</title>
<title>16.8. cdist-type__apt_ppa(7) &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -365,29 +365,29 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cdist-type-apt-ppa-7">
<section id="cdist-type-apt-ppa-7">
<h1><span class="section-number">16.8. </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">
<section id="name">
<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_ppa - Manage ppa repositories</p>
</div>
<div class="section" id="description">
</section>
<section id="description">
<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 manage ubuntu ppa repositories.</p>
</div>
<div class="section" id="required-parameters">
</section>
<section id="required-parameters">
<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>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">
</section>
<section id="optional-parameters">
<h2><span class="section-number">16.8.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">
</section>
<section id="examples">
<h2><span class="section-number">16.8.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
@ -398,19 +398,19 @@ __apt_ppa ppa:sans-intern/missing-bits --state present
__apt_ppa ppa:sans-intern/missing-bits --state absent
</pre></div>
</div>
</div>
<div class="section" id="authors">
</section>
<section id="authors">
<h2><span class="section-number">16.8.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">
</section>
<section id="copying">
<h2><span class="section-number">16.8.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
License, or (at your option) any later version.</p>
</div>
</div>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.9. cdist-type__apt_source(7) &mdash; cdist 6.9.5 documentation</title>
<title>16.9. cdist-type__apt_source(7) &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -366,25 +366,25 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cdist-type-apt-source-7">
<section id="cdist-type-apt-source-7">
<h1><span class="section-number">16.9. </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">
<section id="name">
<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_source - Manage apt sources</p>
</div>
<div class="section" id="description">
</section>
<section id="description">
<h2><span class="section-number">16.9.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">
</section>
<section id="required-parameters">
<h2><span class="section-number">16.9.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">
</section>
<section id="optional-parameters">
<h2><span class="section-number">16.9.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>
@ -397,15 +397,15 @@ the targets /etc/lsb-release</p>
<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">
</section>
<section id="boolean-parameters">
<h2><span class="section-number">16.9.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">
</section>
<section id="examples">
<h2><span class="section-number">16.9.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>
@ -419,19 +419,19 @@ __apt_source canonical_partner <span class="se">\</span>
--component partner --state present
</pre></div>
</div>
</div>
<div class="section" id="authors">
</section>
<section id="authors">
<h2><span class="section-number">16.9.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">
</section>
<section id="copying">
<h2><span class="section-number">16.9.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
License, or (at your option) any later version.</p>
</div>
</div>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.10. cdist-type__apt_unattended_upgrades(7) &mdash; cdist 6.9.5 documentation</title>
<title>16.10. cdist-type__apt_unattended_upgrades(7) &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -364,18 +364,18 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cdist-type-apt-unattended-upgrades-7">
<section id="cdist-type-apt-unattended-upgrades-7">
<h1><span class="section-number">16.10. </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">
<section id="name">
<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_unattended_upgrades - automatic installation of updates</p>
</div>
<div class="section" id="description">
</section>
<section id="description">
<h2><span class="section-number">16.10.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">
</section>
<section id="optional-multiple-parameters">
<h2><span class="section-number">16.10.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>
@ -403,8 +403,8 @@
<dt>blacklist</dt><dd><p>Python regular expressions, matching packages to exclude from upgrading.</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
</section>
<section id="examples">
<h2><span class="section-number">16.10.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>
@ -413,19 +413,19 @@
--blacklist open-iscsi
</pre></div>
</div>
</div>
<div class="section" id="authors">
</section>
<section id="authors">
<h2><span class="section-number">16.10.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">
</section>
<section id="copying">
<h2><span class="section-number">16.10.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
later version.</p>
</div>
</div>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.11. cdist-type__apt_update_index(7) &mdash; cdist 6.9.5 documentation</title>
<title>16.11. cdist-type__apt_update_index(7) &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -365,42 +365,42 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cdist-type-apt-update-index-7">
<section id="cdist-type-apt-update-index-7">
<h1><span class="section-number">16.11. </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">
<section id="name">
<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__apt_update_index - Update apt's package index</p>
</div>
<div class="section" id="description">
</section>
<section id="description">
<h2><span class="section-number">16.11.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">
</section>
<section id="required-parameters">
<h2><span class="section-number">16.11.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">
</section>
<section id="optional-parameters">
<h2><span class="section-number">16.11.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">
</section>
<section id="examples">
<h2><span class="section-number">16.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>__apt_update_index
</pre></div>
</div>
</div>
<div class="section" id="authors">
</section>
<section id="authors">
<h2><span class="section-number">16.11.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">
</section>
<section id="copying">
<h2><span class="section-number">16.11.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
License, or (at your option) any later version.</p>
</div>
</div>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.12. cdist-type__block(7) &mdash; cdist 6.9.5 documentation</title>
<title>16.12. cdist-type__block(7) &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -366,28 +366,28 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cdist-type-block-7">
<section id="cdist-type-block-7">
<h1><span class="section-number">16.12. </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">
<section id="name">
<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__block - Manage blocks of text in files</p>
</div>
<div class="section" id="description">
</section>
<section id="description">
<h2><span class="section-number">16.12.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">
</section>
<section id="required-parameters">
<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>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">
</section>
<section id="optional-parameters">
<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>file</dt><dd><p>the file in which to manage the text block.
@ -402,8 +402,8 @@ Defaults to #/cdist:__block/$__object_id</p>
<dt>state</dt><dd><p>'present' or 'absent', defaults to 'present'</p>
</dd>
</dl>
</div>
<div class="section" id="messages">
</section>
<section id="messages">
<h2><span class="section-number">16.12.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>
@ -413,8 +413,8 @@ Defaults to #/cdist:__block/$__object_id</p>
<dt>remove</dt><dd><p>block was removed</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
</section>
<section id="examples">
<h2><span class="section-number">16.12.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>
@ -431,19 +431,19 @@ __block some-id <span class="se">\</span>
<span class="s">DONE</span>
</pre></div>
</div>
</div>
<div class="section" id="authors">
</section>
<section id="authors">
<h2><span class="section-number">16.12.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">
</section>
<section id="copying">
<h2><span class="section-number">16.12.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
License, or (at your option) any later version.</p>
</div>
</div>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.13. cdist-type__ccollect_source(7) &mdash; cdist 6.9.5 documentation</title>
<title>16.13. cdist-type__ccollect_source(7) &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -368,17 +368,17 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cdist-type-ccollect-source-7">
<section id="cdist-type-ccollect-source-7">
<h1><span class="section-number">16.13. </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">
<section id="name">
<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__ccollect_source - Manage ccollect sources</p>
</div>
<div class="section" id="description">
</section>
<section id="description">
<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 create or delete ccollect sources.</p>
</div>
<div class="section" id="required-parameters">
</section>
<section id="required-parameters">
<h2><span class="section-number">16.13.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>
@ -386,8 +386,8 @@
<dt>destination</dt><dd><p>The destination directory</p>
</dd>
</dl>
</div>
<div class="section" id="optional-parameters">
</section>
<section id="optional-parameters">
<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>state</dt><dd><p>'present' or 'absent', defaults to 'present'</p>
@ -395,15 +395,15 @@
<dt>ccollectconf</dt><dd><p>The CCOLLECT_CONF directory. Defaults to /etc/ccollect.</p>
</dd>
</dl>
</div>
<div class="section" id="optional-multiple-parameters">
</section>
<section id="optional-multiple-parameters">
<h2><span class="section-number">16.13.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">
</section>
<section id="boolean-parameters">
<h2><span class="section-number">16.13.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>
@ -411,8 +411,8 @@
<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">
</section>
<section id="examples">
<h2><span class="section-number">16.13.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>
@ -428,23 +428,23 @@ __ccollect_source doc.ungleich.ch <span class="se">\</span>
--create-destination
</pre></div>
</div>
</div>
<div class="section" id="see-also">
</section>
<section id="see-also">
<h2><span class="section-number">16.13.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">
</section>
<section id="authors">
<h2><span class="section-number">16.13.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">
</section>
<section id="copying">
<h2><span class="section-number">16.13.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
License, or (at your option) any later version.</p>
</div>
</div>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.14. cdist-type__cdist(7) &mdash; cdist 6.9.5 documentation</title>
<title>16.14. cdist-type__cdist(7) &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -365,13 +365,13 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cdist-type-cdist-7">
<section id="cdist-type-cdist-7">
<h1><span class="section-number">16.14. </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">
<section id="name">
<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 - Manage cdist installations</p>
</div>
<div class="section" id="description">
</section>
<section id="description">
<h2><span class="section-number">16.14.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
@ -380,11 +380,11 @@ systems.</p>
It is only helpful to build FROM which you configure
other hosts.</p>
<p>This type will use git to clone</p>
</div>
<div class="section" id="required-parameters">
</section>
<section id="required-parameters">
<h2><span class="section-number">16.14.3. </span>REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="optional-parameters">
</section>
<section id="optional-parameters">
<h2><span class="section-number">16.14.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.
@ -397,8 +397,8 @@ Defaults to &quot;<a class="reference external" href="mailto:git&#37;&#52;&#48;c
Defaults to &quot;master&quot;.</p>
</dd>
</dl>
</div>
<div class="section" id="examples">
</section>
<section id="examples">
<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"># Install cdist for user cdist in her home as subfolder cdist</span>
__cdist /home/cdist/cdist
@ -407,19 +407,19 @@ __cdist /home/cdist/cdist
__cdist --source <span class="s2">&quot;git@code.ungleich.ch:ungleich-public/cdist.git&quot;</span> /home/cdist/cdist
</pre></div>
</div>
</div>
<div class="section" id="authors">
</section>
<section id="authors">
<h2><span class="section-number">16.14.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">
</section>
<section id="copying">
<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) 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
License, or (at your option) any later version.</p>
</div>
</div>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.15. cdist-type__cdist_preos_trigger(7) &mdash; cdist 6.9.5 documentation</title>
<title>16.15. cdist-type__cdist_preos_trigger(7) &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -365,47 +365,47 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cdist-type-cdist-preos-trigger-7">
<section id="cdist-type-cdist-preos-trigger-7">
<h1><span class="section-number">16.15. </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">
<section id="name">
<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__cdist_preos_trigger - configure cdist preos trigger</p>
</div>
<div class="section" id="description">
</section>
<section id="description">
<h2><span class="section-number">16.15.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">
</section>
<section id="required-parameters">
<h2><span class="section-number">16.15.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">
</section>
<section id="optional-parameters">
<h2><span class="section-number">16.15.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">
</section>
<section id="examples">
<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"># 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">
</section>
<section id="authors">
<h2><span class="section-number">16.15.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">
</section>
<section id="copying">
<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) 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
License, or (at your option) any later version.</p>
</div>
</div>
</section>
</section>
</div>

View file

@ -5,10 +5,11 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.16. cdist-type__cdistmarker(7) &mdash; cdist 6.9.5 documentation</title>
<title>16.16. cdist-type__cdistmarker(7) &mdash; cdist 6.9.6 documentation</title>
@ -24,7 +25,6 @@
<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>
@ -63,7 +63,7 @@
<div class="version">
6.9.5
6.9.6
</div>
@ -365,24 +365,24 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class