initial code repo

[stor4nfv.git] / src / ceph / doc / dev / object-store.rst

diff --git a/src/ceph/doc/dev/object-store.rst b/src/ceph/doc/dev/object-store.rst
new file mode 100644 (file)
index 0000000..355f515
--- /dev/null
+++ b/src/ceph/doc/dev/object-store.rst
@@ -0,0 +1,70 @@
+====================================
+ Object Store Architecture Overview
+====================================
+
+.. graphviz::
+
+  /*
+   * Rough outline of object store module dependencies
+   */
+
+  digraph object_store {
+    size="7,7";
+    node [color=lightblue2, style=filled, fontname="Serif"];
+
+    "testrados" -> "librados"
+    "testradospp" -> "librados"
+
+    "rbd" -> "librados"
+
+    "radostool" -> "librados"
+
+    "radosgw-admin" -> "radosgw"
+
+    "radosgw" -> "librados"
+
+    "radosacl" -> "librados"
+
+    "librados" -> "objecter"
+
+    "ObjectCacher" -> "Filer"
+
+    "dumpjournal" -> "Journaler"
+
+    "Journaler" -> "Filer"
+
+    "SyntheticClient" -> "Filer"
+    "SyntheticClient" -> "objecter"
+
+    "Filer" -> "objecter"
+
+    "objecter" -> "OSDMap"
+
+    "ceph-osd" -> "PG"
+    "ceph-osd" -> "ObjectStore"
+
+    "crushtool" -> "CrushWrapper"
+
+    "OSDMap" -> "CrushWrapper"
+
+    "OSDMapTool" -> "OSDMap"
+
+    "PG" -> "PrimaryLogPG"
+    "PG" -> "ObjectStore"
+    "PG" -> "OSDMap"
+
+    "PrimaryLogPG" -> "ObjectStore"
+    "PrimaryLogPG" -> "OSDMap"
+
+    "ObjectStore" -> "FileStore"
+    "ObjectStore" -> "BlueStore"
+
+    "BlueStore" -> "rocksdb"
+
+    "FileStore" -> "xfs"
+    "FileStore" -> "btrfs"
+    "FileStore" -> "ext4"
+  }
+
+
+.. todo:: write more here