summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorZac Dover <zac.dover@proton.me>2025-01-11 01:02:24 +0100
committerGitHub <noreply@github.com>2025-01-11 01:02:24 +0100
commit5ffed2c45b21d1c9ab54082890cf3cf03a5ff81f (patch)
treeceb029901203bdbcf036d7317275903f37564e65 /doc
parentMerge pull request #55259 from linuxbox2/wip-object-attributes (diff)
parentdoc/rgw: document UserName requirements for account migration (diff)
downloadceph-5ffed2c45b21d1c9ab54082890cf3cf03a5ff81f.tar.xz
ceph-5ffed2c45b21d1c9ab54082890cf3cf03a5ff81f.zip
Merge pull request #61291 from cbodley/wip-69470
doc/rgw: document UserName requirements for account migration Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com> Reviewed-by: Zac Dover <zac.dover@proton.me>
Diffstat (limited to 'doc')
-rw-r--r--doc/radosgw/account.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/radosgw/account.rst b/doc/radosgw/account.rst
index 6dab997d93e..0e4ede5a50a 100644
--- a/doc/radosgw/account.rst
+++ b/doc/radosgw/account.rst
@@ -174,6 +174,11 @@ An existing user can be adopted into an account with ``user modify``::
.. note:: Account membership is permanent. Once added, users cannot be
removed from their account.
+.. note:: The IAM User API imposes additional requirements on the format
+ of ``UserName``, which is enforced when migrating users into an account.
+ If migration fails with "UserName contains invalid characters", the
+ ``--display-name`` should be modified to match ``[\w+=,.@-]+``.
+
.. warning:: Ownership of the user's notification topics will not be
transferred to the account. Notifications will continue to work, but
the topics will no longer be visible to SNS Topic APIs. Topics and