]> git.proxmox.com Git - ceph.git/blobdiff - ceph/doc/radosgw/adminops.rst
update sources to ceph Nautilus 14.2.1
[ceph.git] / ceph / doc / radosgw / adminops.rst
index 16efd5f848375ee016c0f5858bca0804d46eb867..9d39cb3b875c4225c471c3ca248c8d18a4d12ed8 100644 (file)
@@ -347,7 +347,9 @@ Request Parameters
 :Type: String
 :Example: ``foo_user``
 :Required: Yes
-A tenant name may also specified as a part of ``uid``, by following the syntax ``tenant$user``, refer to `Multitenancy`_ for more details.
+
+A tenant name may also specified as a part of ``uid``, by following the syntax
+``tenant$user``, refer to :ref:`Multitenancy <rgw-multitenancy>` for more details.
 
 ``display-name``
 
@@ -415,6 +417,7 @@ A tenant name may also specified as a part of ``uid``, by following the syntax `
 :Required: No
 
 .. versionadded:: Jewel
+
 ``tenant``
 
 :Description: the Tenant under which a user is a part of.
@@ -433,7 +436,8 @@ If successful, the response contains the user information.
 :Type: Container
 
 ``tenant``
-:Description: The tenant which user is a part of
+
+:Description: The tenant which user is a part of.
 :Type: String
 :Parent: ``user``
 
@@ -764,7 +768,7 @@ Create Subuser
 ==============
 
 Create a new subuser (primarily useful for clients using the Swift API).
-Note that in general for a subuser to be useful, it must be granted 
+Note that in general for a subuser to be useful, it must be granted
 permissions by specifying ``access``. As with user creation if
 ``subuser`` is specified without ``secret``, then a secret key will
 be automatically generated.
@@ -1217,7 +1221,7 @@ Get Bucket Info
 ===============
 
 Get information about a subset of the existing buckets. If ``uid`` is specified
-without ``bucket`` then all buckets beloning to the user will be returned. If
+without ``bucket`` then all buckets belonging to the user will be returned. If
 ``bucket`` alone is specified, information for that particular bucket will be
 retrieved.
 
@@ -1856,7 +1860,7 @@ Valid parameters for quotas include:
 
 - **Maximum Objects:** The ``max-objects`` setting allows you to specify
   the maximum number of objects. A negative value disables this setting.
-  
+
 - **Maximum Size:** The ``max-size`` option allows you to specify a quota
   for the maximum number of bytes. The ``max-size-kb`` option allows you
   to specify it in KiB. A negative value disables this setting.
@@ -1870,7 +1874,7 @@ Valid parameters for quotas include:
 Get User Quota
 ~~~~~~~~~~~~~~
 
-To get a quota, the user must have ``users`` capability set with ``read`` 
+To get a quota, the user must have ``users`` capability set with ``read``
 permission. ::
 
        GET /admin/user?quota&uid=<uid>&quota-type=user
@@ -1879,7 +1883,7 @@ permission. ::
 Set User Quota
 ~~~~~~~~~~~~~~
 
-To set a quota, the user must have ``users`` capability set with ``write`` 
+To set a quota, the user must have ``users`` capability set with ``write``
 permission. ::
 
        PUT /admin/user?quota&uid=<uid>&quota-type=user
@@ -1892,7 +1896,7 @@ as encoded in the corresponding read operation.
 Get Bucket Quota
 ~~~~~~~~~~~~~~~~
 
-To get a quota, the user must have ``users`` capability set with ``read`` 
+To get a quota, the user must have ``users`` capability set with ``read``
 permission. ::
 
        GET /admin/user?quota&uid=<uid>&quota-type=bucket
@@ -1901,7 +1905,7 @@ permission. ::
 Set Bucket Quota
 ~~~~~~~~~~~~~~~~
 
-To set a quota, the user must have ``users`` capability set with ``write`` 
+To set a quota, the user must have ``users`` capability set with ``write``
 permission. ::
 
        PUT /admin/user?quota&uid=<uid>&quota-type=bucket
@@ -1953,6 +1957,31 @@ Standard Error Responses
 
 
 
+
+Binding libraries
+========================
+
+``Golang``
+
+ - `IrekFasikhov/go-rgwadmin`_
+ - `QuentinPerez/go-radosgw`_
+
+``Java``
+ - `twonote/radosgw-admin4j`_
+
+``Python``
+
+ - `UMIACS/rgwadmin`_
+ - `valerytschopp/python-radosgw-admin`_
+
+
+
 .. _Admin Guide: ../admin
 .. _Quota Management: ../admin#quota-management
-.. _Multitenancy: ./multitenancy
+.. _IrekFasikhov/go-rgwadmin: https://github.com/IrekFasikhov/go-rgwadmin
+.. _QuentinPerez/go-radosgw: https://github.com/QuentinPerez/go-radosgw
+.. _twonote/radosgw-admin4j: https://github.com/twonote/radosgw-admin4j
+.. _UMIACS/rgwadmin: https://github.com/UMIACS/rgwadmin
+.. _valerytschopp/python-radosgw-admin: https://github.com/valerytschopp/python-radosgw-admin
+