Support disabling saving output streams

docs/src/cdist-cache.rst

@@ -87,10 +87,12 @@ state
     this type execution state ('done' when finished)
 
 stderr
-  directory containing type's gencode-* and code-* stderr stream outputs
+  directory containing type's manifest, gencode-* and code-* stderr stream
+  outputs
 
 stdin
     this type stdin content
 
 stdout
-  directory containing type's gencode-* and code-* stdout stream outputs.
+  directory containing type's manifest, gencode-* and code-* stdout stream
+  outputs.

docs/src/cdist-configuration.rst

@@ -88,6 +88,11 @@ The possible keywords and their meanings are as follows:
 :strong:`remote_shell`
     Shell command at remote host used for remote execution.
 
+:strong:`save_output_streams`
+    Enable/disable saving output streams (enabled by default).
+    It recognizes boolean values from 'yes'/'no', 'on'/'off', 'true'/'false'
+    and '1'/'0'.
+
 :strong:`verbosity`
     Set verbosity level. Valid values are: 
     'ERROR', 'WARNING', 'INFO', 'VERBOSE', 'DEBUG', 'TRACE' and 'OFF'.

docs/src/cdist-saving-output-streams.rst

@@ -0,0 +1,88 @@
+Saving output streams
+=====================
+
+Description
+-----------
+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.
+
+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 `Local cache overview <cdist-cache.html>`_.
+
+Also, in case of an error, cdist can now exit and show all information it has
+about the error.
+
+For example:
+
+.. code-block:: sh
+
+    $ ./bin/cdist config -v -i ~/.cdist/manifest/init-output-streams $(cat ~/ungleich/data/opennebula-debian9-test )
+    INFO: 185.203.112.42: Starting configuration run
+    INFO: 185.203.112.42: Processing __myline/test
+    ERROR: 185.203.112.42: Command failed: '/bin/sh -e /tmp/tmpow6cwemh/75ee6a79e32da093da23fe4a13dd104b/data/object/__myline/test/.cdist-kisrqlpw/code-local'
+    return code: 1
+    ---- BEGIN stdout ----
+    ---- END stdout ----
+
+    Error processing object '__myline/test'
+    ========================================
+    name: __myline/test
+    path: /tmp/tmpow6cwemh/75ee6a79e32da093da23fe4a13dd104b/data/object/__myline/test/.cdist-kisrqlpw
+    source: /home/darko/.cdist/manifest/init-output-streams
+    type: /tmp/tmpow6cwemh/75ee6a79e32da093da23fe4a13dd104b/data/conf/type/__myline
+
+    ---- BEGIN manifest:stderr ----
+    myline manifest stderr
+
+    ---- END manifest:stderr ----
+
+    ---- BEGIN gencode-remote:stderr ----
+    test gencode-remote error
+
+    ---- END gencode-remote:stderr ----
+
+    ---- BEGIN code-local:stderr ----
+    error
+
+    ---- END code-local:stderr ----
+
+    ERROR: cdist: Failed to configure the following hosts: 185.203.112.42
+
+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.
+
+There is also an option :strong:`-S/--disable-saving-output-streams` for
+disabling saving output streams. In this case error reporting can look
+like this:
+
+.. code-block:: sh
+
+    $ ./bin/cdist config -v -S -i ~/.cdist/manifest/init-output-streams $(cat ~/ungleich/data/opennebula-debian9-test )
+    INFO: 185.203.112.42: Starting configuration run
+    test stdout output streams
+    test stderr output streams
+    myline manifest stdout
+    myline manifest stderr
+    test gencode-remote error
+    INFO: 185.203.112.42: Processing __myline/test
+    error
+    ERROR: 185.203.112.42: Command failed: '/bin/sh -e /tmp/tmpzomy0wis/75ee6a79e32da093da23fe4a13dd104b/data/object/__myline/test/.cdist-n566pqut/code-local'
+    return code: 1
+    ---- BEGIN stdout ----
+    ---- END stdout ----
+
+    Error processing object '__myline/test'
+    ========================================
+    name: __myline/test
+    path: /tmp/tmpzomy0wis/75ee6a79e32da093da23fe4a13dd104b/data/object/__myline/test/.cdist-n566pqut
+    source: /home/darko/.cdist/manifest/init-output-streams
+    type: /tmp/tmpzomy0wis/75ee6a79e32da093da23fe4a13dd104b/data/conf/type/__myline
+
+
+    ERROR: cdist: Failed to configure the following hosts: 185.203.112.42

docs/src/index.rst

@@ -31,6 +31,7 @@ Contents:
    cdist-best-practice
    cdist-stages
    cdist-cache
+   cdist-saving-output-streams
    cdist-remote-exec-copy
    cdist-hacker
    cdist-troubleshooting

docs/src/man1/cdist.rst

@@ -21,7 +21,7 @@ SYNOPSIS
                  [-j [JOBS]] [-n] [-o OUT_PATH] [-R [{tar,tgz,tbz2,txz}]]
                  [-r REMOTE_OUT_DIR] [--remote-copy REMOTE_COPY]
                  [--remote-exec REMOTE_EXEC] [-I INVENTORY_DIR] [-A] [-a]
-                 [-f HOSTFILE] [-p [HOST_MAX]] [-s] [-t]
+                 [-f HOSTFILE] [-p [HOST_MAX]] [-S] [-s] [-t]
                  [host [host ...]] 
 
     cdist install [-h] [-l LOGLEVEL] [-q] [-v] [-b] [-g CONFIG_FILE]
@@ -29,7 +29,7 @@ SYNOPSIS
                   [-j [JOBS]] [-n] [-o OUT_PATH] [-R [{tar,tgz,tbz2,txz}]]
                   [-r REMOTE_OUT_DIR] [--remote-copy REMOTE_COPY]
                   [--remote-exec REMOTE_EXEC] [-I INVENTORY_DIR] [-A] [-a]
-                  [-f HOSTFILE] [-p [HOST_MAX]] [-s] [-t]
+                  [-f HOSTFILE] [-p [HOST_MAX]] [-S] [-s] [-t]
                   [host [host ...]] 
 
     cdist inventory [-h] [-l LOGLEVEL] [-q] [-v] [-b] [-g CONFIG_FILE]
@@ -200,6 +200,10 @@ Install command is currently in beta.
 
     Directory to save cdist output in on the target host.
 
+.. option:: -S, --disable-saving-output-streams
+
+    Disable saving output streams.
+
 .. option:: -s, --sequential
 
     Operate on multiple hosts sequentially (default).
@@ -561,6 +565,11 @@ The possible keywords and their meanings are as follows:
 :strong:`remote_shell`
     Shell command at remote host used for remote execution.
 
+:strong:`save_output_streams`
+    Enable/disable saving output streams (enabled by default).
+    It recognizes boolean values from 'yes'/'no', 'on'/'off', 'true'/'false'
+    and '1'/'0'.
+
 :strong:`verbosity`
     Set verbosity level. Valid values are: 
     'ERROR', 'WARNING', 'INFO', 'VERBOSE', 'DEBUG', 'TRACE' and 'OFF'.