summaryrefslogtreecommitdiff
path: root/cloudinit/config/cc_debug.py
diff options
context:
space:
mode:
Diffstat (limited to 'cloudinit/config/cc_debug.py')
-rw-r--r--cloudinit/config/cc_debug.py26
1 files changed, 16 insertions, 10 deletions
diff --git a/cloudinit/config/cc_debug.py b/cloudinit/config/cc_debug.py
index bdc32fe6..5ab36469 100644
--- a/cloudinit/config/cc_debug.py
+++ b/cloudinit/config/cc_debug.py
@@ -15,22 +15,28 @@
# along with this program. If not, see <http://www.gnu.org/licenses/>.
"""
+Debug
+-----
**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.
+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::
+.. note::
+ Log configurations are not output.
- debug:
- verbose: (defaulting to true)
- output: (location to write output, defaulting to console + log)
+**Internal name:** ``cc_debug``
-.. note::
+**Module frequency:** per instance
- Log configurations are not output.
+**Supported distros:** all
+
+**Config keys**::
+
+ debug:
+ verbose: true/false (defaulting to true)
+ output: (location to write output, defaulting to console + log)
"""
import copy