initial code repo
[stor4nfv.git] / src / ceph / doc / api / index.rst
diff --git a/src/ceph/doc/api/index.rst b/src/ceph/doc/api/index.rst
new file mode 100644 (file)
index 0000000..67d774c
--- /dev/null
@@ -0,0 +1,45 @@
+===================
+ API Documentation
+===================
+
+
+Ceph Storage Cluster APIs
+=========================
+
+See `Ceph Storage Cluster APIs`_.
+
+.. _Ceph Storage Cluster APIs: ../rados/api/
+
+
+Ceph Filesystem APIs
+====================
+
+See `libcephfs (javadoc)`_.
+
+.. _libcephfs (javadoc): libcephfs-java
+
+
+Ceph Block Device APIs
+======================
+
+See `librbdpy`_.
+
+.. _librbdpy: ../rbd/librbdpy
+
+Ceph RADOS Gateway APIs
+=======================
+
+See `librgw-py`_.
+
+.. _librgw-py: ../radosgw/api
+
+Ceph Object Store APIs
+======================
+
+- See `S3-compatible API`_.
+- See `Swift-compatible API`_.
+- See `Admin Ops API`_.
+
+.. _S3-compatible API: ../radosgw/s3/
+.. _Swift-compatible API: ../radosgw/swift/
+.. _Admin Ops API: ../radosgw/adminops