Commit Graph

39 Commits

Author SHA1 Message Date
riya-singhal31
eb651c28a4 fix: fixed few typos
Signed-off-by: riya-singhal31 <rsinghal@redhat.com>
2022-06-27 13:21:51 -04:00
John Mulligan
863d71caa5 rados: various readop & writeop apis are now stable
These apis are now stable as per the stability plan.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
2022-06-14 16:01:43 +00:00
John Mulligan
ec0b9a1455 rados: watcher apis are now stable
Watcher apis are now stable as per the stability plan.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
2022-06-14 16:01:43 +00:00
John Mulligan
d31582cf06 cephfs admin: remove deprecated EnableModule, DisableModule funcs
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2022-06-14 13:10:09 +00:00
Niels de Vos
e8c006b3af cephfs/admin: add CloneStatus.GetFailure()
In case cloning failed, Ceph Mgr returns an additional attribute in the
response. The "failed" attribute contains an errno (as string?!) and a
description. It is useful for applications using go-ceph to report the
error back to the user.

As the CloneStatus is on the same level as the CloneFailure object in
the response, keeping strictly to the CephFS Mgr API would break
compatibility. Instead, a new CloneStatus.GetFailure() method has been
introduced, returning a CloneFailure type (or nil) object with details
about the failure.

Signed-off-by: Niels de Vos <ndevos@redhat.com>
2022-06-09 19:47:04 +00:00
John Mulligan
9ac8b86285 docs: add API statuses for nfs admin api
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2022-06-09 16:24:31 +00:00
Sven Anderson
9f55b65d17 docs: replace references to PREVIEW comment
Signed-off-by: Sven Anderson <sven@redhat.com>
2022-06-06 14:42:04 +00:00
Sanford Miller
68ebb0520a rbd: expose rbd_snap_rename to Go clients
This implements the following method:
	(snapshot *Snapshot) Rename(destName string) error

