From: Jos Collin Date: Thu, 12 Oct 2017 11:09:25 +0000 (+0530) Subject: doc: Update all OPTIONS sections in radosgw-admin X-Git-Tag: v13.0.1~69^2 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=76a8dc1e31328868a58b01ac7d2a675e76c226fc;p=ceph.git doc: Update all OPTIONS sections in radosgw-admin Updated all OPTIONS sections in RADOSGW-ADMIN doc page, using the latest options from rgw_admin.cc::usage() Signed-off-by: Jos Collin --- diff --git a/doc/man/8/radosgw-admin.rst b/doc/man/8/radosgw-admin.rst index ae04664d1c08..b883176a8d6d 100644 --- a/doc/man/8/radosgw-admin.rst +++ b/doc/man/8/radosgw-admin.rst @@ -467,6 +467,10 @@ Options Connect to specified monitor (instead of looking through ceph.conf). +.. option:: --tenant= + + Name of the tenant. + .. option:: --uid=uid The radosgw user ID. @@ -475,26 +479,22 @@ Options Name of the subuser. -.. option:: --email=email +.. option:: --access-key= - The e-mail address of the user. + S3 access key. -.. option:: --display-name=name +.. option:: --email=email - Configure the display name of the user. + The e-mail address of the user. -.. option:: --access-key= +.. option:: --secret/--secret-key= - S3 access key. + The secret key. .. option:: --gen-access-key Generate random access key (for S3). -.. option:: --secret=secret - - The secret associated with a given key. - .. option:: --gen-secret Generate random secret key. @@ -507,29 +507,55 @@ Options Temporary url key. +.. option:: --access= + + Set the access permissions for the sub-user. + Available access permissions are read, write, readwrite and full. + +.. option:: --display-name= + + The display name of the user. + +.. option:: --max-buckets + + Maximum number of buckets for a user. + +.. option:: --admin + + Set the admin flag on the user. + .. option:: --system - Set the system flag on the user. + Set the system flag on the user. .. option:: --bucket=bucket Specify the bucket name. +.. option:: --pool= + + Specify the pool name. + Also used with `orphans find` as data pool to scan for leaked rados objects. + .. option:: --object=object Specify the object name. .. option:: --date=yyyy-mm-dd - The date needed for some commands. + The date in the format yyyy-mm-dd. .. option:: --start-date=yyyy-mm-dd - The start date needed for some commands. + The start date in the format yyyy-mm-dd. .. option:: --end-date=yyyy-mm-dd - The end date needed for some commands. + The end date in the format yyyy-mm-dd. + +.. option:: --bucket-id= + + Specify the bucket id. .. option:: --shard-id= @@ -542,7 +568,7 @@ Options .. option:: --purge-data - Remove user data before user removal. + When specified, user removal will also purge all the user data. .. option:: --purge-keys @@ -550,23 +576,147 @@ Options .. option:: --purge-objects - Remove all objects before bucket removal. + When specified, the bucket removal will also purge all objects in it. .. option:: --metadata-key= Key to retrieve metadata from with ``metadata get``. -.. option:: --rgw-region= +.. option:: --remote= + + Zone or zonegroup id of remote gateway. + +.. option:: --period= + + Period id. + +.. option:: --epoch= + + Period epoch. + +.. option:: --commit - Region in which radosgw is running. + Commit the period during 'period update'. + +.. option:: --staging + + Get the staging period info. + +.. option:: --master + + Set as master. + +.. option:: --master-zone= + + Master zone id. + +.. option:: --rgw-realm= + + The realm name. + +.. option:: --realm-id= + + The realm id. + +.. option:: --realm-new-name= + + New name of realm. + +.. option:: --rgw-zonegroup= + + The zonegroup name. + +.. option:: --zonegroup-id= + + The zonegroup id. + +.. option:: --zonegroup-new-name= + + The new name of the zonegroup. .. option:: --rgw-zone= Zone in which radosgw is running. -.. option:: --source-zone= +.. option:: --zone-id= + + The zone id. + +.. option:: --zone-new-name= + + The new name of the zone. + +.. option:: --source-zone + + The source zone for data sync. + +.. option:: --default + + Set the entity (realm, zonegroup, zone) as default. + +.. option:: --read-only + + Set the zone as read-only when adding to the zonegroup. - Specify the source zone for data sync. +.. option:: --placement-id + + Placement id for the zonegroup placement commands. + +.. option:: --tags= + + The list of tags for zonegroup placement add and modify commands. + +.. option:: --tags-add= + + The list of tags to add for zonegroup placement modify command. + +.. option:: --tags-rm= + + The list of tags to remove for zonegroup placement modify command. + +.. option:: --endpoints= + + The zone endpoints. + +.. option:: --index-pool= + + The placement target index pool. + +.. option:: --data-pool= + + The placement target data pool. + +.. option:: --data-extra-pool= + + The placement target data extra (non-ec) pool. + +.. option:: --placement-index-type= + + The placement target index type (normal, indexless, or #id). + +.. option:: --tier-type= + + The zone tier type. + +.. option:: --tier-config==[,...] + + Set zone tier config keys, values. + +.. option:: --tier-config-rm=[,...] + + Unset zone tier config keys. + +.. option:: --sync-from-all[=false] + + Set/reset whether zone syncs from all zonegroup peers. + +.. option:: --sync-from=[zone-name][,...] + + Set the list of zones to sync from. + +.. option:: --sync-from-rm=[zone-name][,...] + + Remove the zones from list of zones to sync from. .. option:: --fix @@ -578,12 +728,12 @@ Options .. option:: --format= - Specify output format for certain operations: xml, json. + Specify output format for certain operations. Supported formats: xml, json. .. option:: --sync-stats - Option to 'user stats', update user stats with current stats reported by - user's buckets indexes. + Option for 'user stats' command. When specified, it will update user stats with + the current stats reported by user's buckets indexes. .. option:: --show-log-entries= @@ -602,11 +752,11 @@ Options Specify a file to read in when setting data. -.. option:: --state= +.. option:: --state= Specify a state for the opstate set command. -.. option:: --replica-log-type +.. option:: --replica-log-type Replica log type (metadata, data, bucket), required for replica log operations. @@ -641,6 +791,21 @@ Options is set to 0, then the specified object will always be rewritten for restriping. +.. option:: --warnings-only + + When specified with bucket limit check, + list only buckets nearing or over the current max objects per shard value. + +.. option:: --bypass-gc + + When specified with bucket deletion, + triggers object deletions by not involving GC. + +.. option:: --inconsistent-index + + When specified with bucket deletion and bypass-gc set to true, + ignores bucket index consistency. + Quota Options ============= @@ -650,20 +815,16 @@ Quota Options .. option:: --max-size - Specify max size (in bytes, negative value to disable). + Specify max size (in B/K/M/G/T, negative value to disable). .. option:: --quota-scope - Scope of quota (bucket, user). + The scope of quota (bucket, user). Orphans Search Options ====================== -.. option:: --pool - - Data pool to scan for leaked rados objects - .. option:: --num-shards Number of shards to use for keeping the temporary scan info @@ -683,6 +844,42 @@ Orphans Search Options Default is 32. +Orphans list-jobs options +========================= + +.. option:: --extra-info + + Provide extra info in the job list. + + +Role Options +============ + +.. option:: --role-name + + The name of the role to create. + +.. option:: --path + + The path to the role. + +.. option:: --assume-role-policy-doc + + The trust relationship policy document that grants an entity permission to + assume the role. + +.. option:: --policy-name + + The name of the policy document. + +.. option:: --policy-doc + + The permission policy document. + +.. option:: --path-prefix + + The path prefix for filtering the roles. + Examples ========