summaryrefslogtreecommitdiffstats
path: root/doc/server/admin/viz.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/server/admin/viz.txt')
-rw-r--r--doc/server/admin/viz.txt18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/server/admin/viz.txt b/doc/server/admin/viz.txt
new file mode 100644
index 000000000..3556fd395
--- /dev/null
+++ b/doc/server/admin/viz.txt
@@ -0,0 +1,18 @@
+.. -*- mode: rst -*-
+
+.. _server-admin-viz-index:
+
+viz
+===
+
+Produce graphviz diagrams of metadata structures. Make sure that the
+graphviz package is installed.
+
+The following command will produce a graphviz image which includes hosts,
+bundles, and a key::
+
+ bcfg2-admin viz -H -b -k -o ~/bcfg2.png
+
+.. note:: The graphviz package available via DAG/RPMforge has been known
+ to have dependency issues. We recommend installing the package
+ from EPEL.