RepoMirrors
/
go-ceph
mirror of https://github.com/ceph/go-ceph
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

readme: improve flow of the Installation section 

Emphasize that go-ceph is a library and that the ceph devel packages are
build-time dependencies.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
This commit is contained in:
John Mulligan 2020-08-26 14:10:52 -04:00 committed by John Mulligan
parent 07243682f2
commit c6113f79f9
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -19,20 +19,25 @@ switch away from shelling out to the CLI and to these native function calls.
## Installation ## Installation
go get github.com/ceph/go-ceph The code in go-ceph is purely a library module. Typically, one will import
go-ceph in another Go based project. When building the code the native RADOS,
RBD, & CephFS library and development headers are expected to be installed.
The native RADOS library and development headers are expected to be installed. On debian based systems (apt) these may be:
On debian systems (apt):
```sh ```sh
libcephfs-dev librbd-dev librados-dev libcephfs-dev librbd-dev librados-dev
``` ```
On rpm based systems (dnf, yum, etc): On rpm based systems (dnf, yum, etc) these may be:
```sh ```sh
libcephfs-devel librbd-devel librados-devel libcephfs-devel librbd-devel librados-devel
``` ```
To quickly test if one can build with go-ceph on your system, run:
```sh
go get github.com/ceph/go-ceph
```
go-ceph tries to support different Ceph versions. However some functions might go-ceph tries to support different Ceph versions. However some functions might
only be available in recent versions, and others may be deprecated. In order to only be available in recent versions, and others may be deprecated. In order to
work with non-current versions of Ceph, it is required to pass build-tags to work with non-current versions of Ceph, it is required to pass build-tags to