diff options
author | 2018-01-04 13:43:33 +0800 | |
---|---|---|
committer | 2018-01-05 11:59:39 +0800 | |
commit | 812ff6ca9fcd3e629e49d4328905f33eee8ca3f5 (patch) | |
tree | 04ece7b4da00d9d2f98093774594f4057ae561d4 /src/ceph/doc/api | |
parent | 15280273faafb77777eab341909a3f495cf248d9 (diff) |
initial code repo
This patch creates initial code repo.
For ceph, luminous stable release will be used for base code,
and next changes and optimization for ceph will be added to it.
For opensds, currently any changes can be upstreamed into original
opensds repo (https://github.com/opensds/opensds), and so stor4nfv
will directly clone opensds code to deploy stor4nfv environment.
And the scripts for deployment based on ceph and opensds will be
put into 'ci' directory.
Change-Id: I46a32218884c75dda2936337604ff03c554648e4
Signed-off-by: Qiaowei Ren <qiaowei.ren@intel.com>
Diffstat (limited to 'src/ceph/doc/api')
-rw-r--r-- | src/ceph/doc/api/index.rst | 45 | ||||
-rw-r--r-- | src/ceph/doc/api/libcephfs-java.rst | 9 |
2 files changed, 54 insertions, 0 deletions
diff --git a/src/ceph/doc/api/index.rst b/src/ceph/doc/api/index.rst new file mode 100644 index 0000000..67d774c --- /dev/null +++ b/src/ceph/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/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/src/ceph/doc/api/libcephfs-java.rst b/src/ceph/doc/api/libcephfs-java.rst new file mode 100644 index 0000000..85b5c31 --- /dev/null +++ b/src/ceph/doc/api/libcephfs-java.rst @@ -0,0 +1,9 @@ +=================== +Libcephfs (JavaDoc) +=================== + +.. + 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/>`_. |