Signed-off-by: Sanford Miller <smiller@digitalocean.com>
2022-05-17 14:40:07 +00:00
John Mulligan
f635d5d57c docs: document release processes in greater detail
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2022-04-21 13:07:40 +00:00
Sven Anderson
065210ad21 common/log: add missing api-status entries
Signed-off-by: Sven Anderson <sven@redhat.com>
2022-04-12 12:58:05 +00:00
Sebastian Riese
951a89174e rgw/admin: Generate API documentation for the new methods 2022-03-17 17:47:25 +00:00
mergify-bot
98ec2e31d6 rgw/admin: add suport for link/unlink bucket (#646)
rgw/admin: add suport for link/unlink bucket

Signed-off-by: wanggangfeng <gfengwong@gmail.com>

* rgw/admin: add comment and update-api

Signed-off-by: wanggangfeng <gfengwong@gmail.com>

* rgw/admin: add ceph_preview

Signed-off-by: wanggangfeng <gfengwong@gmail.com>

* Merge branch 'master' into feature-645

* Merge branch 'master' into feature-645

* Merge branch 'master' into feature-645

* Merge branch 'master' into feature-645

* rgw/admin: bucketLink
1 update api doc
2 remove optional check
3 update test

Signed-off-by: wanggangfeng <gfengwong@gmail.com>

* Update rgw/admin/link_test.go

Co-authored-by: Jiffin Tony Thottan  <thottanjiffin@gmail.com>

* rgw/admin: improve parameters name

Signed-off-by: wanggangfeng <gfengwong@gmail.com>

* Merge branch 'master' into feature-645

* Merge branch 'master' into feature-645

* Merge branch 'master' into feature-645
2022-03-14 20:10:28 +00:00
Robert Vasek
8371a1377d rados: use rados_read_op_omap_get_vals_by_keys2()
ReadOp.GetOmapValuesByKeys() now uses rados_read_op_omap_get_vals_by_keys2().
2022-03-09 14:02:56 +00:00
mergify-bot
a88702fb93 rados: add wrapper to set locator key on IOContext (#651)
add wrapper to set locator key on IOContext

Signed-off-by: Alexander Pücker <alexander.puecker@hetzner.com>

* mark API as PREVIEW and update docs

Signed-off-by: Alexander Pücker <alexander.puecker@hetzner.com>

* move new API call into own file to add preview build tag

Signed-off-by: Alexander Pücker <alexander.puecker@hetzner.com>

* reset locater with nil instead of a empty string

Signed-off-by: Alexander Pücker <alexander.puecker@hetzner.com>

* rename variables for naming consistency

Signed-off-by: Alexander Pücker <alexander.puecker@hetzner.com>

* update release versions for new API call

Signed-off-by: Alexander Pücker <alexander.puecker@hetzner.com>
2022-03-05 15:43:02 +00:00
Sven Anderson
2ae01ab6bc CI: remove castxml from scripts and docs
Signed-off-by: Sven Anderson <sven@redhat.com>
2022-02-21 14:45:42 +00:00
Sven Anderson
7ac455058f rados: declare WriteOp.CmpExt as stable
Signed-off-by: Sven Anderson <sven@redhat.com>
2022-02-14 16:50:27 +00:00
Sven Anderson
d3a4a05d55 rados: update api-status
Signed-off-by: Sven Anderson <sven@redhat.com>
2022-02-10 07:38:07 +00:00
Robert Vasek
573598cf22 rados: implement binding for read_op_omap_get_vals_by_keys
This commit implements binding for read_op_omap_get_vals_by_keys
RADOS Read operation.

Includes a unit test.

Signed-off-by: Robert Vasek <robert.vasek@cern.ch>
2022-02-09 15:25:37 +00:00
Robert Vasek
4cf39ce07b rados: implement binding for rados_write_op_setxattr
This commit implements binding for rados_write_op_setxattr
RADOS Write operation.

Includes a unit test.

Signed-off-by: Robert Vasek <robert.vasek@cern.ch>
2022-02-08 19:35:32 +00:00
John Mulligan
f705d41c96 cephfs admin: mark general mgr module funcs as deprecated
The versions in cluster/admin/manager should be used instead.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
2022-02-08 15:55:02 +00:00
John Mulligan
aaea0f85db docs: add common/admin/manager to API docs
These APIs already existed, and were considered stable in cephfs/admin
before getting moved. I initially was going to mark them preview but then
realized that cephfs/admin depends on them and having them marked
preview with the ceph_preview tag would break cephfs/admin. Due to the
above, I think an exception to the policy is warranted here as there
is not much new except the package itself.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
2022-02-08 15:55:02 +00:00
Robert Vasek
4c8fb2d210 rados: implement binding for rados_{read,write}_op_assert_version
This commit implements binding for rados_read_op_assert_version
RADOS Read operation as well as rados_write_op_assert_version
RADOS Write operation.

Includes unit tests for both.

Signed-off-by: Robert Vasek <robert.vasek@cern.ch>
2022-02-08 14:29:21 +00:00
Robert Vasek
17fbb4b3a0 rados: implement binding for rados_write_op_remove
This commit implements binding for rados_write_op_remove RADOS Write operation.
Includes a unit test.

Signed-off-by: Robert Vasek <robert.vasek@cern.ch>
2022-02-07 23:08:33 +00:00
Robert Vasek
937f8d8164 rados: implement binding for rados_read_op_read
This commit implements binding for rados_read_op_read RADOS Read operation.
Includes a unit test.

Signed-off-by: Robert Vasek <robert.vasek@cern.ch>
2022-01-13 09:37:59 -05:00
Robert Vasek
0443277bb9 rados: implement binding for rados_write_op_cmpext
This commit implements binding for rados_write_op_cmpext RADOS Write operation.
Includes a unit test.

Signed-off-by: Robert Vasek <robert.vasek@cern.ch>
2021-12-08 19:07:12 +00:00
Robert Vasek
20da1c607d docs: api-update typo
This commit fixes a typo in development docs:

    s/udpate/update/g

Signed-off-by: Robert Vasek <robert.vasek@cern.ch>
2021-11-30 17:07:58 +00:00
Rakshith R
7d881032a6 rbd/admin: promote ImageSpec & tasks api to stable
Promoting ImageSpec & task apis to stable so
they can be release in v0.13.0.

Signed-off-by: Rakshith R <rar@redhat.com>
2021-11-29 15:07:06 +00:00
Seena Fallah
bae93ac4ab rbd: export image name
Signed-off-by: Seena Fallah <seenafallah@gmail.com>
2021-11-09 02:31:09 +00:00
John Mulligan
a1fbaf921a docs: expand on the newer doc/comment policies in dev guide
Specifically, this provides examples of the newly standardized
methods for marking deprecated and preview as well as telling
the user how to update the api-status docs.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-11-09 02:02:08 +00:00
John Mulligan
8f19d77c68 docs: reference api-status.md from api-stability.md
Removes a long standing TODO.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-11-09 02:02:08 +00:00
Sébastien Han
e23ab127c0 rgw/admin: promote add/remove caps to stable
Promoting the API.AddUserCap and API.RemoveUserCap calls to stable so
they can be release in 0.13.

Signed-off-by: Sébastien Han <seb@redhat.com>
2021-10-29 12:49:23 +00:00
Sven Anderson
ac4494e707 docs: use Go convention for deprectated APIs
Signed-off-by: Sven Anderson <sven@redhat.com>
2021-10-04 18:58:35 +00:00
John Mulligan
3fef124e9d docs: add new rbd admin functions to api-status (post rebase)
While working on this patch series new APIs were added to the rbd/admin
package. This patch includes them in the initial set of apis being
tracked.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-09-30 13:27:01 +00:00
John Mulligan
3f32efcf56 docs: add initial copies of the api-status.json & markdown doc
The file api-status.json is designed to track changes to the go-ceph
APIs, especially the 'deprecated' and 'preview' apis. It also stores
lists of stable apis so that we can see if something new but not
explicitly stable appears.

The api-status.md file is actually meant to be read by users of go-ceph
so to help make decisions about the use of new preview apis or
deprecated apis. It is generated from api-status.json.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-09-30 13:27:01 +00:00
Sven Anderson
83c0acf52c docs: add a API stability document
Signed-off-by: Sven Anderson <sven@redhat.com>
2021-08-25 16:51:26 +00:00
John Mulligan
4298c2bd0e docs: add an initial development guide
OK, I may have been too wordy, but its a start.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-06-21 09:11:36 -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
root
e89344cae1 fix typos 2020-05-01 09:37:09 -04:00
John Mulligan
9b53a23d14 docs: document the release process
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2020-02-17 09:44:18 -05:00