RepoMirrors
/
go-ceph
mirror of https://github.com/ceph/go-ceph
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Go bindings for Ceph
1,238 Commits 5 Branches 29 Tags 3.6 MiB
Go 95.4%
Python 2%
Shell 1.5%
Makefile 0.9%
Dockerfile 0.2%
Go to file
John Mulligan 2390f2c4c2 makefile: add api-promote target 
The intended workflow is to update the Go source code and then run `make
api-promote` which will detect the changes to the ceph_preview tag(s) in
the sources and then promote apis from preview to stable in the
tracking json.

I explicitly do not want apiage.py (or the makefile) to make changes to
the source code. The contributor may or may not want to make changes
incrementally, also some times a preview function may be moved to
another source file. Plus, I simply think this is a job for a human.
But we can avoid having to edit the JSON and markdown files afterward.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
 		2022-09-12 14:26:35 +00:00
.devcontainer cutil: enable PtrGuard by default 2022-04-28 14:39:48 +00:00
.github workflows: add a new sub workflow to help detect api updates 2022-08-30 15:41:01 +00:00
cephfs cephfs admin: remove unnecessary import C lines 2022-08-03 14:35:14 +00:00
common go-ceph: change mature preview APIs to stable 2022-08-16 11:42:41 +00:00
contrib contrib: add a api promote mode to apiage 2022-09-12 14:26:35 +00:00
docs docs: fix an existing spelling mistake 2022-09-07 16:11:29 +00:00
internal rgw/admin: fix tests for quincy 2022-05-19 14:09:21 +00:00
rados go-ceph: change mature preview APIs to stable 2022-08-16 11:42:41 +00:00
rbd rbd: add mirroring support for nautilus 2022-07-13 13:00:48 +00:00
rgw go-ceph: change mature preview APIs to stable 2022-08-16 11:42:41 +00:00
testing/containers Dockerfile: Remove an unused CEPH_TAG env variable 2022-06-28 12:54:48 +00:00
.gitignore gitignore: Add vi/vim backup files 2022-07-07 13:05:57 +00:00
.revive.toml revive: disable package-comments rule 2022-08-12 05:53:33 +00:00
LICENSE license: add MIT license 2014-11-27 10:53:04 -08:00
Makefile makefile: add api-promote target 2022-09-12 14:26:35 +00:00
README.md readme: replace "office hours" with a new contact section 2022-09-07 06:51:49 +00:00
doc.go doc: note the new "common/" subdir to the doc.go file 2021-06-01 11:06:19 +00:00
entrypoint.sh entrypoint: don't change the build tags variable 2022-07-19 06:55:28 +00:00
go.mod go-ceph: bump github.com/aws/aws-sdk-go from 1.44.67 to 1.44.90 2022-09-02 14:04:58 +00:00
go.sum go-ceph: bump github.com/aws/aws-sdk-go from 1.44.67 to 1.44.90 2022-09-02 14:04:58 +00:00
micro-osd.sh micro-osd.sh: fix rgw connecting to mon without cephx 2022-05-02 14:14:25 +00:00
package_test.go ceph: remove use of boolean literal in expression 2020-04-09 13:11:05 -04:00

README.md

go-ceph - Go bindings for Ceph APIs

Godoc license

Introduction

The go-ceph project is a collection of API bindings that support the use of native Ceph APIs, which are C language functions, in Go. These bindings make use of Go's cgo feature. There are three main Go sub-packages that make up go-ceph:

  • rados - exports functionality from Ceph's librados
  • rbd - exports functionality from Ceph's librbd
  • cephfs - exports functionality from Ceph's libcephfs
  • rgw/admin - interact with radosgw admin ops API

We aim to provide comprehensive support for the Ceph APIs over time. This includes both I/O related functions and management functions. If your project makes use of Ceph command line tools and is written in Go, you may be able to switch away from shelling out to the CLI and to these native function calls.

Installation

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.

