Skip to content

Commit f78bfa0

Browse files
authored
Merge pull request ceph#55003 from zdover23/wip-doc-2023-12-26-radosgw-admin-create-a-user
doc/radosgw: admin.rst - edit "Create a User" Reviewed-by: Jiffin Tony Thottan <[email protected]>
2 parents 2c694ec + 46139c8 commit f78bfa0

File tree

1 file changed

+16
-13
lines changed

1 file changed

+16
-13
lines changed

doc/radosgw/admin.rst

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,17 @@ Swift keys have access levels of ``read``, ``write``, ``readwrite`` and
4242
Create a User
4343
-------------
4444

45-
To create a user (S3 interface), execute the following::
45+
To create a user (S3 interface), run a command of the following form:
4646

47-
radosgw-admin user create --uid={username} --display-name="{display-name}" [--email={email}]
47+
.. prompt:: bash
4848

49-
For example::
49+
radosgw-admin user create --uid={username} --display-name="{display-name}" [--email={email}]
50+
51+
For example:
52+
53+
.. prompt:: bash
5054

51-
radosgw-admin user create --uid=johndoe --display-name="John Doe" [email protected]
55+
radosgw-admin user create --uid=johndoe --display-name="John Doe" [email protected]
5256

5357
.. code-block:: javascript
5458
@@ -75,16 +79,15 @@ For example::
7579
"max_objects": -1},
7680
"temp_url_keys": []}
7781
78-
Creating a user also creates an ``access_key`` and ``secret_key`` entry for use
79-
with any S3 API-compatible client.
82+
The creation of a user entails the creation of an ``access_key`` and a
83+
``secret_key`` entry, which can be used with any S3 API-compatible client.
8084

81-
.. important:: Check the key output. Sometimes ``radosgw-admin``
82-
generates a JSON escape (``\``) character, and some clients
83-
do not know how to handle JSON escape characters. Remedies include
84-
removing the JSON escape character (``\``), encapsulating the string
85-
in quotes, regenerating the key and ensuring that it
86-
does not have a JSON escape character or specify the key and secret
87-
manually.
85+
.. important:: Check the key output. Sometimes ``radosgw-admin`` generates a
86+
JSON escape (``\``) character, and some clients do not know how to handle
87+
JSON escape characters. Remedies include removing the JSON escape character
88+
(``\``), encapsulating the string in quotes, regenerating the key and
89+
ensuring that it does not have a JSON escape character, or specifying the
90+
key and secret manually.
8891

8992

9093
Create a Subuser

0 commit comments

Comments
 (0)