Commit Graph

1067 Commits

Author SHA1 Message Date
Zac Dover
ccb851d2a4 doc/rados: remove PGcalc from docs
Remove mention of the "PG calc" tool from the documentation. I have
removed all mention of this in one fell swoop to help posterity restore
mention of this tool if we decide we need to do so.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-03-03 20:28:00 +10:00
Zac Dover
8af910f877 doc/radosgw: edit multisite.rst
Edit "Varieties of Multi-Site Configuration" in
doc/radosgw/multisite.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-02-20 22:06:11 +10:00
Casey Bodley
7682fae85e
Merge pull request #55508 from cbodley/wip-59186
rgw/user: add 'active' flag to RGWAccessKey

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Daniel Gryniewicz <dang@redhat.com>
2024-02-19 17:50:59 +00:00
Ali Maredia
54cae2cebd
Merge pull request #55156 from alimaredia/wip-rgw-add-cap-user-without-keys
rgw: add new cap user-info-without-keys

Reviewed-by: Casey Bodley <cbodley@redhat.com>
2024-02-12 13:35:09 -05:00
Zac Dover
284e99ebc6 doc/radosgw: undo 55524
Roll back the docs changes made in
https://github.com/ceph/ceph/pull/55524, in accordance with Casey
Bodley's instructions to me here:
https://github.com/ceph/ceph/pull/55524#issuecomment-1937020543.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-02-11 00:36:29 +10:00
Zac Dover
8bfe2d1ae6 doc/radosgw: remove invalid LUA context options
Remove "background", "getdata", and "putdata" from the list of LUA
context options. Passing these options throws the following error:
"ERROR: invalid script context: background. must be one of: preRequest,
postRequest".

Fixes: https://tracker.ceph.com/issues/64327

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-02-10 13:14:59 +10:00
Casey Bodley
463f463d50 rgw/user: add 'active' flag to RGWAccessKey
inactive keys are removed from the key pool so can't be used to
authenticate. the 'key create' admin op now takes an 'active' option

Fixes: https://tracker.ceph.com/issues/59186

Signed-off-by: Casey Bodley <cbodley@redhat.com>
2024-02-09 09:23:08 -05:00
zdover23
608a5b2b92
Merge pull request #55475 from zdover23/wip-doc-2024-02-07-radosgw-admin-confval
doc/radosgw: add confval directives

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2024-02-08 05:04:35 +10:00
Zac Dover
6504732e1b doc/radosgw: add confval directives
Add confval directives to the documentation of "quota cache" options.
This addresses a request made by Antony D'Atri in https://github.com/ceph/ceph/pull/55075/files#r1444006246.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-02-08 01:10:18 +10:00
Ali Maredia
f0987e5151 rgw: add new cap user-info-without-keys
This new cap allows users to run the admin api op
`get user info` without the S3 keys and Swift keys
in the response.

Signed-off-by: Ali Maredia <amaredia@redhat.com>
2024-02-05 19:08:02 +00:00
Ali Maredia
eaa4ccd729 rgw: change section name of rgw_op counters
The rgw_op section of `counter dump/schema` becomes:
- rgw_op_global for the global op counters
- rgw_op_per_user for the user labeled counters
- rgw_op_per_bucket for the bucket labeled counters

Signed-off-by: Ali Maredia <amaredia@redhat.com>
2024-01-31 17:18:03 -05:00
Casey Bodley
ecbd837667 doc/rgw: fix Attributes index in CreateTopic example
Signed-off-by: Casey Bodley <cbodley@redhat.com>
2024-01-31 12:31:02 -05:00
Zac Dover
9f271093f4 doc/radosgw: fix verb disagreement - index.html
Fix a tricky verb disagreement and rewrite a few sentences for what I
hope is greater clarity.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-01-28 18:04:57 +10:00
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
zdover23
6c2c477d92
Merge pull request #55069 from ceph/wip-rgw-adminops-user-info-doc-update
doc: update rgw admin api req params for get user info

Reviewed-by: Casey Bodley <cbodley@redhat.com>
Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2024-01-06 09:20:39 +10:00
Ali Maredia
e6c58dcd61 doc: update rgw admin api req params for get user info
Signed-off-by: Ali Maredia <amaredia@redhat.com>
2024-01-05 20:51:06 +00: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
Zac Dover
64b0eb7d05 doc/radosgw: list supported plugins-compression.rst
List supported compression plugins in doc/radosgw/compression.rst.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-12-22 23:31:49 +10:00
Zac Dover
84c5d2c828 doc/radosgw: edit compression.rst
Improve the grammar and simplify the sentence structure of
doc/radosgw/compression.rst. This commit is made in anticipation of a
near-future commit that will list the compression algorithms available
to users of Ceph.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-12-21 20:58:21 +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
31d72b8ecc doc/radosgw: format commands in role.rst
Format approximately one-hundred lines of doc/radosgw/role.rst to
include proper command prompts. I also made one small English usage
improvement.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-12-15 06:46:18 +10:00
Zac Dover
fa6ad94f3a doc/radosgw: format "Create a Role"
Properly format the section "Create a Role" in the file
doc/radosgw/role.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-12-12 22:09:13 +10:00
Zac Dover
9d10361961 doc/radosgw: edit front matter - role.rst
Clarify the front matter in doc/radosgw/role.rst.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-12-11 07:38:34 +10:00
Zac Dover
1c0901cf85 doc/radosgw: format POST statements
Format the POST methods so that they appear in the rendered text as
examples of POST API calls and not as plain old unformatted text, which
is how they looked before this commit. The content of these API calls
remains to be tested and confirmed to work, but this is a first step.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-12-09 04:46:00 +01:00
zdover23
191fefc4d1
Merge pull request #54751 from zdover23/wip-doc-2023-12-02-radosgw-multisite-starting-the-gateway
doc/radosgw: add gateway starting command

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2023-12-08 06:09:15 +01:00
Zac Dover
ec7c515490 doc/radosgw: add gateway starting command
Add a command that properly starts (or restarts) the RADOS gateway after
RGW settings have been changed. This commit has been added in response
to an issue reported anonymously on
https://pad.ceph.com/p/Report_Documentation_Bugs.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-12-06 09:25:32 +01:00
Zac Dover
e80d560d97 doc/radosgw: update link in rgw-cache.rst
Update link in doc/radosgw/rgw-cache.rst. The link updated here is a
link to all the Nginx configuration files. The old link was broken. This
update comes to us from an anonymous report on
https://pad.ceph.com/p/Report_Documentation_Bugs.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-12-05 20:46:26 +01:00
Zac Dover
08ac3114e9 doc/radosgw: fix formatting
Repair the formatting of a string that had a string inside backticks
that itself was inside double asterisks. The presence of the asterisks
around the entire string caused the backticks to appear in the rendered
documentation.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-12-02 06:38:28 +01:00
Casey Bodley
7a3eb76761 rgw/acl: ACLGrant uses variant for grantee types
use of `ACLGrant::get_id()` was awkward because most grantee types
returned nothing, but emails were returned as `struct rgw_user`. change
the internal representation into a variant, and expose getters for each
grantee type so callers can handle each type specifically. the encoded
format of `ACLGrant` remains unchanged

Signed-off-by: Casey Bodley <cbodley@redhat.com>
2023-11-30 11:25:02 -05:00
Anthony D'Atri
f232219159
Merge pull request #54641 from likid0/ceph_session_tags_fixes
doc/radosgw: Fix JSON typo in Principal Tag example code snippet
2023-11-23 17:38:42 -05:00