Commit Graph

56 Commits

Author SHA1 Message Date
Zac Dover
d8df6f61e8 doc/radosgw: edit "Usage" admin.rst
Edit "Usage" in doc/radosgw/admin.rst.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-01-26 09:12:59 +10:00
Zac Dover
c67a5e5d4b doc/radosgw: edit "read/write global rate limit" admin.rst
Edit "Reading/Writing Global Rate Limit Configuration" in
doc/radosgw/admin.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-01-23 12:13:10 +10:00
zdover23
f265c99628
Merge pull request #55190 from zdover23/wip-doc-2024-01-16-radosgw-admin-enable-disable-bucket-rate-limit
doc/radosgw: edit "Enable/Disable Bucket Rate Limit"

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2024-01-21 19:47:10 +10:00
Zac Dover
7c4fdd3762 doc/radosgw: edit admin.rst "Get Bucket Rate Limit"
Edit "Get Bucket Rate Limit" in doc/radosgw/admin.rst.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-01-20 16:55:56 +10:00
zdover23
6f0afdb7bd
Merge pull request #55170 from zdover23/wip-doc-2024-01-14-radosgw-admin-set-bucket-rate-limit
doc/radosgw: edit admin.rst "set bucket rate limit"

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2024-01-19 15:54:08 +10:00
Zac Dover
a1fca50dfd doc/radosgw: edit "Enable/Disable Bucket Rate Limit"
Edit "Enable/Disable Bucket Rate Limit" in doc/radosgw/admin.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-01-16 20:37:17 +10:00
Zac Dover
e9b3ef4cb1 doc/radosgw: edit admin.rst "set bucket rate limit"
Edit "Set Bucket Rate Limit" in doc/radosgw/admin.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-01-14 20:23:25 +10:00
Zac Dover
1cd996b6fe docs/radosgw: edit admin.rst "enable/disable user rate limit"
Edit "Enable/Disable User Rate Limit" in doc/radosgw/admin.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-01-14 04:06:12 +10:00
Anthony D'Atri
965284231a
Merge pull request #55142 from zdover23/wip-doc-2024-01-11-radosgw-user-rate-limit-ops
doc/radosgw - edit admin.rst "set user rate limit"
2024-01-11 09:30:47 -05:00
Zac Dover
1c561e2bea doc/radosgw: edit admin.rst "get user rate limit"
Edit "Get User Rate Limit" in doc/radosgw/admin.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-01-11 23:40:42 +10:00
Zac Dover
8660b4edc7 doc/radosgw - edit admin.rst "set user rate limit"
Edit "Set User Rate Limit" in doc/radosgw/admin.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-01-11 18:34:21 +10:00
Zac Dover
47fabe757c doc/rgw: edit admin.rst - rate limit management
Edit the "Rate Limit Management" section in doc/radosgw/admin.rst.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-01-10 21:20:08 +10:00
Zac Dover
22fce3c7a5 doc/radosgw: edit admin.rst - quota
Edit the "Quota Management" section (all of it) in
doc/radosgw/admin.rst.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-01-08 20:18:07 +10:00
Zac Dover
1f0ff27898 doc/radosrgw: edit admin.rst
Edit "Add / Remove Admin Capabilities" in doc/radosgw/admin.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-01-05 21:11:59 +10:00
Zac Dover
f62e93cbe7 doc/radosgw: edit "Add/Remove a Key"
Edit the section "Add/Remove a Key" in doc/radosgw/admin.rst. Each
operation (e.g. "Adding an S3 key pair for a user", "Removing an S3 key
pair for a user") now has its own subsection. This increased granularity
should make it easier in the future to link to each of these specific
operations, if needed.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-01-04 00:29:21 +10:00
Zac Dover
8fc3c48886 doc/radosgw: edit "remove a subuser"
Edit the English language in the section "Remove a Subuser" in
doc/radosgw/admin.rst. This commit is made in response to Matt
Benjamin's request for improvement of this section
(https://github.com/ceph/ceph/pull/55028#discussion_r1438599833).

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-12-31 16:22:33 +10:00
Zac Dover
8631dc58f7 doc/radosgw: edit sections
Edit the following sections in doc/radosgw/admin.rst:

* Remove a User
* Remove a Subuser

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-12-30 22:02:18 +10:00
zdover23
e4c37cd45b
Merge pull request #55011 from zdover23/wip-doc-2023-12-27-radosgw-admin-create-a-subuser
doc/radosgw: admin.rst - edit "Create a Subuser"

Reviewed-by: Cole Mitchell <cole.mitchell.ceph@gmail.com>
2023-12-28 10:44:17 +10:00
Zac Dover
21ebd2e855 doc/radosgw: admin.rst - edit sections
Edit the following sections in doc/radosgw/admin.rst:

- Get User Info
- Modify User Info
- User Suspend/Enable (I split this into two sections)

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-12-27 23:31:36 +10:00
Zac Dover
3c7a6c41df doc/radosgw: admin.rst - edit "Create a Subuser"
Edit the section "Create a Subuser" in doc/radosgw/admin.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-12-27 14:28:51 +10:00
Zac Dover
46139c8fa9 doc/radosgw: admin.rst - edit "Create a User"
Edit the section "Create a User" in doc/radosgw/admin.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-12-26 14:32:35 +10:00
Zac Dover
819b2974e6 doc/radosgw: edit admin.rst 1 of x
Edit doc/radosgw/admin.rst to the end of the section "User Management".
Correct grammar (mostly awkward prepositions) and tidy up weird clauses.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-12-25 05:34:26 +10:00
Anthony D'Atri
c4baaa2ab5
Merge pull request #52354 from bluikko/patch-13
doc/radosgw/admin.rst: use underscores in config var names
2023-12-16 14:11:54 -05:00
Zac Dover
51b7ff76fc doc/radosgw: update rate limit management
Improve the grammar and readability of the "Rate Limit Management"
section of doc/radosgw/admin.rst. This commit follows from
https://github.com/ceph/ceph/pull/52131.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-08-01 07:27:10 +10:00
Piotr Parczewski
50bfbab6d9
doc/radosgw: correct emphasis in rate limit section
Signed-off-by: Piotr Parczewski <piotr@stackhpc.com>
2023-07-31 16:42:26 +02:00
Ville Ojamo
dd16ad9055 doc/radosgw: Add missing space to date option spec in admin.rst
The start time and end time CLI option specification is missing a space between the date and the optional time value. Also expand the text to talk about "optional time" after the date.

Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com>
2023-07-28 10:54:06 +07:00
Ville Ojamo
cd323cb664
doc/radosgw/admin.rst: use underscores in config var names
Following the current policy, config var names in `ceph.conf` etc. should use underscores instead of spaces.

Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com>
2023-07-07 17:02:19 +07:00
stevenhua
870e8e7b3f doc/radosgw: fix command error blank 2022-11-01 09:53:02 +08:00
Or Friedmann
fd084fd7fc rgw: Add admin ops API for rate limiting
Add admin ops API for rate limiting and some bug fixes

Signed-off-by: Or Friedmann <ofriedma@redhat.com>
2022-01-10 16:48:56 +00:00
Or Friedmann
71ffbaee08 rgw: Add rgw rate limiting per user and per bucket
Add rgw rate limiting per user and per bucket

Signed-off-by: Or Friedmann <ofriedma@redhat.com>
2022-01-05 15:22:13 +00:00
Dimitri Savineau
55b687a624 doc/radosgw/admin: fix key subuser typo
The subuser parameter needs two dashes.

Signed-off-by: Dimitri Savineau <dsavinea@redhat.com>
2020-05-29 13:47:56 -04:00
Kefu Chai
0cb56e0f13 doc: use plantweb as fallback of sphinx-ditaa
RTD does not support installing system packages, the only ways to install
dependencies are setuptools and pip. while ditaa is a tool written in
Java. so we need to find a native python tool allowing us to render ditaa
images. plantweb is able to the web service for rendering the ditaa
diagram. so let's use it as a fallback if "ditaa" is not around.

also start a new line after the directive, otherwise planweb server will
return 500 at seeing the diagram.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-04-10 08:38:06 +08:00
Abhishek Lekshmanan
b5f24c9f14 rgw: s3: document usage stats api
Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
2020-02-25 19:10:55 +01:00
Feng Hualong
1a8741e37e doc/radosgw/admin:fix how to modify subuser info
Signed-off-by: Feng Hualong <hualong.feng@intel.com>
2019-08-23 16:41:38 +08:00
Sage Weil
b700f0fbfd rgw: remove auid member from RGWUserInfo
Unused.

Signed-off-by: Sage Weil <sage@redhat.com>
2018-08-31 15:54:58 -05:00
Enming Zhang
4e79414bfe doc: fix doc/radosgw/admin.rst typos
Signed-off-by: Enming Zhang <enming.zhang@umcloud.com>
2017-08-31 21:52:05 +08:00
Daniel Gryniewicz
4327d1bd2d Document RGW quota cache options
Quota cache options were undocumented.

Fixes: http://tracker.ceph.com/issues/18747
Signed-off-by: Daniel Gryniewicz <dang@redhat.com>
2017-06-07 14:47:04 -04:00
Kefu Chai
7b676f4f0f Merge pull request #14384 from hrchu/radosgw-admin-key
doc: rgw: Rewrite the key management

Reviewed-by: Casey Bodley <cbodley@redhat.com>
2017-04-28 23:32:16 +08:00
hrchu
a1a0dcfa40 doc: rgw: Rewrite the key management
The create/remove key section in the doc is a bit confusing.
Rewrite it and give more examples.

Signed-off-by: hrchu <hrchu@cht.com.tw>
2017-04-26 14:55:32 +08:00
Casey Bodley
a510acfe78 Merge pull request #13956 from hrchu/rgw-admin-doc
Indicate how to add multiple admin capbabilies

Reviewed-by: Casey Bodley <cbodley@redhat.com>
2017-04-21 10:52:28 -04:00
Hans van den Bogert
b26f62265b doc: rgw: remove mention of megabytes for quotas
Remove mention of confusing reference to megabytes in opening paragraph of "quota management".
To remove further confusion, mention that setting a size for '--max-size' is in bytes by default.

Signed-off-by: Hans van den Bogert <hansbogert@gmail.com>
2017-04-09 13:40:29 +02:00
Casey Bodley
8e31c002e3 doc/rgw: update section on global quotas
Signed-off-by: Casey Bodley <cbodley@redhat.com>
2017-04-03 14:48:58 -04:00
hrchu
fffe28f217 doc: Indicate how to add multiple admin capbabilies
Signed-off-by: Chu, Hua-Rong <hrchu@cht.com.tw>
2017-03-17 08:53:32 +08:00
Mike Hackett
3564ee3c06 doc: add rgw_enable_usage_log option in Rados Gateway
admin guide

Fixes: http://tracker.ceph.com/issues/16604

Signed-off-by: Mike Hackett <mhackett@redhat.com>
2016-07-07 10:31:50 -04:00
root
e3ab347614 rgw: Add documentation for RGW default quota
Signed-off-by: Pavan Rallabhandi <PRallabhandi@walmartlabs.com>
2016-06-20 16:18:00 +05:30
Vikhyat Umrao
62eec902c7 rgw: support size suffixes for --max-size in
radosgw-admin command

Fixes: http://tracker.ceph.com/issues/16004

Signed-off-by: Vikhyat Umrao <vumrao@redhat.com>
2016-05-26 23:01:26 +05:30
YankunLi
4dd86ca93e correct radosgw-admin command
the command to disable users quota should be 'radosgw-admin quota disable --quota-scope=<user | bucket> --uid=<uid>'
2015-12-22 13:56:50 +08:00
YankunLi
2cf8d20aee update radosgw-admin command
the command "radosgw-admin caps remove" should be "radosgw-admin caps rm" 
radosgw-admin:
commands
caps rm                    remove user capabilities
2015-10-14 10:54:52 +08:00
Sangdi Xu
c901e855a5 doc:radosgw: correct typos of the command removing a subuser
Fix typos in the example command removing a subuser, and delete the 'The Ceph Object Gateway' tag as it should not appear there.

Signed-off-by: Sangdi Xu <xu.sangdi@h3c.com>
2015-08-28 18:19:23 +08:00
Abhishek Lekshmanan
daadff4cd0 doc: minor format fix for radosgw admin docs
Missing backtick fixed

Signed-off-by: Abhishek Lekshmanan <abhishek.lekshmanan@gmail.com>
2014-07-11 18:03:54 +05:30