{"id":13809143,"url":"https://github.com/ceph/go-ceph","last_synced_at":"2025-05-13T21:11:19.520Z","repository":{"id":37493404,"uuid":"41673361","full_name":"ceph/go-ceph","owner":"ceph","description":"Go bindings for Ceph :octopus: :octopus: :octopus:","archived":false,"fork":false,"pushed_at":"2025-05-10T19:58:36.000Z","size":1990,"stargazers_count":644,"open_issues_count":38,"forks_count":264,"subscribers_count":41,"default_branch":"master","last_synced_at":"2025-05-10T20:27:20.514Z","etag":null,"topics":["bindings","ceph","ceph-radosgw","cephfs","golang","rados","rbd"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ceph.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2015-08-31T12:10:21.000Z","updated_at":"2025-05-10T19:58:39.000Z","dependencies_parsed_at":"2023-10-10T20:26:24.626Z","dependency_job_id":"4a5a54c2-3d73-4c64-908c-d727f3cd43c7","html_url":"https://github.com/ceph/go-ceph","commit_stats":{"total_commits":1472,"total_committers":76,"mean_commits":19.36842105263158,"dds":0.4660326086956522,"last_synced_commit":"84b02c5a561f4d34a478b2b4f44f13e66f5a3323"},"previous_names":[],"tags_count":32,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ceph%2Fgo-ceph","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ceph%2Fgo-ceph/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ceph%2Fgo-ceph/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ceph%2Fgo-ceph/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ceph","download_url":"https://codeload.github.com/ceph/go-ceph/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254029003,"owners_count":22002283,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bindings","ceph","ceph-radosgw","cephfs","golang","rados","rbd"],"created_at":"2024-08-04T01:02:03.435Z","updated_at":"2025-05-13T21:11:14.501Z","avatar_url":"https://github.com/ceph.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"# go-ceph - Go bindings for Ceph APIs\n\n[![Godoc](http://img.shields.io/badge/godoc-reference-blue.svg?style=flat)](https://godoc.org/github.com/ceph/go-ceph) [![license](http://img.shields.io/badge/license-MIT-red.svg?style=flat)](https://raw.githubusercontent.com/ceph/go-ceph/master/LICENSE)\n\n## Introduction\n\nThe go-ceph project is a collection of API bindings that support the use of\nnative Ceph APIs, which are C language functions, in Go. These bindings make\nuse of Go's cgo feature.\nThere are three main Go sub-packages that make up go-ceph:\n* rados - exports functionality from Ceph's librados\n* rbd - exports functionality from Ceph's librbd\n* cephfs - exports functionality from Ceph's libcephfs\n* rgw/admin - interact with [radosgw admin ops API](https://docs.ceph.com/en/latest/radosgw/adminops)\n\nWe aim to provide comprehensive support for the Ceph APIs over time. This\nincludes both I/O related functions and management functions.  If your project\nmakes use of Ceph command line tools and is written in Go, you may be able to\nswitch away from shelling out to the CLI and to these native function calls.\n\n## Installation\n\nThe code in go-ceph is purely a library module. Typically, one will import\ngo-ceph in another Go based project. When building the code the native RADOS,\nRBD, \u0026 CephFS library and development headers are expected to be installed.\n\nOn debian based systems (apt) these may be:\n```sh\nlibcephfs-dev librbd-dev librados-dev\n```\n\nOn rpm based systems (dnf, yum, etc) these may be:\n```sh\nlibcephfs-devel librbd-devel librados-devel\n```\n\nOn MacOS you can use brew to install the libraries:\n```sh\nbrew tap mulbc/ceph-client\nbrew install ceph-client\n```\n\nNOTE: CentOS users may want to use a\n[CentOS Storage SIG](https://wiki.centos.org/SpecialInterestGroup/Storage/Ceph)\nrepository to enable packages for a supported ceph version.\nExample: `dnf -y install centos-release-ceph-pacific`.\n(CentOS 7 users should use \"yum\" rather than \"dnf\")\n\n\nTo quickly test if one can build with go-ceph on your system, run:\n```sh\ngo get github.com/ceph/go-ceph\n```\n\nOnce compiled, code using go-ceph is expected to dynamically link to the Ceph\nlibraries. These libraries must be available on the system where the go based\nbinaries will be run. Our use of cgo and ceph libraries does not allow for\nfully static binaries.\n\ngo-ceph tries to support different Ceph versions. However some functions might\nonly be available in recent versions, and others may be deprecated. In order to\nwork with non-current versions of Ceph, it is required to pass build-tags to\nthe `go` command line. A tag with the named Ceph release will enable/disable\ncertain features of the go-ceph packages, and prevent warnings or compile\nproblems. For example, to ensure you select the library features that match\nthe \"pacific\" release, use:\n```sh\ngo build -tags pacific ....\ngo test -tags pacific ....\n```\n\n### Supported Ceph Versions\n\n| go-ceph version | Supported Ceph Versions | Deprecated Ceph Versions |\n| --------------- | ------------------------| -------------------------|\n| v0.33.0         | pacific, quincy, reef, squid   | octopus           |\n| v0.32.0         | pacific, quincy, reef, squid   | octopus           |\n| v0.31.0         | pacific, quincy, reef, squid   | octopus           |\n| v0.30.0         | pacific, quincy, reef, squid   | octopus           |\n| v0.29.0         | pacific, quincy, reef   | octopus                  |\n| v0.28.0         | pacific, quincy, reef   | nautilus, octopus        |\n| v0.27.0         | pacific, quincy, reef   | nautilus, octopus        |\n| v0.26.0         | pacific, quincy, reef   | nautilus, octopus        |\n| v0.25.0         | pacific, quincy, reef   | nautilus, octopus        |\n| v0.24.0         | pacific, quincy, reef   | nautilus, octopus        |\n| v0.23.0         | pacific, quincy, reef   | nautilus, octopus        |\n| v0.22.0         | pacific, quincy         | nautilus, octopus        |\n| v0.21.0         | pacific, quincy         | nautilus, octopus        |\n| v0.20.0         | pacific, quincy         | nautilus, octopus        |\n| v0.19.0         | pacific, quincy         | nautilus, octopus        |\n| v0.18.0         | octopus, pacific, quincy | nautilus                |\n| v0.17.0         | octopus, pacific, quincy | nautilus                |\n\nThe tags affect what is supported at compile time. What version of the Ceph\ncluster the client libraries support, and vice versa, is determined entirely\nby what version of the Ceph C libraries go-ceph is compiled with.\n\nTo see what older versions of go-ceph supported refer to the [older\nreleases](./docs/older-releases.md) file in the documentation.\n\n\n## Documentation\n\nDetailed API documentation is available at\n\u003chttps://pkg.go.dev/github.com/ceph/go-ceph\u003e.\n\nSome [API Hints and How-Tos](./docs/hints.md) are also available to quickly\nintroduce how some of API calls work together.\n\n\n## Development\n\n```\ndocker run --rm -it --net=host \\\n  --security-opt apparmor:unconfined \\\n  -v ${PWD}:/go/src/github.com/ceph/go-ceph:z \\\n  -v /home/nwatkins/src/ceph/build:/home/nwatkins/src/ceph/build:z \\\n  -e CEPH_CONF=/home/nwatkins/src/ceph/build/ceph.conf \\\n  ceph-golang\n```\n\nRun against a `vstart.sh` cluster without installing Ceph:\n\n```\nexport CGO_CPPFLAGS=\"-I/ceph/src/include\"\nexport CGO_LDFLAGS=\"-L/ceph/build/lib\"\ngo build\n```\n\n## Contributing\n\nContributions are welcome \u0026 greatly appreciated, every little bit helps. Make code changes via Github pull requests:\n\n- Fork the repo and create a topic branch for every feature/fix. Avoid\n  making changes directly on master branch.\n- All incoming features should be accompanied with tests.\n- Make sure that you run `go fmt` before submitting a change\n  set. Alternatively the Makefile has a flag for this, so you can call\n  `make fmt` as well.\n- The integration tests can be run in a docker container, for this run:\n\n```\nmake test-docker\n```\n\n### Getting in Touch\n\nWant to get in touch with the go-ceph team? We're available through a few\ndifferent channels:\n* Have a question, comment, or feedback:\n  [Use the Discussions Board](https://github.com/ceph/go-ceph/discussions)\n* Report an issue or request a feature:\n  [Issues Tracker](https://github.com/ceph/go-ceph/issues)\n* We participate in the Ceph\n  [user's mailing list](https://lists.ceph.io/hyperkitty/list/ceph-users@ceph.io/)\n  and [dev list](https://lists.ceph.io/hyperkitty/list/dev@ceph.io/)\n  and we also announce our releases on those lists\n* You can sometimes find us in the\n  [#ceph-devel IRC channel](https://ceph.io/irc/) - hours may vary\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fceph%2Fgo-ceph","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fceph%2Fgo-ceph","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fceph%2Fgo-ceph/lists"}