In my opinion the list of releases and the ceph versions supported was
getting a bit long. I am taking the initiative to split the list and
record the older releases in a separate doc. The cut point was a bit
arbitrary but I chose to remove all the caveats from the readme.
Signed-off-by: John Mulligan <jmulligan@redhat.com>
The v0.16.0 has a "sword" marker noting that quincy was working but not
officially fully supported in v0.16. Now that v0.16 is a few releases in
the past we can simplify that note down to the minimal level of details.
Signed-off-by: John Mulligan <jmulligan@redhat.com>
Add a new "Getting in Touch" with the go-ceph team section. This more
closely reflects the reality of our preference for direct async channels
(discussions, issues), indirect async channels (the ceph lists) and then
the sync chat which we really haven't been adhering to for quite some
time.
Signed-off-by: John Mulligan <jmulligan@redhat.com>
Following this discussion #492
This commit introduces a new package "rgw/admin" which helps you interact
with the [RadosGW Admin Ops API](https://docs.ceph.com/en/latest/radosgw/adminops).
Not all the API capabilities are covered by this commit, but this is a
solid foundation for adding code on top. I'm expecting a few more
iterations to make 100% complete. Also, the RadosGW Admin API is going
to implement new functions soon (like bucket creation). So this library
will live on and keep catching up.
As many unit tests as possible have been added. A new integration test
suite also runs. The "micro-osd.sh" now deploys a RGW and the
integration suite tests on it. Thus the CI should cover it.
Shout out to @QuentinPerez and @IrekFasikhov for their existing
libraries. They were a very good inspiration to get started.
Co-authored-by: Irek Fasikhov <malmyzh@gmail.com>
Co-authored-by: Quentin Perez <qperez42@gmail.com>
Signed-off-by: Sébastien Han <seb@redhat.com>
Make the statemant about not being able to statically link a less
general statement. It's not just cgo, we also only have shared objects
from ceph lib{rados,rbd,cephfs}.
Signed-off-by: John Mulligan <jmulligan@redhat.com>
There were various random "documentation" tidbits, all for rados,
on the main readme. As these are neither comprehensive nor complete
I am moving them to a seperate page and calling them "hints" which
seem to be closer to what they are.
Eventually, we could include more comprehensive examples in the
docs/ directory.
Signed-off-by: John Mulligan <jmulligan@redhat.com>
Add a caveat that go-ceph requires the ceph dynamically linked libraries
at runtime and that static linking is not available.
Signed-off-by: John Mulligan <jmulligan@redhat.com>
Like a lot of projects on github the readme didn't really explain what
go-ceph *is*. There is a very brief project description and if you're
clever you may know what "bindings" are. This short introduction should
help clarify and expand that for any newcomers to the project.
Signed-off-by: John Mulligan <jmulligan@redhat.com>
This "badge" was making use of travis ci. We dropped use of travis ci
months ago. I am opting not to replace the badge with something new
because I don't think badges are useful in the first place.
But I don't want to rock the boat too much and remove all of them.
Signed-off-by: John Mulligan <jmulligan@redhat.com>
Switch the example of how to compile go-ceph with tags to refer to
nautilus in light of luminous and mimic being deprecated.
Small wording/grammar changes to try and make the sentence clearer.
Signed-off-by: John Mulligan <jmulligan@redhat.com>
The older godoc.org encourages the user to use pkg.go.dev instead.
Change our link to point directly there (and use https).
Signed-off-by: John Mulligan <jmulligan@redhat.com>
In order to selectively exclude/include certain .go files while building
and testing with the standard `go` tools, build-tags can be used.
Because go-ceph aims to support multiple Ceph versions, some functions
might not be available in the C libraries, or have been marked
deprecated in the header files. By selectively excluding/including some
of the .go files, warnings and errors can be prevented.
See-also: https://golang.org/pkg/go/build/#hdr-Build_Constraints
Signed-off-by: Niels de Vos <ndevos@redhat.com>
This commit adds the following cephfs functions:
* Unmount // Unmounting is necessary to cleanup mounts
* Release // Release destroys the cmount ~ end of transaction
* RemoveDir // inverse of MakeDir
* Chown // change ownership of file or directory
* Chmod // change permissions of file or directory
Tests are included for each function.
In addition to these changes modifications to:
.travis.yml, Dockerfile, and Makefile
were made to accomodate tests to mount the ceph volume. Tests use
fuse to mount the volume which requires adding:
--device /dev/fuse --cap-add SYS_ADMIN --security-opt \
apparmor:unconfined
to the docker container (alternatively --privileged works but adds
additional permissions).
Changes to README add the above docker changes as well as point
users to the necessary ceph development libraries.
