import 15.2.0 Octopus source

[ceph.git] / ceph / doc / man / 8 / radosgw-admin.rst

diff --git a/ceph/doc/man/8/radosgw-admin.rst b/ceph/doc/man/8/radosgw-admin.rst
index 136c8a96b355730bbde2203ee2c2aeb43c8023c8..27569fa53e21eb0913871c58dec616305b7aa22f 100644 (file)
--- a/ceph/doc/man/8/radosgw-admin.rst
+++ b/ceph/doc/man/8/radosgw-admin.rst
@@ -35,6 +35,9 @@ which are as follows:
   Display information of a user, and any potentially available
   subusers and keys.
 
+:command:`user rename`
+  Renames a user.
+
 :command:`user rm`
   Remove a user.
 
@@ -89,6 +92,10 @@ which are as follows:
 :command:`bucket unlink`
   Unlink bucket from specified user.
 
+:command:`bucket chown`
+  Link bucket to specified user and update object ACLs. 
+  Use --marker to resume if command gets interrupted.
+
 :command:`bucket stats`
   Returns bucket statistics.
 
@@ -463,6 +470,10 @@ Options
 
    The radosgw user ID.
 
+.. option:: --new-uid=uid
+
+   ID of the new user. Used with 'user rename' command.
+
 .. option:: --subuser=<name>
 
        Name of the subuser.
@@ -517,9 +528,10 @@ Options
 
    Set the system flag on the user.
 
-.. option:: --bucket=bucket
+.. option:: --bucket=[tenant-id/]bucket
 
-   Specify the bucket name.
+   Specify the bucket name.  If tenant-id is not specified, the tenant-id
+   of the user (--uid) is used.
 
 .. option:: --pool=<pool>
 
@@ -546,9 +558,15 @@ Options
 
    Specify the bucket id.
 
+.. option:: --bucket-new-name=[tenant-id/]<bucket>
+
+   Optional for `bucket link`; use to rename a bucket.
+        While tenant-id/ can be specified, this is never
+        necessary for normal operation.
+
 .. option:: --shard-id=<shard-id>
 
-       Optional for mdlog list, data sync status. Required for ``mdlog trim``.
+       Optional for mdlog list, bi list, data sync status. Required for ``mdlog trim``.
 
 .. option:: --max-entries=<entries>
 
@@ -710,6 +728,13 @@ Options
 
    Remove the zones from list of zones to sync from.
 
+.. option:: --bucket-index-max-shards
+
+   Override a zone's or zonegroup's default number of bucket index shards. This
+   option is accepted by the 'zone create', 'zone modify', 'zonegroup add',
+   and 'zonegroup modify' commands, and applies to buckets that are created
+   after the zone/zonegroup changes take effect.
+
 .. option:: --fix
 
        Besides checking bucket index, will also fix it.
@@ -789,6 +814,13 @@ Options
    When specified with bucket deletion and bypass-gc set to true,
    ignores bucket index consistency.
 
+.. option:: --max-concurrent-ios
+
+        Maximum concurrent ios for bucket operations. Affects operations that
+        scan the bucket index, e.g., listing, deletion, and all scan/search
+        operations such as finding orphans or checking the bucket index.
+        Default is 32.
+
 Quota Options
 =============
 
@@ -821,11 +853,6 @@ Orphans Search Options
 
         Set the job id (for orphans find)
 
-.. option:: --max-concurrent-ios
-
-        Maximum concurrent ios for orphans find.
-        Default is 32.
-
 
 Orphans list-jobs options
 =========================
@@ -884,6 +911,10 @@ Generate a new user::
 Remove a user::
 
         $ radosgw-admin user rm --uid=johnny
+
+Rename a user::
+
+        $ radosgw-admin user rename --uid=johny --new-uid=joe
         
 Remove a user and all associated buckets with their contents::
 
@@ -901,6 +932,18 @@ Unlink bucket from specified user::
 
         $ radosgw-admin bucket unlink --bucket=foo --uid=johnny
 
+Rename a bucket::
+
+        $ radosgw-admin bucket link --bucket=foo --bucket-new-name=bar --uid=johnny
+
+Move a bucket from the old global tenant space to a specified tenant::
+
+        $ radosgw-admin bucket link --bucket=/foo --uid=12345678$12345678'
+
+Link bucket to specified user and change object ACLs::
+
+        $ radosgw-admin bucket chown --bucket=/foo --uid=12345678$12345678'
+
 Show the logs of a bucket from April 1st, 2012::
 
         $ radosgw-admin log show --bucket=foo --date=2012-04-01-01 --bucket-id=default.14193.1