Documentation ¶
Overview ¶
Package ceph is the root of a set of packages that wrap the Ceph APIs.
Generally, this package only exists to host subsystem specific packages and contains no functions.
The "rados" sub-package wraps APIs that handle RADOS specific functions.
The "rbd" sub-package wraps APIs that handle RBD specific functions.
The "cephfs" sub-package wraps APIs that handle CephFS specific functions.
The "common" sub-package contains sub-packages related to implementing common interfaces and utilities shared across the above.
Consult the documentation for each package for additional details.
Directories ¶
Path | Synopsis |
---|---|
Package cephfs contains a set of wrappers around Ceph's libcephfs API.
|
Package cephfs contains a set of wrappers around Ceph's libcephfs API. |
admin
Package admin is a convenience layer to support the administration of CephFS volumes, subvolumes, etc.
|
Package admin is a convenience layer to support the administration of CephFS volumes, subvolumes, etc. |
common
|
|
admin/manager
Package manager from common/admin contains a set of APIs used to interact with and administer the Ceph manager (mgr).
|
Package manager from common/admin contains a set of APIs used to interact with and administer the Ceph manager (mgr). |
admin/nfs
Package nfs from common/admin contains a set of APIs used to interact with and administer NFS support for ceph clusters.
|
Package nfs from common/admin contains a set of APIs used to interact with and administer NFS support for ceph clusters. |
commands
Package commands provides types and utility functions that are used for interfacing with the JSON based command infrastructure in Ceph.
|
Package commands provides types and utility functions that are used for interfacing with the JSON based command infrastructure in Ceph. |
internal
|
|
errutil
Package errutil provides common functions for dealing with error conditions for all ceph api wrappers.
|
Package errutil provides common functions for dealing with error conditions for all ceph api wrappers. |
log
Package log is the internal package for go-ceph logging.
|
Package log is the internal package for go-ceph logging. |
Package rados contains a set of wrappers around Ceph's librados API.
|
Package rados contains a set of wrappers around Ceph's librados API. |
Package rbd contains a set of wrappers around Ceph's librbd API.
|
Package rbd contains a set of wrappers around Ceph's librbd API. |
admin
Package admin is a convenience layer to support the administration of rbd volumes, snapshots, scheduling etc that is outside of the C api for librbd.
|
Package admin is a convenience layer to support the administration of rbd volumes, snapshots, scheduling etc that is outside of the C api for librbd. |
Package rgw contains sub-packages pertaining to the administration of RGW.
|
Package rgw contains sub-packages pertaining to the administration of RGW. |
admin
Package admin contains a set of wrappers around Ceph's RGW Admin Ops API.
|
Package admin contains a set of wrappers around Ceph's RGW Admin Ops API. |
Click to show internal directories.
Click to hide internal directories.