334 lines
12 KiB
HTML
334 lines
12 KiB
HTML
|
|
||
|
|
|
||
|
|
<!DOCTYPE html>
|
||
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8">
|
||
|
|
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
|
|
||
|
|
<title>12. Configuration — cdist 4.10.3 documentation</title>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
|
|
<link rel="index" title="Index" href="genindex.html" />
|
||
|
|
<link rel="search" title="Search" href="search.html" />
|
||
|
|
<link rel="next" title="13. Manifest" href="cdist-manifest.html" />
|
||
|
|
<link rel="prev" title="11. Bootstrap" href="cdist-bootstrap.html" />
|
||
|
|
|
||
|
|
|
||
|
|
<script src="_static/js/modernizr.min.js"></script>
|
||
|
|
|
||
|
|
</head>
|
||
|
|
|
||
|
|
<body class="wy-body-for-nav">
|
||
|
|
|
||
|
|
|
||
|
|
<div class="wy-grid-for-nav">
|
||
|
|
|
||
|
|
|
||
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
|
|
<div class="wy-side-scroll">
|
||
|
|
<div class="wy-side-nav-search">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<a href="index.html" class="icon icon-home"> cdist
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</a>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="version">
|
||
|
|
4.10.3
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div role="search">
|
||
|
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||
|
|
<input type="text" name="q" placeholder="Search docs" />
|
||
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
||
|
|
<input type="hidden" name="area" value="default" />
|
||
|
|
</form>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<ul class="current">
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-intro.html">1. cdist - usable configuration management</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-why.html">2. Why should I use cdist?</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-os.html">3. Supported Operating Systems</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-install.html">4. How to install cdist</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-update.html">5. How to update cdist</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-support.html">6. Support</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-features.html">7. Features</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-quickstart.html">8. Quickstart</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-real-world.html">9. Dive into real world cdist</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="man1/cdist.html">10. cdist(1)</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-bootstrap.html">11. Bootstrap</a></li>
|
||
|
|
<li class="toctree-l1 current"><a class="current reference internal" href="#">12. Configuration</a><ul>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="#description">12.1. Description</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="#config-file-format">12.2. Config file format</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-manifest.html">13. Manifest</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-type.html">14. cdist type</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-types.html">15. cdist types</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-explorer.html">16. Explorer</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-messaging.html">17. Messaging</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-parallelization.html">18. Parallelization</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-inventory.html">19. Inventory</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-integration.html">20. cdist integration / using cdist as library</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-reference.html">21. Reference</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-best-practice.html">22. Best practice</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-stages.html">23. Execution stages</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-cache.html">24. Local cache overview</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-saving-output-streams.html">25. Saving output streams</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-remote-exec-copy.html">26. Remote exec and copy commands</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-hacker.html">27. Hacking</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-troubleshooting.html">28. Troubleshooting</a></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||
|
|
|
||
|
|
|
||
|
|
<nav class="wy-nav-top" aria-label="top navigation">
|
||
|
|
|
||
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
|
|
<a href="index.html">cdist</a>
|
||
|
|
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="wy-nav-content">
|
||
|
|
|
||
|
|
<div class="rst-content">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
||
|
|
|
||
|
|
<ul class="wy-breadcrumbs">
|
||
|
|
|
||
|
|
<li><a href="index.html">Docs</a> »</li>
|
||
|
|
|
||
|
|
<li>12. Configuration</li>
|
||
|
|
|
||
|
|
|
||
|
|
<li class="wy-breadcrumbs-aside">
|
||
|
|
|
||
|
|
|
||
|
|
<a href="_sources/cdist-configuration.rst.txt" rel="nofollow"> View page source</a>
|
||
|
|
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
<hr/>
|
||
|
|
</div>
|
||
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
|
|
<div itemprop="articleBody">
|
||
|
|
|
||
|
|
<div class="section" id="configuration">
|
||
|
|
<h1>12. Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h1>
|
||
|
|
<div class="section" id="description">
|
||
|
|
<h2>12.1. Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>cdist obtains configuration data from the following sources in the following
|
||
|
|
order:</p>
|
||
|
|
<blockquote>
|
||
|
|
<div><ol class="arabic simple">
|
||
|
|
<li>command-line options</li>
|
||
|
|
<li>configuration file specified at command-line using -g command line option</li>
|
||
|
|
<li>configuration file specified in CDIST_CONFIG_FILE environment variable</li>
|
||
|
|
<li>environment variables</li>
|
||
|
|
<li>user's configuration file (first one found of ~/.cdist.cfg, $XDG_CONFIG_HOME/cdist/cdist.cfg, in specified order)</li>
|
||
|
|
<li>in-distribution configuration file (cdist/conf/cdist.cfg)</li>
|
||
|
|
<li>system-wide configuration file (/etc/cdist.cfg)</li>
|
||
|
|
</ol>
|
||
|
|
</div></blockquote>
|
||
|
|
<p>if one exists.</p>
|
||
|
|
<p>Configuration source with lower ordering number from above has a higher
|
||
|
|
precedence. Configuration option value read from source with higher
|
||
|
|
precedence will overwrite option value, if exists, read from source with
|
||
|
|
lower precedence. That means that command-line option wins them all.</p>
|
||
|
|
<p>Users can decide on the local conifguration file location. It can be either
|
||
|
|
~/.cdist.cfg or $XDG_CONFIG_HOME/cdist/cdist.cfg. Note that, if both exist,
|
||
|
|
then ~/.cdist.cfg is used.</p>
|
||
|
|
<p>For a per-project configuration, particular environment variables or better,
|
||
|
|
CDIST_CONFIG_FILE environment variable or -g CONFIG_FILE command line option,
|
||
|
|
can be used.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="config-file-format">
|
||
|
|
<h2>12.2. 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.
|
||
|
|
The possible keywords and their meanings are as follows:</p>
|
||
|
|
<dl class="docutils">
|
||
|
|
<dt><strong>archiving</strong></dt>
|
||
|
|
<dd>Use specified archiving. Valid values include:
|
||
|
|
'none', 'tar', 'tgz', 'tbz2' and 'txz'.</dd>
|
||
|
|
<dt><strong>beta</strong></dt>
|
||
|
|
<dd>Enable beta functionality. It recognizes boolean values from
|
||
|
|
'yes'/'no', 'on'/'off', 'true'/'false' and '1'/'0'.</dd>
|
||
|
|
<dt><strong>cache_path_pattern</strong></dt>
|
||
|
|
<dd>Specify cache path pattern.</dd>
|
||
|
|
<dt><strong>conf_dir</strong></dt>
|
||
|
|
<dd>List of configuration directories separated with the character conventionally
|
||
|
|
used by the operating system to separate search path components (as in PATH),
|
||
|
|
such as ':' for POSIX or ';' for Windows.
|
||
|
|
If also specified at command line then values from command line are
|
||
|
|
appended to this value.</dd>
|
||
|
|
<dt><strong>init_manifest</strong></dt>
|
||
|
|
<dd>Specify default initial manifest.</dd>
|
||
|
|
<dt><strong>inventory_dir</strong></dt>
|
||
|
|
<dd>Specify inventory directory.</dd>
|
||
|
|
<dt><strong>jobs</strong></dt>
|
||
|
|
<dd>Specify number of jobs for parallel processing. If -1 then the default,
|
||
|
|
number of CPU's in the system is used. If 0 then parallel processing in
|
||
|
|
jobs is disabled. If set to positive number then specified maximum
|
||
|
|
number of processes will be used.</dd>
|
||
|
|
<dt><strong>local_shell</strong></dt>
|
||
|
|
<dd>Shell command used for local execution.</dd>
|
||
|
|
<dt><strong>out_path</strong></dt>
|
||
|
|
<dd>Directory to save cdist output in.</dd>
|
||
|
|
<dt><strong>parallel</strong></dt>
|
||
|
|
<dd>Process hosts in parallel. If -1 then the default, number of CPU's in
|
||
|
|
the system is used. If 0 then parallel processing of hosts is disabled.
|
||
|
|
If set to positive number then specified maximum number of processes
|
||
|
|
will be used.</dd>
|
||
|
|
<dt><strong>remote_copy</strong></dt>
|
||
|
|
<dd>Command to use for remote copy (should behave like scp).</dd>
|
||
|
|
<dt><strong>remote_exec</strong></dt>
|
||
|
|
<dd>Command to use for remote execution (should behave like ssh).</dd>
|
||
|
|
<dt><strong>remote_out_path</strong></dt>
|
||
|
|
<dd>Directory to save cdist output in on the target host.</dd>
|
||
|
|
<dt><strong>remote_shell</strong></dt>
|
||
|
|
<dd>Shell command at remote host used for remote execution.</dd>
|
||
|
|
<dt><strong>save_output_streams</strong></dt>
|
||
|
|
<dd>Enable/disable saving output streams (enabled by default).
|
||
|
|
It recognizes boolean values from 'yes'/'no', 'on'/'off', 'true'/'false'
|
||
|
|
and '1'/'0'.</dd>
|
||
|
|
<dt><strong>verbosity</strong></dt>
|
||
|
|
<dd>Set verbosity level. Valid values are:
|
||
|
|
'ERROR', 'WARNING', 'INFO', 'VERBOSE', 'DEBUG', 'TRACE' and 'OFF'.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<footer>
|
||
|
|
|
||
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||
|
|
|
||
|
|
<a href="cdist-manifest.html" class="btn btn-neutral float-right" title="13. Manifest" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||
|
|
|
||
|
|
|
||
|
|
<a href="cdist-bootstrap.html" class="btn btn-neutral" title="11. Bootstrap" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<hr/>
|
||
|
|
|
||
|
|
<div role="contentinfo">
|
||
|
|
<p>
|
||
|
|
© Copyright .
|
||
|
|
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
|
|
||
|
|
</footer>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<script type="text/javascript">
|
||
|
|
var DOCUMENTATION_OPTIONS = {
|
||
|
|
URL_ROOT:'./',
|
||
|
|
VERSION:'4.10.3',
|
||
|
|
LANGUAGE:'None',
|
||
|
|
COLLAPSE_INDEX:false,
|
||
|
|
FILE_SUFFIX:'.html',
|
||
|
|
HAS_SOURCE: true,
|
||
|
|
SOURCELINK_SUFFIX: '.txt'
|
||
|
|
};
|
||
|
|
</script>
|
||
|
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||
|
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||
|
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||
|
|
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||
|
|
|
||
|
|
<script type="text/javascript">
|
||
|
|
jQuery(function () {
|
||
|
|
SphinxRtdTheme.Navigation.enable(true);
|
||
|
|
});
|
||
|
|
</script>
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|