]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/radosrgw: edit admin.rst 55074/head
authorZac Dover <zac.dover@proton.me>
Fri, 5 Jan 2024 11:11:59 +0000 (21:11 +1000)
committerZac Dover <zac.dover@proton.me>
Fri, 5 Jan 2024 23:24:37 +0000 (09:24 +1000)
Edit "Add / Remove Admin Capabilities" in doc/radosgw/admin.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
(cherry picked from commit 1f0ff27898dfd06a17b18fadd52f68dfb73ccb94)

doc/radosgw/admin.rst

index f922ad2b8df606ffb7fc8dd1d3dbf8096fc3deb6..6eb36452edeaf408ca35c1c748cde6f79f57f0c8 100644 (file)
@@ -353,32 +353,43 @@ To remove a Swift secret key, run a command of the following form:
    radosgw-admin key rm --subuser=foo:bar --key-type=swift
 
 
-Add / Remove Admin Capabilities
--------------------------------
+Add or Remove Admin Capabilities
+--------------------------------
 
-The Ceph Storage Cluster provides an administrative API that enables  users to
-execute administrative functions via the REST API. By default, users do NOT have
-access to this API. To enable a user to exercise  administrative functionality,
-provide the user with administrative capabilities.
+The Ceph Storage Cluster provides an administrative API that enables users to
+execute administrative functions via the REST API. By default, users do NOT
+have access to this API. To enable a user to exercise administrative
+functionality, provide the user with administrative capabilities.
 
-To add administrative capabilities to a user, execute the following:: 
+To add administrative capabilities to a user, run a command of the following
+form: 
 
-       radosgw-admin caps add --uid={uid} --caps={caps}
+.. prompt:: bash
 
+   radosgw-admin caps add --uid={uid} --caps={caps}
 
-You can add read, write or all capabilities to users, buckets, metadata and 
-usage (utilization). For example::
 
-       --caps="[users|buckets|metadata|usage|zone|amz-cache|info|bilog|mdlog|datalog|user-policy|oidc-provider|roles|ratelimit]=[*|read|write|read, write]"
+You can add read, write or all capabilities to users, buckets, metadata and
+usage (utilization). To do this, use a command-line option of the following
+form:
 
-For example::
+.. prompt:: bash
+
+   --caps="[users|buckets|metadata|usage|zone|amz-cache|info|bilog|mdlog|datalog|user-policy|oidc-provider|roles|ratelimit]=[\*|read|write|read, write]"
+
+For example:
+
+.. prompt:: bash
 
        radosgw-admin caps add --uid=johndoe --caps="users=*;buckets=*"
 
+To remove administrative capabilities from a user, run a command of the
+following form: 
 
-To remove administrative capabilities from a user, execute the following:: 
+.. prompt:: bash
 
-       radosgw-admin caps rm --uid=johndoe --caps={caps}
+   radosgw-admin caps rm --uid=johndoe --caps={caps}
+  
 
 
 Quota Management