cdist-web/src/extra/manual/7.0.0/cdist-saving-output-streams...

219 lines
14 KiB
HTML

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>28. Saving output streams &mdash; cdist 7.0.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="29. Remote exec and copy commands" href="cdist-remote-exec-copy.html" />
<link rel="prev" title="27. Local cache overview" href="cdist-cache.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">
7.0.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" aria-label="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="Navigation menu">
<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-scan.html">22. Scan</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-integration.html">23. cdist integration / using cdist as library</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-reference.html">24. Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-best-practice.html">25. Best practice</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-stages.html">26. Execution stages</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-cache.html">27. Local cache overview</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">28. Saving output streams</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#description">28.1. Description</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cdist-remote-exec-copy.html">29. Remote exec and copy commands</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-hacker.html">30. Hacking</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-troubleshooting.html">31. 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="Mobile navigation menu" >
<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="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active"><span class="section-number">28. </span>Saving output streams</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cdist-saving-output-streams.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="saving-output-streams">
<h1><span class="section-number">28. </span>Saving output streams<a class="headerlink" href="#saving-output-streams" title="Permalink to this heading"></a></h1>
<section id="description">
<h2><span class="section-number">28.1. </span>Description<a class="headerlink" href="#description" title="Permalink to this heading"></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
during a config run, hidden in all other output.
Now all created output is bound to the context where it was produced.</p>
<p>Saving output streams include stdout and stderr of init manifest, remote
commands and for each object stdout and stderr of manifest, gencode-* and code-*.
Output stream files are created only if some output is produced. For more info
on these cache files see <a class="reference external" href="cdist-cache.html">Local cache overview</a>.</p>
<p>Also, in case of an error, cdist can now exit and show all information it has
about the error.</p>
<p>For example:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>./bin/cdist<span class="w"> </span>config<span class="w"> </span>-v<span class="w"> </span>-i<span class="w"> </span>~/.cdist/manifest/init-output-streams<span class="w"> </span><span class="k">$(</span>cat<span class="w"> </span>~/ungleich/data/opennebula-debian9-test<span class="w"> </span><span class="k">)</span>
INFO:<span class="w"> </span><span class="m">185</span>.203.112.42:<span class="w"> </span>Starting<span class="w"> </span>configuration<span class="w"> </span>run
INFO:<span class="w"> </span><span class="m">185</span>.203.112.42:<span class="w"> </span>Processing<span class="w"> </span>__myline/test
ERROR:<span class="w"> </span><span class="m">185</span>.203.112.42:<span class="w"> </span>Command<span class="w"> </span>failed:<span class="w"> </span><span class="s1">&#39;/bin/sh -e /tmp/tmpow6cwemh/75ee6a79e32da093da23fe4a13dd104b/data/object/__myline/test/.cdist-kisrqlpw/code-local&#39;</span>
<span class="k">return</span><span class="w"> </span>code:<span class="w"> </span><span class="m">1</span>
----<span class="w"> </span>BEGIN<span class="w"> </span>stdout<span class="w"> </span>----
----<span class="w"> </span>END<span class="w"> </span>stdout<span class="w"> </span>----
Error<span class="w"> </span>processing<span class="w"> </span>object<span class="w"> </span><span class="s1">&#39;__myline/test&#39;</span>
<span class="o">========================================</span>
name:<span class="w"> </span>__myline/test
path:<span class="w"> </span>/tmp/tmpow6cwemh/75ee6a79e32da093da23fe4a13dd104b/data/object/__myline/test/.cdist-kisrqlpw
source:<span class="w"> </span>/home/darko/.cdist/manifest/init-output-streams
type:<span class="w"> </span>/tmp/tmpow6cwemh/75ee6a79e32da093da23fe4a13dd104b/data/conf/type/__myline
----<span class="w"> </span>BEGIN<span class="w"> </span>manifest:stderr<span class="w"> </span>----
myline<span class="w"> </span>manifest<span class="w"> </span>stderr
----<span class="w"> </span>END<span class="w"> </span>manifest:stderr<span class="w"> </span>----
----<span class="w"> </span>BEGIN<span class="w"> </span>gencode-remote:stderr<span class="w"> </span>----
<span class="nb">test</span><span class="w"> </span>gencode-remote<span class="w"> </span>error
----<span class="w"> </span>END<span class="w"> </span>gencode-remote:stderr<span class="w"> </span>----
----<span class="w"> </span>BEGIN<span class="w"> </span>code-local:stderr<span class="w"> </span>----
error
----<span class="w"> </span>END<span class="w"> </span>code-local:stderr<span class="w"> </span>----
ERROR:<span class="w"> </span>cdist:<span class="w"> </span>Failed<span class="w"> </span>to<span class="w"> </span>configure<span class="w"> </span>the<span class="w"> </span>following<span class="w"> </span>hosts:<span class="w"> </span><span class="m">185</span>.203.112.42
</pre></div>
</div>
<p>Upon successful run execution state is saved to local cache and temporary
directory is removed.
In case of an error temporary directory is not removed and can be further
discovered.</p>
<p>There is also an option <strong>-S/--disable-saving-output-streams</strong> for
disabling saving output streams. In this case error reporting can look
like this:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>./bin/cdist<span class="w"> </span>config<span class="w"> </span>-v<span class="w"> </span>-S<span class="w"> </span>-i<span class="w"> </span>~/.cdist/manifest/init-output-streams<span class="w"> </span><span class="k">$(</span>cat<span class="w"> </span>~/ungleich/data/opennebula-debian9-test<span class="w"> </span><span class="k">)</span>
INFO:<span class="w"> </span><span class="m">185</span>.203.112.42:<span class="w"> </span>Starting<span class="w"> </span>configuration<span class="w"> </span>run
<span class="nb">test</span><span class="w"> </span>stdout<span class="w"> </span>output<span class="w"> </span>streams
<span class="nb">test</span><span class="w"> </span>stderr<span class="w"> </span>output<span class="w"> </span>streams
myline<span class="w"> </span>manifest<span class="w"> </span>stdout
myline<span class="w"> </span>manifest<span class="w"> </span>stderr
<span class="nb">test</span><span class="w"> </span>gencode-remote<span class="w"> </span>error
INFO:<span class="w"> </span><span class="m">185</span>.203.112.42:<span class="w"> </span>Processing<span class="w"> </span>__myline/test
error
ERROR:<span class="w"> </span><span class="m">185</span>.203.112.42:<span class="w"> </span>Command<span class="w"> </span>failed:<span class="w"> </span><span class="s1">&#39;/bin/sh -e /tmp/tmpzomy0wis/75ee6a79e32da093da23fe4a13dd104b/data/object/__myline/test/.cdist-n566pqut/code-local&#39;</span>
<span class="k">return</span><span class="w"> </span>code:<span class="w"> </span><span class="m">1</span>
----<span class="w"> </span>BEGIN<span class="w"> </span>stdout<span class="w"> </span>----
----<span class="w"> </span>END<span class="w"> </span>stdout<span class="w"> </span>----
Error<span class="w"> </span>processing<span class="w"> </span>object<span class="w"> </span><span class="s1">&#39;__myline/test&#39;</span>
<span class="o">========================================</span>
name:<span class="w"> </span>__myline/test
path:<span class="w"> </span>/tmp/tmpzomy0wis/75ee6a79e32da093da23fe4a13dd104b/data/object/__myline/test/.cdist-n566pqut
source:<span class="w"> </span>/home/darko/.cdist/manifest/init-output-streams
type:<span class="w"> </span>/tmp/tmpzomy0wis/75ee6a79e32da093da23fe4a13dd104b/data/conf/type/__myline
ERROR:<span class="w"> </span>cdist:<span class="w"> </span>Failed<span class="w"> </span>to<span class="w"> </span>configure<span class="w"> </span>the<span class="w"> </span>following<span class="w"> </span>hosts:<span class="w"> </span><span class="m">185</span>.203.112.42
</pre></div>
</div>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="cdist-cache.html" class="btn btn-neutral float-left" title="27. Local cache overview" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="cdist-remote-exec-copy.html" class="btn btn-neutral float-right" title="29. Remote exec and copy commands" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright ungleich GmbH 2021.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>