1 files changed, 48 insertions, 0 deletions
diff --git a/collectors/python.d.plugin/puppet/README.md b/collectors/python.d.plugin/puppet/README.md
new file mode 100644
index 000000000..8304c831e
--- /dev/null
+++ b/collectors/python.d.plugin/puppet/README.md
@@ -0,0 +1,48 @@
+# puppet
+
+Monitor status of Puppet Server and Puppet DB.
+
+Following charts are drawn:
+
+1. **JVM Heap**
+ * committed (allocated from OS)
+ * used (actual use)
+2. **JVM Non-Heap**
+ * committed (allocated from OS)
+ * used (actual use)
+3. **CPU Usage**
+ * execution
+ * GC (taken by garbage collection)
+4. **File Descriptors**
+ * max
+ * used
+
+
+### configuration
+
+```yaml
+puppetdb:
+    url: 'https://fqdn.example.com:8081'
+    tls_cert_file: /path/to/client.crt
+    tls_key_file: /path/to/client.key
+    autodetection_retry: 1
+    retries: 3600
+
+puppetserver:
+    url: 'https://fqdn.example.com:8140'
+    autodetection_retry: 1
+    retries: 3600
+```
+
+When no configuration is given then `https://fqdn.example.com:8140` is
+tried without any retries.
+
+### notes
+
+* Exact Fully Qualified Domain Name of the node should be used.
+* Usually Puppet Server/DB startup time is VERY long. So, there should
+  be quite reasonable retry count.
+* Secure PuppetDB config may require client certificate. Not applies
+  to default PuppetDB configuration though.
+
+---