summaryrefslogtreecommitdiffstats
path: root/doc/dev/internals.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/dev/internals.rst')
-rw-r--r--doc/dev/internals.rst40
1 files changed, 40 insertions, 0 deletions
diff --git a/doc/dev/internals.rst b/doc/dev/internals.rst
new file mode 100644
index 00000000..8c3547e4
--- /dev/null
+++ b/doc/dev/internals.rst
@@ -0,0 +1,40 @@
+================
+ Ceph Internals
+================
+
+.. note:: If you're looking for how to use Ceph as a library from your
+ own software, please see :doc:`/api/index`.
+
+You can start a development mode Ceph cluster, after compiling the source, with::
+
+ cd src
+ install -d -m0755 out dev/osd0
+ ./vstart.sh -n -x -l
+ # check that it's there
+ ./ceph health
+
+.. todo:: vstart is woefully undocumented and full of sharp sticks to poke yourself with.
+
+
+.. _mailing-list:
+
+.. rubric:: Mailing list
+
+The official development email list is ``ceph-devel@vger.kernel.org``. Subscribe by sending
+a message to ``majordomo@vger.kernel.org`` with the line::
+
+ subscribe ceph-devel
+
+in the body of the message.
+
+
+.. rubric:: Contents
+
+.. toctree::
+ :glob:
+
+ *
+ osd_internals/index*
+ mds_internals/index*
+ radosgw/index*
+ ceph-volume/index*