diff options
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/index.rst | 62 | ||||
| -rw-r--r-- | doc/api/mon_command_api.rst | 3 |
2 files changed, 65 insertions, 0 deletions
diff --git a/doc/api/index.rst b/doc/api/index.rst new file mode 100644 index 000000000..e359b87f8 --- /dev/null +++ b/doc/api/index.rst @@ -0,0 +1,62 @@ +=================== + API Documentation +=================== + +Ceph RESTful API +================ + +See `Ceph REST API`_. + +.. _Ceph REST API: ../mgr/ceph_api/ + +Ceph Storage Cluster APIs +========================= + +See `Ceph Storage Cluster APIs`_. + +.. _Ceph Storage Cluster APIs: ../rados/api/ + + +Ceph File System APIs +===================== + +See `libcephfs`_ + +.. _libcephfs: ../cephfs/api + +Ceph Block Device APIs +====================== + +See `librbdpy`_. + +.. _librbdpy: ../rbd/api/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`_. + +Ceph MON Command API +==================== + +- See `Mon command API`_. + +.. _S3-compatible API: ../radosgw/s3/ +.. _Swift-compatible API: ../radosgw/swift/ +.. _Admin Ops API: ../radosgw/adminops +.. _Mon command API: mon_command_api + + +.. toctree:: + :hidden: + + mon_command_api diff --git a/doc/api/mon_command_api.rst b/doc/api/mon_command_api.rst new file mode 100644 index 000000000..51a752a84 --- /dev/null +++ b/doc/api/mon_command_api.rst @@ -0,0 +1,3 @@ +.. ceph-mgr-commands:: src/pybind/mgr + :python_path: src/pybind +.. ceph-mon-commands:: src/mon/MonCommands.h src/mgr/MgrCommands.h |