summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorCasey Bodley <cbodley@redhat.com>2025-01-09 18:52:03 +0100
committerCasey Bodley <cbodley@redhat.com>2025-01-09 19:39:44 +0100
commitafa2b83687de96bfe9ae90c73744f71217dabcbe (patch)
tree0069805aa25e999045b2dec0c1b2195e6c286eb5 /doc
parentMerge pull request #60330 from JonBailey1993/JonBailey1993/ceph_test_rados_io... (diff)
downloadceph-afa2b83687de96bfe9ae90c73744f71217dabcbe.tar.xz
ceph-afa2b83687de96bfe9ae90c73744f71217dabcbe.zip
doc/rgw: document UserName requirements for account migration
clarify the following error when migrating a user into an account: > could not modify user: unable to modify user, UserName contains invalid characters Fixes: https://tracker.ceph.com/issues/69470 Signed-off-by: Casey Bodley <cbodley@redhat.com>
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