1 files changed, 34 insertions, 5 deletions
diff --git a/cloudinit/config/cc_debug.py b/cloudinit/config/cc_debug.py
index 7219b0f8..8c489426 100644
--- a/cloudinit/config/cc_debug.py
+++ b/cloudinit/config/cc_debug.py
@@ -14,11 +14,33 @@
 #    You should have received a copy of the GNU General Public License
 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-from cloudinit import type_utils
-from cloudinit import util
+"""
+**Summary:** helper to debug cloud-init *internal* datastructures.
+
+**Description:** This module will enable for outputting various internal
+information that cloud-init sources provide to either a file or to the output
+console/log location that this cloud-init has been configured with when
+running.
+
+It can be configured with the following option structure::
+
+    debug:
+       verbose: (defaulting to true)
+       output: (location to write output, defaulting to console + log)
+
+.. note::
+
+    Log configurations are not output.
+"""
+
 import copy
 from StringIO import StringIO
 
+from cloudinit import type_utils
+from cloudinit import util
+
+SKIP_KEYS = frozenset(['log_cfgs'])
+
 
 def _make_header(text):
     header = StringIO()
@@ -31,7 +53,14 @@ def _make_header(text):
     return header.getvalue()
 
 
+def _dumps(obj):
+    text = util.yaml_dumps(obj, explicit_start=False, explicit_end=False)
+    return text.rstrip()
+
+
 def handle(name, cfg, cloud, log, args):
+    """Handler method activated by cloud-init."""
+
     verbose = util.get_cfg_by_path(cfg, ('debug', 'verbose'), default=True)
     if args:
         # if args are provided (from cmdline) then explicitly set verbose
@@ -46,7 +75,7 @@ def handle(name, cfg, cloud, log, args):
         return
     # Clean out some keys that we just don't care about showing...
     dump_cfg = copy.deepcopy(cfg)
-    for k in ['log_cfgs']:
+    for k in SKIP_KEYS:
         dump_cfg.pop(k, None)
     all_keys = list(dump_cfg.keys())
     for k in all_keys:
@@ -55,10 +84,10 @@ def handle(name, cfg, cloud, log, args):
     # Now dump it...
     to_print = StringIO()
     to_print.write(_make_header("Config"))
-    to_print.write(util.yaml_dumps(dump_cfg))
+    to_print.write(_dumps(dump_cfg))
     to_print.write("\n")
     to_print.write(_make_header("MetaData"))
-    to_print.write(util.yaml_dumps(cloud.datasource.metadata))
+    to_print.write(_dumps(cloud.datasource.metadata))
     to_print.write("\n")
     to_print.write(_make_header("Misc"))
     to_print.write("Datasource: %s\n" %