summaryrefslogtreecommitdiffstats
path: root/doc/reports/index.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/reports/index.txt')
-rw-r--r--doc/reports/index.txt29
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/reports/index.txt b/doc/reports/index.txt
new file mode 100644
index 000000000..bef686305
--- /dev/null
+++ b/doc/reports/index.txt
@@ -0,0 +1,29 @@
+.. -*- mode: rst -*-
+
+.. _server-reports-index:
+
+The Bcfg2 Reporting System
+==========================
+
+Bcfg2's reporting system is its killer feature. It allows administrators
+to gain a broad understanding of the configuration state of their entire
+environment. It summarizes
+
+* Configuration changes and when they were made
+* Discrepancies between the specification and current client states
+
+ * Clients can be grouped by misconfiguration type
+
+* Configuration entries that are not specified
+* Overall client summaries according to these types
+
+There are two systems, the old system, which builds static reports based
+on a series of XSLT stylesheets and a new dynamic reporting system that
+uses django and a database backend.
+
+.. toctree::
+ :maxdepth: 2
+
+ install
+ static
+ dynamic