Add object store architecture overview picture

It requires graphviz / dot to be installed. It generates a nice graph
of the dependencies between classes in the object store.

Signed-off-by: Colin McCabe <colin.mccabe@dreamhost.com>

diff --git a/.gitignore b/.gitignore
index 99560459d1e8ae49488a9f135eefdb2996e601ef..73a8d86bd14ef6f76473346b793a7c8dfda1fc86 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -53,3 +53,4 @@ core
 .project
 .cproject
 /build-doc
+/doc/object_store.png

diff --git a/admin/build-doc b/admin/build-doc
index aee1a48345c76880c9d441195385f1877df8d634..347e7cbb1f4d80bb0a7a819b0fadd019a8eaa587 100755 (executable)
--- a/admin/build-doc
+++ b/admin/build-doc
@@ -10,6 +10,8 @@ if [ ! -e build-doc/doxygen/xml ]; then
 fi
 
 dia --filter=png-libart --export=doc/overview.png.tmp doc/overview.dia
+dot -Tpng < doc/object_store.dot > doc/object_store.png
+
 mv -- doc/overview.png.tmp doc/overview.png
 
 cd build-doc

diff --git a/doc/architecture.rst b/doc/architecture.rst
index f66cf3cd9b717a48367f4a8a575bf679f71cfa2e..fb7a1ea15eeee1014920beaa9472b60c198401b4 100644 (file)
--- a/doc/architecture.rst
+++ b/doc/architecture.rst
@@ -25,6 +25,13 @@
 
 .. todo:: write me
 
+====================================
+ Object Store Architecture Overview
+====================================
+.. image:: object_store.png
+
+.. todo:: write more here
+
 =================================
  Library architecture
 =================================

diff --git a/doc/object_store.dot b/doc/object_store.dot
new file mode 100644 (file)
index 0000000..eda3eb6
--- /dev/null
+++ b/doc/object_store.dot
@@ -0,0 +1,61 @@
+/* 
+ * Rough outline of object store module dependencies
+ *
+ * build with 
+ * dot -Tpng < ./object_store.dot > object_store.png
+ */
+
+digraph object_store {
+       size="16,16";
+       node [color=lightblue2, style=filled, fontname="Serif"];
+
+       "testrados" -> "librados"
+       "testradospp" -> "librados"
+
+       "rbd" -> "librados"
+
+       "radostool" -> "librados"
+
+       "radosgw_admin" -> "rgw"
+
+       "rgw" -> "librados"
+
+       "radosacl" -> "librados"
+
+       "librados" -> "objecter"
+
+       "ObjectCacher" -> "Filer"
+
+       "dumpjournal" -> "Journaler"
+
+       "Journaler" -> "Filer"
+
+       "SyntheticClient" -> "Filer"
+       "SyntheticClient" -> "objecter"
+
+       "Filer" -> "objecter"
+
+        "objecter" -> "OSDMap"
+
+        "cosd" -> "PG"
+        "cosd" -> "ObjectStore"
+
+        "crushtool" -> "CrushWrapper"
+
+        "OSDMap" -> "CrushWrapper"
+
+        "OSDMapTool" -> "OSDMap"
+
+        "PG" -> "ReplicatedPG"
+        "PG" -> "ObjectStore"
+        "PG" -> "OSDMap"
+
+        "ReplicatedPG" -> "ObjectStore"
+        "ReplicatedPG" -> "OSDMap"
+
+        "ObjectStore" -> "FileStore"
+
+        "FileStore" -> "ext3"
+        "FileStore" -> "ext4"
+        "FileStore" -> "btrfs"
+}