Skip to content

Commit afa2b83

Browse files
committed
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 <[email protected]>
1 parent 3383af5 commit afa2b83

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

doc/radosgw/account.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,11 @@ An existing user can be adopted into an account with ``user modify``::
174174
.. note:: Account membership is permanent. Once added, users cannot be
175175
removed from their account.
176176

177+
.. note:: The IAM User API imposes additional requirements on the format
178+
of ``UserName``, which is enforced when migrating users into an account.
179+
If migration fails with "UserName contains invalid characters", the
180+
``--display-name`` should be modified to match ``[\w+=,.@-]+``.
181+
177182
.. warning:: Ownership of the user's notification topics will not be
178183
transferred to the account. Notifications will continue to work, but
179184
the topics will no longer be visible to SNS Topic APIs. Topics and

0 commit comments

Comments
 (0)