Skip to content

Commit

Permalink
doc: Update all OPTIONS sections in radosgw-admin
Browse files Browse the repository at this point in the history
Updated all OPTIONS sections in RADOSGW-ADMIN doc page, using the latest options from rgw_admin.cc::usage()

Signed-off-by: Jos Collin <jcollin@redhat.com>
  • Loading branch information
joscollin committed Oct 14, 2017
1 parent 98f31cf commit 6729333
Showing 1 changed file with 210 additions and 23 deletions.
233 changes: 210 additions & 23 deletions doc/man/8/radosgw-admin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -443,6 +443,10 @@ Options

Connect to specified monitor (instead of looking through ceph.conf).

.. option:: --tenant=<tenant>

Name of the tenant.

.. option:: --uid=uid

The radosgw user ID.
Expand All @@ -455,9 +459,9 @@ Options

The e-mail address of the user.

.. option:: --display-name=name
.. option:: --display-name=<name>

Configure the display name of the user.
The display name of the user.

.. option:: --access-key=<key>

Expand All @@ -467,9 +471,9 @@ Options

Generate random access key (for S3).

.. option:: --secret=secret
.. option:: --secret/--secret-key=<key>

The secret associated with a given key.
The secret key.

.. option:: --gen-secret

Expand All @@ -483,13 +487,22 @@ Options

Temporary url key.

.. option:: --system
.. option:: --access=<access>

Set the access permissions for the sub-user.
Available access permissions are read, write, readwrite and full.

Set the system flag on the user.
.. option:: --max-buckets

Maximum number of buckets for a user.

.. option:: --bucket=bucket

Specify the bucket name.
Specify the bucket name. It is also used with quota command.

.. option:: --pool=<pool>

Specify the pool name. It can also be used to scan for leaked rados objects.

.. option:: --object=object

Expand All @@ -507,6 +520,10 @@ Options

The end date needed for some commands.

.. option:: --bucket-id=<bucket-id>

Specify the bucket id.

.. option:: --shard-id=<shard-id>

Optional for mdlog list. Required for ``mdlog trim``,
Expand All @@ -518,20 +535,64 @@ Options

.. option:: --purge-data

Remove user data before user removal.
When specified, user removal will also purge all the user data.

.. option:: --purge-keys

When specified, subuser removal will also purge all the subuser keys.

.. 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>

Key to retrieve metadata from with ``metadata get``.

.. option:: --remote=<remote>

Zone or zonegroup id of remote gateway.

.. option:: --period=<id>

Period id.

.. option:: --epoch=<number>

Period epoch.

.. option:: --commit

Commit the period during 'period update'.

.. option:: --staging

Get the staging period info.

.. option:: --master

Set as master.

.. option:: --master-zone=<id>

Master zone id.

.. option:: --realm-id=<id>

The realm id.

.. option:: --realm-new-name=<name>

New name of realm.

.. option:: --zonegroup-id=<id>

The zonegroup id.

.. option:: --zonegroup-new-name=<name>

The new name of the zonegroup.

.. option:: --rgw-region=<region>

Region in which radosgw is running.
Expand All @@ -540,22 +601,102 @@ Options

Zone in which radosgw is running.

.. option:: --zone-id=<id>

The zone id.

.. option:: --zone-new-name=<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.

.. option:: --placement-id

Placement id for the zonegroup placement commands.

.. option:: --tags=<list>

The list of tags for zonegroup placement add and modify commands.

.. option:: --tags-add=<list>

The list of tags to add for zonegroup placement modify command.

.. option:: --tags-rm=<list>

The list of tags to remove for zonegroup placement modify command.

.. option:: --endpoints=<list>

The zone endpoints.

.. option:: --index-pool=<pool>

The placement target index pool.

.. option:: --data-pool=<pool>

The placement target data pool.

.. option:: --data-extra-pool=<pool>

The placement target data extra (non-ec) pool.

.. option:: --placement-index-type=<type>

The placement target index type (normal, indexless, or #id).

.. option:: --tier-type=<type>

The zone tier type.

.. option:: --tier-config=<k>=<v>[,...]

Set zone tier config keys, values.

.. option:: --tier-config-rm=<k>[,...]

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

Besides checking bucket index, will also fix it.
Besides checking bucket index, fix it too.

.. option:: --check-objects

bucket check: Rebuilds bucket index according to actual objects state.

.. option:: --format=<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=<flag>

Expand All @@ -574,11 +715,11 @@ Options

Specify a file to read in when setting data.

.. option:: --state=<state string>
.. option:: --state=<state>

Specify a state for the opstate set command.

.. option:: --replica-log-type
.. option:: --replica-log-type <logtypestr>

Replica log type (metadata, data, bucket), required for replica log
operations.
Expand All @@ -591,15 +732,29 @@ Options

List of caps (e.g., "usage=read, write; user=read".

.. option:: --compression=<compression-algorithm>
.. option:: --compression=<type>

Placement target compression algorithm (lz4|snappy|zlib|zstd)
Placement target compression type (plugin name or empty/none).

.. option:: --yes-i-really-mean-it

Required for certain operations.

.. 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
=============

Expand All @@ -609,20 +764,16 @@ Quota Options

.. option:: --max-size

Specify max size (in bytes, negative value to disable).
Specify max size (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
Expand All @@ -642,6 +793,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
========

Expand Down

0 comments on commit 6729333

Please sign in to comment.