diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-27 18:24:20 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-27 18:24:20 +0000 |
| commit | 483eb2f56657e8e7f419ab1a4fab8dce9ade8609 (patch) | |
| tree | e5d88d25d870d5dedacb6bbdbe2a966086a0a5cf /doc/api | |
| parent | Initial commit. (diff) | |
| download | ceph-483eb2f56657e8e7f419ab1a4fab8dce9ade8609.tar.xz ceph-483eb2f56657e8e7f419ab1a4fab8dce9ade8609.zip | |
Adding upstream version 14.2.21.upstream/14.2.21upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/index.rst | 45 | ||||
| -rw-r--r-- | doc/api/libcephfs-java.rst | 18 |
2 files changed, 63 insertions, 0 deletions
diff --git a/doc/api/index.rst b/doc/api/index.rst new file mode 100644 index 00000000..4a017aa8 --- /dev/null +++ b/doc/api/index.rst @@ -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/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`_. + +.. _S3-compatible API: ../radosgw/s3/ +.. _Swift-compatible API: ../radosgw/swift/ +.. _Admin Ops API: ../radosgw/adminops diff --git a/doc/api/libcephfs-java.rst b/doc/api/libcephfs-java.rst new file mode 100644 index 00000000..83b5a663 --- /dev/null +++ b/doc/api/libcephfs-java.rst @@ -0,0 +1,18 @@ +=================== +Libcephfs (JavaDoc) +=================== + +.. warning:: + + CephFS Java bindings are no longer tested by CI. They may not work properly + or corrupt data. + + Developers interested in reviving these bindings by fixing and writing tests + are encouraged to contribute! + +.. + The admin/build-docs script runs Ant to build the JavaDoc files, and + copies them to api/libcephfs-java/javadoc/. + + +View the auto-generated `JavaDoc pages for the CephFS Java bindings <javadoc/>`_. |