2019-04-23 18:55:23 +00:00
<!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" >
2019-11-26 18:33:52 +00:00
< title > 31. Troubleshooting — cdist 6.1.1 documentation< / title >
2019-04-23 18:55:23 +00:00
< script type = "text/javascript" src = "_static/js/modernizr.min.js" > < / script >
2019-05-17 11:33:31 +00:00
< script type = "text/javascript" >
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
2019-11-26 18:33:52 +00:00
VERSION:'6.1.1',
2019-05-17 11:33:31 +00:00
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
< / script >
2019-04-23 18:55:23 +00:00
< 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 >
< 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" / >
2019-05-22 16:44:06 +00:00
< link rel = "prev" title = "30. Hacking" href = "cdist-hacker.html" / >
2019-04-23 18:55:23 +00:00
< / 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
2019-05-04 22:18:20 +00:00
< img src = "_static/cdist-logo.jpeg" class = "logo" alt = "Logo" / >
2019-04-23 18:55:23 +00:00
< / a >
< div class = "version" >
2019-11-26 18:33:52 +00:00
6.1.1
2019-04-23 18:55:23 +00:00
< / 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" >
2019-05-04 22:18:20 +00:00
< 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 >
2019-04-23 18:55:23 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-install.html" > 4. How to install cdist< / a > < / li >
2019-05-04 22:18:20 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-upgrade.html" > 5. How to upgrade cdist< / a > < / li >
2019-04-23 18:55:23 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-support.html" > 6. Support< / a > < / li >
2019-05-04 22:18:20 +00:00
< 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 >
2019-05-22 16:44:06 +00:00
< 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-trigger.html" > 21. Trigger< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-preos.html" > 22. PreOS< / 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" > < a class = "reference internal" href = "cdist-saving-output-streams.html" > 28. Saving output streams< / a > < / 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 current" > < a class = "current reference internal" href = "#" > 31. Troubleshooting< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "#error-in-manifest-is-not-considered-an-error-by-cdist" > 31.1. Error in manifest is not considered an error by cdist< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#using-debug-dump-helper-script" > 31.2. Using debug dump helper script< / a > < / li >
2019-04-23 18:55:23 +00:00
< / ul >
< / 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 >
2019-05-22 16:44:06 +00:00
< li > 31. Troubleshooting< / li >
2019-04-23 18:55:23 +00:00
< li class = "wy-breadcrumbs-aside" >
< a href = "_sources/cdist-troubleshooting.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 = "troubleshooting" >
2019-05-22 16:44:06 +00:00
< h1 > 31. Troubleshooting< a class = "headerlink" href = "#troubleshooting" title = "Permalink to this headline" > ¶< / a > < / h1 >
2019-04-23 18:55:23 +00:00
< div class = "section" id = "error-in-manifest-is-not-considered-an-error-by-cdist" >
2019-05-22 16:44:06 +00:00
< h2 > 31.1. Error in manifest is not considered an error by cdist< a class = "headerlink" href = "#error-in-manifest-is-not-considered-an-error-by-cdist" title = "Permalink to this headline" > ¶< / a > < / h2 >
2019-04-23 18:55:23 +00:00
< p > Situation: You are executing other scripts from a manifest.
This script fails, but cdist does not recognise the error.
An example script would be something like this:< / p >
2019-05-17 11:33:31 +00:00
< div class = "highlight-sh" > < div class = "highlight" > < pre > < span > < / span > % cat ~/.cdist/manifest/init
2019-04-23 18:55:23 +00:00
< span class = "s2" > " < / span > < span class = "nv" > $__manifest< / span > < span class = "s2" > /special" < / span >
% cat ~/.cdist/manifest/special
< span class = "c1" > #!/bin/sh< / span >
< span class = "nb" > echo< / span > < span class = "s2" > " Here is an unclean exiting script" < / span >
somecommandthatdoesnotexist
< span class = "nb" > echo< / span > < span class = "s2" > " I continue here although previous command failed" < / span >
< / pre > < / div >
< / div >
< p > We can clearly see that < strong > somecommandthatdoesnotexist< / strong >
will fail in ~/.cdist/manifest/special. But as the custom
script is not called with the -e flag (exit on failure) of shell,
it does not lead to an error. And thus cdist sees the exit 0
code of the last echo line instead of the failing command.< / p >
< p > All scripts executed by cdist carry the -e flag.
To prevent the above from happening, there are three solutions available,
two of which can be used in the calling script:< / p >
2019-05-17 11:33:31 +00:00
< div class = "highlight-sh" > < div class = "highlight" > < pre > < span > < / span > < span class = "c1" > # Execute as before, but abort on failure< / span >
2019-04-23 18:55:23 +00:00
sh -e < span class = "s2" > " < / span > < span class = "nv" > $__manifest< / span > < span class = "s2" > /special" < / span >
< span class = "c1" > # Source the script in our namespace, runs in a set -e environment:< / span >
. < span class = "s2" > " < / span > < span class = "nv" > $__manifest< / span > < span class = "s2" > /special" < / span >
< / pre > < / div >
< / div >
< p > The third solution is to include a shebang header in every script
you write to use the -e flag:< / p >
2019-05-17 11:33:31 +00:00
< div class = "highlight-sh" > < div class = "highlight" > < pre > < span > < / span > % cat ~/.cdist/manifest/special
2019-04-23 18:55:23 +00:00
< span class = "c1" > #!/bin/sh -e< / span >
...
< / pre > < / div >
< / div >
< / div >
< div class = "section" id = "using-debug-dump-helper-script" >
2019-05-22 16:44:06 +00:00
< h2 > 31.2. Using debug dump helper script< a class = "headerlink" href = "#using-debug-dump-helper-script" title = "Permalink to this headline" > ¶< / a > < / h2 >
2019-04-23 18:55:23 +00:00
< p > Since cdist stores data to local cache that can be used for debugging there
2019-05-22 16:44:06 +00:00
is a helper script that dumps data from local cache,
< a class = "reference external" href = "man1/cdist-dump.html" > cdist-dump< / a > .< / p >
2019-04-23 18:55:23 +00:00
< p > For more info see:< / p >
2019-05-17 11:33:31 +00:00
< div class = "highlight-sh" > < div class = "highlight" > < pre > < span > < / span > cdist-dump -h
2019-04-23 18:55:23 +00:00
< / pre > < / div >
< / div >
< p > Or from cdist git cloned directory:< / p >
2019-05-17 11:33:31 +00:00
< div class = "highlight-sh" > < div class = "highlight" > < pre > < span > < / span > ./scripts/cdist-dump -h
2019-04-23 18:55:23 +00:00
< / pre > < / div >
< / div >
< / div >
< / div >
< / div >
< / div >
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
2019-05-22 16:44:06 +00:00
< a href = "cdist-hacker.html" class = "btn btn-neutral float-left" title = "30. Hacking" accesskey = "p" rel = "prev" > < span class = "fa fa-arrow-circle-left" > < / span > Previous< / a >
2019-04-23 18:55:23 +00:00
< / div >
< hr / >
< div role = "contentinfo" >
< p >
2019-05-04 22:18:20 +00:00
© Copyright ungleich GmbH 2019
2019-04-23 18:55:23 +00:00
< / 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 >
