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="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
|
||
|
|
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
|
|
||
|
|
<title>26. Local cache overview — cdist 6.9.6 documentation</title>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||
|
|
|
||
|
|
|
||
|
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||
|
|
<script src="_static/jquery.js"></script>
|
||
|
|
<script src="_static/underscore.js"></script>
|
||
|
|
<script src="_static/doctools.js"></script>
|
||
|
|
|
||
|
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<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="27. Saving output streams" href="cdist-saving-output-streams.html" />
|
||
|
|
<link rel="prev" title="25. Execution stages" href="cdist-stages.html" />
|
||
|
|
</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
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<img src="_static/cdist-logo.jpeg" class="logo" alt="Logo"/>
|
||
|
|
|
||
|
|
</a>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="version">
|
||
|
|
6.9.6
|
||
|
|
</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-why.html">1. Why should I use cdist?</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-features.html">2. Features</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-upgrade.html">5. How to upgrade 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-quickstart.html">7. Quickstart</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-real-world.html">8. Dive into real world cdist</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="man1/cdist-dump.html">10. cdist-dump(1)</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="man1/cdist-new-type.html">11. cdist-new-type(1)</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-bootstrap.html">12. Bootstrap</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-configuration.html">13. Configuration</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-manifest.html">14. Manifest</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-type.html">15. cdist type</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-types.html">16. cdist types</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-explorer.html">17. Explorer</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-messaging.html">18. Messaging</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-parallelization.html">19. Parallelization</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-inventory.html">20. Inventory</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-preos.html">21. PreOS</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-integration.html">22. cdist integration / using cdist as library</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-reference.html">23. Reference</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-best-practice.html">24. Best practice</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-stages.html">25. Execution stages</a></li>
|
||
|
|
<li class="toctree-l1 current"><a class="current reference internal" href="#">26. Local cache overview</a><ul>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="#description">26.1. Description</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="#cache-overview">26.2. Cache overview</a><ul>
|
||
|
|
<li class="toctree-l3"><a class="reference internal" href="#object-cache-overview">26.2.1. Object cache overview</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-saving-output-streams.html">27. Saving output streams</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-remote-exec-copy.html">28. Remote exec and copy commands</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-hacker.html">29. Hacking</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-troubleshooting.html">30. 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><span class="section-number">26. </span>Local cache overview</li>
|
||
|
|
|
||
|
|
|
||
|
|
<li class="wy-breadcrumbs-aside">
|
||
|
|
|
||
|
|
|
||
|
|
<a href="_sources/cdist-cache.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">
|
||
|
|
|
||
|
|
<section id="local-cache-overview">
|
||
|
|
<h1><span class="section-number">26. </span>Local cache overview<a class="headerlink" href="#local-cache-overview" title="Permalink to this headline">¶</a></h1>
|
||
|
|
<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>While executing, cdist stores data to local cache. Currently this feature is
|
||
|
|
one way only. That means that cdist does not use stored data for future runs.
|
||
|
|
Anyway, those data can be used for debugging cdist, debugging types and
|
||
|
|
debugging after host configuration fails.</p>
|
||
|
|
<p>Local cache is saved under $HOME/.cdist/cache directory, one directory entry
|
||
|
|
for each host. Subdirectory path is specified by
|
||
|
|
<strong>-C/--cache-path-pattern</strong> option, <strong>cache_path_pattern</strong>
|
||
|
|
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>
|
||
|
|
</section>
|
||
|
|
<section id="cache-overview">
|
||
|
|
<h2><span class="section-number">26.2. </span>Cache overview<a class="headerlink" href="#cache-overview" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>As noted above each configured host has got its subdirectory in local cache.
|
||
|
|
Entries in host's cache directory are as follows.</p>
|
||
|
|
<dl class="simple">
|
||
|
|
<dt>bin</dt><dd><p>directory with cdist type emulators</p>
|
||
|
|
</dd>
|
||
|
|
<dt>conf</dt><dd><p>dynamically determined cdist conf directory, union of all specified
|
||
|
|
conf directories</p>
|
||
|
|
</dd>
|
||
|
|
<dt>explorer</dt><dd><p>directory containing global explorer named files containing explorer output
|
||
|
|
after running on target host</p>
|
||
|
|
</dd>
|
||
|
|
<dt>messages</dt><dd><p>file containing messages</p>
|
||
|
|
</dd>
|
||
|
|
<dt>object</dt><dd><p>directory containing subdirectory for each cdist object</p>
|
||
|
|
</dd>
|
||
|
|
<dt>object_marker</dt><dd><p>object marker for this particular cdist run</p>
|
||
|
|
</dd>
|
||
|
|
<dt>stderr</dt><dd><p>directory containing init manifest and remote stderr stream output</p>
|
||
|
|
</dd>
|
||
|
|
<dt>stdout</dt><dd><p>directory containing init manifest and remote stdout stream output</p>
|
||
|
|
</dd>
|
||
|
|
<dt>target_host</dt><dd><p>file containing target host of this cdist run, as specified when running
|
||
|
|
cdist</p>
|
||
|
|
</dd>
|
||
|
|
<dt>typeorder</dt><dd><p>file containing types in order of execution.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<section id="object-cache-overview">
|
||
|
|
<h3><span class="section-number">26.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>
|
||
|
|
<dt>code-remote</dt><dd><p>code generated from gencode-remote, present only if something is
|
||
|
|
generated</p>
|
||
|
|
</dd>
|
||
|
|
<dt>explorer</dt><dd><p>directory containing type explorer named files containing explorer output
|
||
|
|
after running on target host</p>
|
||
|
|
</dd>
|
||
|
|
<dt>files</dt><dd><p>directory with object files created during type execution</p>
|
||
|
|
</dd>
|
||
|
|
<dt>parameter</dt><dd><p>directory containing type parameter named files containing parameter
|
||
|
|
values</p>
|
||
|
|
</dd>
|
||
|
|
<dt>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>
|
||
|
|
</dd>
|
||
|
|
<dt>stderr</dt><dd><p>directory containing type's manifest, gencode-* and code-* stderr stream
|
||
|
|
outputs</p>
|
||
|
|
</dd>
|
||
|
|
<dt>stdin</dt><dd><p>this type stdin content</p>
|
||
|
|
</dd>
|
||
|
|
<dt>stdout</dt><dd><p>directory containing type's manifest, gencode-* and code-* stdout stream
|
||
|
|
outputs.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<footer>
|
||
|
|
|
||
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||
|
|
|
||
|
|
<a href="cdist-saving-output-streams.html" class="btn btn-neutral float-right" title="27. Saving output streams" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||
|
|
|
||
|
|
|
||
|
|
<a href="cdist-stages.html" class="btn btn-neutral float-left" title="25. Execution stages" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<hr/>
|
||
|
|
|
||
|
|
<div role="contentinfo">
|
||
|
|
<p>
|
||
|
|
© Copyright ungleich GmbH 2020
|
||
|
|
|
||
|
|
</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">
|
||
|
|
jQuery(function () {
|
||
|
|
SphinxRtdTheme.Navigation.enable(true);
|
||
|
|
});
|
||
|
|
</script>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|