On debian based systems (apt) these may be:

libcephfs-dev librbd-dev librados-dev

On rpm based systems (dnf, yum, etc) these may be:

libcephfs-devel librbd-devel librados-devel

On MacOS you can use brew to install the libraries:

brew tap mulbc/ceph-client
brew install ceph-client

NOTE: CentOS users may want to use a CentOS Storage SIG repository to enable packages for a supported ceph version. Example: dnf -y install centos-release-ceph-pacific. (CentOS 7 users should use "yum" rather than "dnf")

To quickly test if one can build with go-ceph on your system, run:

go get github.com/ceph/go-ceph

Once compiled, code using go-ceph is expected to dynamically link to the Ceph libraries. These libraries must be available on the system where the go based binaries will be run. Our use of cgo and ceph libraries does not allow for fully static binaries.

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 work with non-current versions of Ceph, it is required to pass build-tags to the go command line. A tag with the named Ceph release will enable/disable certain features of the go-ceph packages, and prevent warnings or compile problems. For example, to ensure you select the library features that match the "pacific" release, use:

go build -tags pacific ....
go test -tags pacific ....

Supported Ceph Versions

go-ceph version Supported Ceph Versions Deprecated Ceph Versions
v0.17.0 octopus, pacific, quincy nautilus
v0.16.0 octopus, pacific† nautilus
v0.15.0 octopus, pacific nautilus
v0.14.0 octopus, pacific nautilus
v0.13.0 octopus, pacific nautilus
v0.12.0 octopus, pacific nautilus
v0.11.0 nautilus, octopus, pacific
v0.10.0 nautilus, octopus, pacific
v0.9.0 nautilus, octopus
v0.8.0 nautilus, octopus
v0.7.0 nautilus, octopus
v0.6.0 nautilus, octopus mimic
v0.5.0 nautilus, octopus luminous, mimic
v0.4.0 luminous, mimic, nautilus, octopus
v0.3.0 luminous, mimic, nautilus, octopus
v0.2.0 luminous, mimic, nautilus
(pre release) luminous, mimic (see note)

These tags affect what is supported at compile time. What version of the Ceph cluster the client libraries support, and vice versa, is determined entirely by what version of the Ceph C libraries go-ceph is compiled with.

† Preliminary support for Ceph Quincy is available in this release. Due to Quincy specific issues in our test suite some APIs can not be tested against Quincy at the moment. Thus, go-ceph should work with Quincy but we are not declaring it fully supported until all APIs can be tested on Quincy.

NOTE: Prior to 2020 the project did not make versioned releases. The ability to compile with a particular Ceph version before go-ceph v0.2.0 is not guaranteed.

Documentation

Detailed API documentation is available at https://pkg.go.dev/github.com/ceph/go-ceph.

Some API Hints and How-Tos are also available to quickly introduce how some of API calls work together.

Development

docker run --rm -it --net=host \
  --security-opt apparmor:unconfined \
  -v ${PWD}:/go/src/github.com/ceph/go-ceph:z \
  -v /home/nwatkins/src/ceph/build:/home/nwatkins/src/ceph/build:z \
  -e CEPH_CONF=/home/nwatkins/src/ceph/build/ceph.conf \
  ceph-golang

Run against a vstart.sh cluster without installing Ceph:

export CGO_CPPFLAGS="-I/ceph/src/include"
export CGO_LDFLAGS="-L/ceph/build/lib"
go build

Contributing

Contributions are welcome & greatly appreciated, every little bit helps. Make code changes via Github pull requests:

  • Fork the repo and create a topic branch for every feature/fix. Avoid making changes directly on master branch.
  • All incoming features should be accompanied with tests.
  • Make sure that you run go fmt before submitting a change set. Alternatively the Makefile has a flag for this, so you can call make fmt as well.
  • The integration tests can be run in a docker container, for this run:
make test-docker

Getting in Touch

Want to get in touch with the go-ceph team? We're available through a few different channels: