www.nico.schottelius.org/software/cdist/man/4.8.0/cdist-cache.html
2018-02-14 20:13:16 +01:00

343 lines
No EOL
11 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>23. Local cache overview &mdash; cdist 4.8.0 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.8.0 documentation" href="index.html"/>
<link rel="next" title="24. Saving output streams" href="cdist-saving-output-streams.html"/>
<link rel="prev" title="22. Execution stages" href="cdist-stages.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.8.0
</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="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-configuration.html">11. Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-manifest.html">12. Manifest</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-type.html">13. cdist type</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-types.html">14. cdist types</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-explorer.html">15. Explorer</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-messaging.html">16. Messaging</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-parallelization.html">17. Parallelization</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-inventory.html">18. Inventory</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-integration.html">19. cdist integration / using cdist as library</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-reference.html">20. Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-best-practice.html">21. Best practice</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-stages.html">22. Execution stages</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">23. Local cache overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#description">23.1. Description</a></li>
<li class="toctree-l2"><a class="reference internal" href="#cache-overview">23.2. Cache overview</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#object-cache-overview">23.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">24. Saving output streams</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-remote-exec-copy.html">25. Remote exec and copy commands</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-hacker.html">26. Hacking</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-troubleshooting.html">27. 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> &raquo;</li>
<li>23. 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">
<div class="section" id="local-cache-overview">
<h1>23. Local cache overview<a class="headerlink" href="#local-cache-overview" title="Permalink to this headline"></a></h1>
<div class="section" id="description">
<h2>23.1. Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<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>
</div>
<div class="section" id="cache-overview">
<h2>23.2. Cache overview<a class="headerlink" href="#cache-overview" title="Permalink to this headline"></a></h2>
<p>As noted above each configured host has got its subdirectory in local cache.
Entries in host's cache directory are as follows.</p>
<dl class="docutils">
<dt>bin</dt>
<dd>directory with cdist type emulators</dd>
<dt>conf</dt>
<dd>dynamically determined cdist conf directory, union of all specified
conf directories</dd>
<dt>explorer</dt>
<dd>directory containing global explorer named files containing explorer output
after running on target host</dd>
<dt>messages</dt>
<dd>file containing messages</dd>
<dt>object</dt>
<dd>directory containing subdirectory for each cdist object</dd>
<dt>object_marker</dt>
<dd>object marker for this particular cdist run</dd>
<dt>stderr</dt>
<dd>directory containing init manifest and remote stderr stream output</dd>
<dt>stdout</dt>
<dd>directory containing init manifest and remote stdout stream output</dd>
<dt>target_host</dt>
<dd>file containing target host of this cdist run, as specified when running
cdist</dd>
<dt>typeorder</dt>
<dd>file containing types in order of execution.</dd>
</dl>
<div class="section" id="object-cache-overview">
<h3>23.2.1. Object cache overview<a class="headerlink" href="#object-cache-overview" title="Permalink to this headline"></a></h3>
<p>Each object under <strong>object</strong> directory has its own structurue.</p>
<dl class="docutils">
<dt>code-local</dt>
<dd>code generated from gencode-local, present only if something is
generated</dd>
<dt>code-remote</dt>
<dd>code generated from gencode-remote, present only if something is
generated</dd>
<dt>explorer</dt>
<dd>directory containing type explorer named files containing explorer output
after running on target host</dd>
<dt>files</dt>
<dd>directory with object files created during type execution</dd>
<dt>parameter</dt>
<dd>directory containing type parameter named files containing parameter
values</dd>
<dt>source</dt>
<dd>this type's source (init manifest)</dd>
<dt>state</dt>
<dd>this type execution state ('done' when finished)</dd>
<dt>stderr</dt>
<dd>directory containing type's manifest, gencode-* and code-* stderr stream
outputs</dd>
<dt>stdin</dt>
<dd>this type stdin content</dd>
<dt>stdout</dt>
<dd>directory containing type's manifest, gencode-* and code-* stdout stream
outputs.</dd>
</dl>
</div>
</div>
</div>
</div>
<div class="articleComments">
</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="24. 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" title="22. Execution stages" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; 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.8.0',
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="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>