]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
Merge pull request #62877 from bluikko/doc-formatting-radosgw
authorZac Dover <zac.dover@proton.me>
Tue, 22 Apr 2025 09:47:09 +0000 (19:47 +1000)
committerGitHub <noreply@github.com>
Tue, 22 Apr 2025 09:47:09 +0000 (19:47 +1000)
doc/radosgw: Improve and more consistent formatting

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
1  2 
doc/radosgw/admin.rst

index 002702c7f21df52283bb675da1ae443e798065d2,e554e8f34039c92005e6fbda5ad6473be2ff1357..f3f3e98a62b4540358a3092e9dff762ecf987334
@@@ -394,44 -393,11 +393,44 @@@ For example
  To remove administrative capabilities from a user, run a command of the
  following form: 
  
- .. prompt:: bash
+ .. prompt:: bash #
  
     radosgw-admin caps rm --uid=johndoe --caps={caps}
 -  
  
 +Admin and System Users
 +----------------------
 +
 +Users with the ``--admin`` or ``--system`` flag have global read and write
 +permissions. These permissions apply to all APIs including S3 and Swift,
 +unlike Admin Capabilities, and cannot be denied by IAM policy.
 +
 +The ``--system`` flag should only be used as documented in `Multisite Configuration`_.
 +
 +The ``--admin`` flag can be useful for troubleshooting and recovery. For
 +example, if a user accidentally removes their permissions to a bucket or
 +object, the admin user's credentials can be used to issue the S3/Swift API
 +requests necessary to restore them.
 +
 +.. warning:: When not in use, consider deleting the admin user or disabling
 +   its access keys. Do not give admin permissions to untrusted users.
 +
 +To create an admin user:
 +
 +.. prompt:: bash
 +
 +   radosgw-admin user create --uid={username} --display-name="{display-name}" --admin
 +
 +To add the admin flag to an existing user:
 +
 +.. prompt:: bash
 +
 +   radosgw-admin user modify --uid={username} --admin
 +
 +To remove the admin flag from an existing user:
 +
 +.. prompt:: bash
 +
 +   radosgw-admin user modify --uid={username} --admin=0
  
  Quota Management
  ================