356 lines
14 KiB
HTML
356 lines
14 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>4. How to install cdist — cdist 4.4.1 documentation</title>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<link rel="index" title="Index"
|
||
|
|
href="genindex.html"/>
|
||
|
|
<link rel="search" title="Search" href="search.html"/>
|
||
|
|
<link rel="top" title="cdist 4.4.1 documentation" href="index.html"/>
|
||
|
|
<link rel="next" title="5. How to update cdist" href="cdist-update.html"/>
|
||
|
|
<link rel="prev" title="3. Supported Operating Systems" href="cdist-os.html"/>
|
||
|
|
|
||
|
|
|
||
|
|
<script src="_static/js/modernizr.min.js"></script>
|
||
|
|
|
||
|
|
</head>
|
||
|
|
|
||
|
|
<body class="wy-body-for-nav" role="document">
|
||
|
|
|
||
|
|
<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.4.1
|
||
|
|
</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 current"><a class="current reference internal" href="#">4. How to install cdist</a><ul>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="#requirements">4.1. Requirements</a><ul>
|
||
|
|
<li class="toctree-l3"><a class="reference internal" href="#source-host">4.1.1. Source Host</a></li>
|
||
|
|
<li class="toctree-l3"><a class="reference internal" href="#target-hosts">4.1.2. Target Hosts</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="#install-cdist">4.2. Install cdist</a><ul>
|
||
|
|
<li class="toctree-l3"><a class="reference internal" href="#from-git">4.2.1. From git</a><ul>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="#available-versions-in-git">4.2.1.1. Available versions in git</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="#git-mirrors">4.2.1.2. Git mirrors</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="#building-and-using-documentation-man-and-html">4.2.1.3. Building and using documentation (man and html)</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="toctree-l3"><a class="reference internal" href="#python-package">4.2.2. Python package</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</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="man1/cdist.html">9. cdist(1)</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-bootstrap.html">10. Bootstrap</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-manifest.html">11. Manifest</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-type.html">12. cdist type</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-types.html">13. cdist types</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-explorer.html">14. Explorer</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-messaging.html">15. Messaging</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-parallelization.html">16. Parallelization</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-reference.html">17. Reference</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-best-practice.html">18. Best practice</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-stages.html">19. Execution stages</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-remote-exec-copy.html">20. Remote exec and copy commands</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-hacker.html">21. Hacking</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-troubleshooting.html">22. Troubleshooting</a></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||
|
|
|
||
|
|
|
||
|
|
<nav class="wy-nav-top" role="navigation" 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>4. How to install cdist</li>
|
||
|
|
<li class="wy-breadcrumbs-aside">
|
||
|
|
|
||
|
|
|
||
|
|
<a href="_sources/cdist-install.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="how-to-install-cdist">
|
||
|
|
<h1>4. How to install cdist<a class="headerlink" href="#how-to-install-cdist" title="Permalink to this headline">¶</a></h1>
|
||
|
|
<div class="section" id="requirements">
|
||
|
|
<h2>4.1. Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<div class="section" id="source-host">
|
||
|
|
<h3>4.1.1. Source Host<a class="headerlink" href="#source-host" title="Permalink to this headline">¶</a></h3>
|
||
|
|
<p>This is the machine you use to configure the target hosts.</p>
|
||
|
|
<blockquote>
|
||
|
|
<div><ul class="simple">
|
||
|
|
<li>/bin/sh: A posix like shell (for instance bash, dash, zsh)</li>
|
||
|
|
<li>Python >= 3.2</li>
|
||
|
|
<li>SSH client</li>
|
||
|
|
<li>sphinx (for building html docs and/or the man pages)</li>
|
||
|
|
</ul>
|
||
|
|
</div></blockquote>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="target-hosts">
|
||
|
|
<h3>4.1.2. Target Hosts<a class="headerlink" href="#target-hosts" title="Permalink to this headline">¶</a></h3>
|
||
|
|
<blockquote>
|
||
|
|
<div><ul class="simple">
|
||
|
|
<li>/bin/sh: A posix like shell (for instance bash, dash, zsh)</li>
|
||
|
|
<li>SSH server</li>
|
||
|
|
</ul>
|
||
|
|
</div></blockquote>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="install-cdist">
|
||
|
|
<h2>4.2. Install cdist<a class="headerlink" href="#install-cdist" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>You can install cdist either from git or as a python package.</p>
|
||
|
|
<div class="section" id="from-git">
|
||
|
|
<h3>4.2.1. From git<a class="headerlink" href="#from-git" title="Permalink to this headline">¶</a></h3>
|
||
|
|
<p>Cloning cdist from git gives you the advantage of having
|
||
|
|
a version control in place for development of your own stuff
|
||
|
|
immediately.</p>
|
||
|
|
<p>To install cdist, execute the following commands:</p>
|
||
|
|
<div class="highlight-sh"><div class="highlight"><pre><span></span>git clone https://github.com/ungleich/cdist.git
|
||
|
|
<span class="nb">cd</span> cdist
|
||
|
|
<span class="nb">export</span> <span class="nv">PATH</span><span class="o">=</span><span class="nv">$PATH</span>:<span class="k">$(</span><span class="nb">pwd</span> -P<span class="k">)</span>/bin
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="available-versions-in-git">
|
||
|
|
<h4>4.2.1.1. Available versions in git<a class="headerlink" href="#available-versions-in-git" title="Permalink to this headline">¶</a></h4>
|
||
|
|
<blockquote>
|
||
|
|
<div><ul class="simple">
|
||
|
|
<li>The active development takes place in the <strong>master</strong> branch</li>
|
||
|
|
<li>The released versions can be found in the tags</li>
|
||
|
|
</ul>
|
||
|
|
</div></blockquote>
|
||
|
|
<p>Other branches may be available for features or bugfixes, but they
|
||
|
|
may vanish at any point. To select a specific branch use</p>
|
||
|
|
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># Generic code</span>
|
||
|
|
git checkout -b <localbranchname> origin/<branchname>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>So for instance if you want to use and stay with version 4.1, you can use</p>
|
||
|
|
<div class="highlight-sh"><div class="highlight"><pre><span></span>git checkout -b 4.1 origin/4.1
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="git-mirrors">
|
||
|
|
<h4>4.2.1.2. Git mirrors<a class="headerlink" href="#git-mirrors" title="Permalink to this headline">¶</a></h4>
|
||
|
|
<p>If the main site is down, you can acquire cdist from one of the following sites:</p>
|
||
|
|
<blockquote>
|
||
|
|
<div><ul class="simple">
|
||
|
|
<li>git://github.com/telmich/cdist.git <a class="reference external" href="https://github.com/telmich/cdist">github</a></li>
|
||
|
|
<li>git://git.code.sf.net/p/cdist/code <a class="reference external" href="https://sourceforge.net/p/cdist/code">sourceforge</a></li>
|
||
|
|
</ul>
|
||
|
|
</div></blockquote>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="building-and-using-documentation-man-and-html">
|
||
|
|
<h4>4.2.1.3. Building and using documentation (man and html)<a class="headerlink" href="#building-and-using-documentation-man-and-html" title="Permalink to this headline">¶</a></h4>
|
||
|
|
<p>If you want to build and use the documentation, run:</p>
|
||
|
|
<div class="highlight-sh"><div class="highlight"><pre><span></span>make docs
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>Documentation comes in two formats, man pages and full HTML
|
||
|
|
documentation. Documentation is built into distribution's
|
||
|
|
docs/dist directory. man pages are in docs/dist/man and
|
||
|
|
HTML documentation in docs/dist/html.</p>
|
||
|
|
<p>If you want to use man pages, run:</p>
|
||
|
|
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="nb">export</span> <span class="nv">MANPATH</span><span class="o">=</span><span class="nv">$MANPATH</span>:<span class="k">$(</span><span class="nb">pwd</span> -P<span class="k">)</span>/docs/dist/man
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>Or you can move man pages from docs/dist/man directory to some
|
||
|
|
other directory and add it to MANPATH.</p>
|
||
|
|
<p>Full HTML documentation can be accessed at docs/dist/html/index.html.</p>
|
||
|
|
<p>You can also build only man pages or only html documentation, for
|
||
|
|
only man pages run:</p>
|
||
|
|
<div class="highlight-sh"><div class="highlight"><pre><span></span>make man
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>for only html documentation run:</p>
|
||
|
|
<div class="highlight-sh"><div class="highlight"><pre><span></span>make html
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>You can also build man pages for types in your ~/.cdist directory:</p>
|
||
|
|
<div class="highlight-sh"><div class="highlight"><pre><span></span>make dotman
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>Built man pages are now in docs/dist/man directory. If you have
|
||
|
|
some other custom .cdist directory, e.g. /opt/cdist then use:</p>
|
||
|
|
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="nv">DOT_CDIST_PATH</span><span class="o">=</span>/opt/cdist make dotman
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="python-package">
|
||
|
|
<h3>4.2.2. Python package<a class="headerlink" href="#python-package" title="Permalink to this headline">¶</a></h3>
|
||
|
|
<p>Cdist is available as a python package at
|
||
|
|
<a class="reference external" href="http://pypi.python.org/pypi/cdist/">PyPi</a>. You can install it using</p>
|
||
|
|
<div class="highlight-sh"><div class="highlight"><pre><span></span>pip install cdist
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<footer>
|
||
|
|
|
||
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||
|
|
|
||
|
|
<a href="cdist-update.html" class="btn btn-neutral float-right" title="5. How to update cdist" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||
|
|
|
||
|
|
|
||
|
|
<a href="cdist-os.html" class="btn btn-neutral" title="3. Supported Operating Systems" accesskey="p"><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/snide/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.4.1',
|
||
|
|
COLLAPSE_INDEX:false,
|
||
|
|
FILE_SUFFIX:'.html',
|
||
|
|
HAS_SOURCE: true
|
||
|
|
};
|
||
|
|
</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="_static/js/theme.js"></script>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<script type="text/javascript">
|
||
|
|
jQuery(function () {
|
||
|
|
SphinxRtdTheme.StickyNav.enable();
|
||
|
|
});
|
||
|
|
</script>
|
||
|
|
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|