Commit Graph

36 Commits

Author SHA1 Message Date
John Mulligan 574b3584fa readme: document v0.7.0 and the ceph versions it supports
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2020-12-14 09:54:45 -05:00
John Mulligan 28912b8d3c readme: document v0.6.0 and supported ceph versions
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2020-10-14 09:53:23 +02:00
John Mulligan c845565e1b readme: clarify why we can't make static binaries
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>
2020-08-28 13:44:24 -04:00
John Mulligan f88b87eaab readme: "Development" sub-title was at the wrong level
All other titles were at level two. Make "Development" consistent.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
2020-08-28 13:44:24 -04:00
John Mulligan 4ec7a91da8 readme: move the scattershot api hints to a separate doc
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>
2020-08-28 13:44:24 -04:00
John Mulligan a1641d2838 readme: note that code using go-ceph needs go dynamic libs
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>
2020-08-28 13:44:24 -04:00
John Mulligan c6113f79f9 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>
2020-08-28 13:44:24 -04:00
John Mulligan 07243682f2 readme: add brief introduction to what go-ceph is
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>
2020-08-28 13:44:24 -04:00
John Mulligan db01338d4a readme: remove irrelevant "badge" from README.md
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>
2020-08-28 13:44:24 -04:00
John Mulligan d0f3a30c57 readme: add a support table for go-ceph <-> ceph versions
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2020-08-25 09:00:56 -04:00
John Mulligan d2d2af34b1 readme: another small wording tweak
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2020-08-25 09:00:56 -04:00
John Mulligan 76bb869f02 readme: switch example tag use to 'nautilus'
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>
2020-08-25 09:00:56 -04:00
John Mulligan 0498d7dbc9 readme: minor grammatical tweaks
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2020-08-25 09:00:56 -04:00
John Mulligan e1fd17df8b readme: advertise maintainer "office hours"
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2020-04-08 10:31:23 -04:00
John Mulligan dc289754c8 readme: update doc link to pkg.go.dev
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>
2020-02-13 07:28:33 +01:00
Niels de Vos 7e3a5850f3 README: add requirement for build-tags when using non-current Ceph libraries
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>
2020-02-12 13:48:21 -05:00
Lincoln Thurlow ecf9a99249 cephfs: add unmount, release, chmod, chown, etc
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.
2018-10-11 11:09:16 -07:00
dmaiocchi f34b1cc12a Make example more golang 2018-10-07 09:36:09 +02:00
Noah Watkins 3b687cfa99 doc: add note about vstart.sh setup
Signed-off-by: Noah Watkins <noahwatkins@gmail.com>
2018-07-28 10:08:19 -07:00
Noah Watkins 19a37c4565 ci: update to luminous and dockerized setup
Signed-off-by: Noah Watkins <nwatkins@redhat.com>
2018-07-07 13:20:41 -07:00
Noah Watkins 25b1a318b3 doc: update readme
Signed-off-by: Noah Watkins <noahwatkins@gmail.com>
2017-01-20 09:47:55 -08:00
Noah Watkins a1c7418732 doc: fix travis link
Signed-off-by: Noah Watkins <noahwatkins@gmail.com>
2017-01-12 15:23:11 -08:00
Noah Watkins 3f52ea219a repo: update new repo path
noahdesu -> ceph

Signed-off-by: Noah Watkins <noahwatkins@gmail.com>
2015-08-31 07:34:42 -07:00
Abhishek Lekshmanan 2d8d57f246 doc: add basic instructions for contributing
Added basic info for some standards to be followed, how to run tests
etc.

Signed-off-by: Abhishek Lekshmanan <abhishek.lekshmanan@gmail.com>
2015-07-17 22:41:18 +05:30
Noah Watkins f5bfcec122 fix go-rados -> go-ceph renames
Signed-off-by: Noah Watkins <noahwatkins@gmail.com>
2015-01-14 17:30:46 -08:00
Noah Watkins 5ef4380a80 ci: fix travis status link
Signed-off-by: Noah Watkins <noahwatkins@gmail.com>
2015-01-13 09:00:18 -08:00
Noah Watkins c1fad23ca4 doc: project name change
Signed-off-by: Noah Watkins <noahwatkins@gmail.com>
2015-01-13 08:34:02 -08:00
Noah Watkins 7316c3d70f rados: rename pool to ioctx
Signed-off-by: Noah Watkins <noahwatkins@gmail.com>
2015-01-09 11:33:02 -08:00
Noah Watkins f2ebce042d doc: fix formatting in README
Signed-off-by: Noah Watkins <noahwatkins@gmail.com>
2014-12-03 21:05:59 -08:00
Noah Watkins 507dc20bc7 doc: add read/write example to readme
Signed-off-by: Noah Watkins <noahwatkins@gmail.com>
2014-12-03 21:05:08 -08:00
Noah Watkins b0bfca11f1 doc: add badges
Signed-off-by: Noah Watkins <noahwatkins@gmail.com>
2014-12-03 20:14:04 -08:00
Noah Watkins 9ebff556c2 doc: add semver note to readme
Signed-off-by: Noah Watkins <noahwatkins@gmail.com>
2014-11-27 16:44:02 -08:00
Noah Watkins 70e325826b test: use micro-osd script to setup ci build
Signed-off-by: Noah Watkins <noahwatkins@gmail.com>
2014-11-27 16:28:52 -08:00
Noah Watkins d509f9f5da doc: update README with examples
Signed-off-by: Noah Watkins <noahwatkins@gmail.com>
2014-09-03 07:16:18 -07:00
Noah Watkins 8659a52379 doc: update readme with example
Signed-off-by: Noah Watkins <noahwatkins@gmail.com>
2014-05-26 11:14:12 -07:00
Noah Watkins e9bf732345 doc: add readme
Signed-off-by: Noah Watkins <noahwatkins@gmail.com>
2014-05-24 11:13:54 -07:00