Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Update commands and options in radosgw-admin #18267

Merged
merged 2 commits into from Nov 29, 2017

Conversation

Projects
None yet
2 participants
@joscollin
Copy link
Member

commented Oct 12, 2017

  • Updated the COMMANDS section in RADOSGW-ADMIN doc page, using the latest commands from rgw_admin.cc::usage()
  • 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

@joscollin joscollin force-pushed the joscollin:wip-update-radosgw-admin-doc branch from 79ecd16 to 98f31cf Oct 12, 2017

@joscollin joscollin requested a review from oritwas Oct 12, 2017

@joscollin joscollin changed the title doc: Update COMMANDS section in radosgw-admin doc: Update commands and options in radosgw-admin Oct 13, 2017

@joscollin joscollin force-pushed the joscollin:wip-update-radosgw-admin-doc branch 5 times, most recently from 6729333 to 281fc8e Oct 14, 2017

@joscollin joscollin added DNM and removed DNM labels Oct 14, 2017

@joscollin joscollin force-pushed the joscollin:wip-update-radosgw-admin-doc branch from 281fc8e to 556ec57 Oct 14, 2017

@joscollin joscollin added needs-review and removed DNM labels Oct 14, 2017

@joscollin joscollin requested a review from mattbenjamin Oct 14, 2017

:command:`bucket sync enable`
Enable bucket sync.

:command:`bucket sync disable`

This comment has been minimized.

Copy link
@oritwas

oritwas Oct 15, 2017

Contributor

bucket disable should come before bucket enable

:command:`object unlink`
Unlink object from bucket index.

:command:`objects expire`

This comment has been minimized.

Copy link
@oritwas

oritwas Oct 15, 2017

Contributor

Please use the same text as the help command:
run expired objects cleanup

:command:`region list`
List all regions set on this cluster.
:command:`zonegroup list`
List all the zone groups set on this cluster.

This comment has been minimized.

Copy link
@oritwas

oritwas Oct 15, 2017

Contributor

remove the "the"

@@ -260,9 +459,9 @@ Options

The e-mail address of the user.

.. option:: --display-name=name

This comment has been minimized.

Copy link
@oritwas

oritwas Oct 15, 2017

Contributor

can you move it after --access as it is in the help command?

This comment has been minimized.

Copy link
@joscollin

joscollin Nov 28, 2017

Author Member

Fixed


.. option:: --bucket=bucket

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

This comment has been minimized.

Copy link
@oritwas

oritwas Oct 15, 2017

Contributor

This is used with many other commands (like metadata, reshard) I would just keep the original text

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

The new name of the zonegroup.

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

This comment has been minimized.

Copy link
@oritwas

oritwas Oct 15, 2017

Contributor

it is a good opportunity to remove this field


Set as master.

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

This comment has been minimized.

Copy link
@oritwas

oritwas Oct 15, 2017

Contributor

missing --master-url and --master-zonegroup

This comment has been minimized.

Copy link
@joscollin

joscollin Nov 28, 2017

Author Member

These were already removed in rgw_admin.cc.


.. option:: --fix

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

This comment has been minimized.

Copy link
@oritwas

oritwas Oct 15, 2017

Contributor

this sounds wrong, lets keep the old version

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

Region in which radosgw is running.

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

This comment has been minimized.

Copy link
@oritwas

oritwas Oct 15, 2017

Contributor

this should not be removed


Master zone id.

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

This comment has been minimized.

Copy link
@oritwas

oritwas Oct 15, 2017

Contributor

missing --rgw-realm and -rgw-zoengroup

@joscollin joscollin removed the needs-review label Oct 15, 2017

@joscollin

This comment has been minimized.

Copy link
Member Author

commented Oct 15, 2017

@oritwas Thanks for the review. Could you please review #18302 first, so that your comments can be addressed appropriately in the doc ? Thanks.

@joscollin

This comment has been minimized.

Copy link
Member Author

commented Oct 15, 2017

@oritwas I think we can avoid some of your comments in this PR, if #18302 is agreed / merged.

doc: Update COMMANDS section in radosgw-admin
Updated the COMMANDS section in RADOSGW-ADMIN doc page, using the latest commands from rgw_admin.cc::usage()

Signed-off-by: Jos Collin <jcollin@redhat.com>

@joscollin joscollin force-pushed the joscollin:wip-update-radosgw-admin-doc branch from 556ec57 to 8038960 Nov 19, 2017

@joscollin

This comment has been minimized.

Copy link
Member Author

commented Nov 19, 2017

@oritwas Fixed your review comments. Please verify. Thanks.

@joscollin

This comment has been minimized.

Copy link
Member Author

commented Nov 28, 2017

@oritwas Ping

@@ -424,9 +768,9 @@ Options

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

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

This comment has been minimized.

Copy link
@oritwas

oritwas Nov 28, 2017

Contributor

I prefer the original text

This comment has been minimized.

Copy link
@joscollin

joscollin Nov 28, 2017

Author Member

I was making it similar to the text in rgw_admin.cc. Anyway, reverted it.


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

This comment has been minimized.

Copy link
@oritwas

oritwas Nov 28, 2017

Contributor

here too

This comment has been minimized.

Copy link
@joscollin

joscollin Nov 28, 2017

Author Member

I was making it similar to the text in rgw_admin.cc. Anyway, reverted it.

@@ -455,20 +814,16 @@ Quota Options

.. option:: --max-size

Specify max size (in bytes, negative value to disable).
Specify max size (negative value to disable).

This comment has been minimized.

Copy link
@oritwas

oritwas Nov 28, 2017

Contributor

how about: Specify max size in bytes

This comment has been minimized.

Copy link
@joscollin

joscollin Nov 28, 2017

Author Member

Please see https://github.com/joscollin/ceph/blob/a12ded9805024d334d9e625a8324463e8f1a4b88/src/rgw/rgw_admin.cc#L308. It is not just in bytes, but in other sizes too. That is the reason I removed in bytes here.

This comment has been minimized.

Copy link
@oritwas

oritwas Nov 28, 2017

Contributor

can you use the same text as in the code?

This comment has been minimized.

Copy link
@joscollin

joscollin Nov 28, 2017

Author Member

Done. Please verify.



Orphans Search Options
======================

.. option:: --pool

This comment has been minimized.

Copy link
@oritwas

oritwas Nov 28, 2017

Contributor

This is a option used by orphans find

This comment has been minimized.

Copy link
@joscollin

joscollin Nov 28, 2017

Author Member

Please see L535 in the changed file. There were two --pools and I have merged them into one. If you want I can revert. Please suggest.

This comment has been minimized.

Copy link
@oritwas

oritwas Nov 28, 2017

Contributor

you can keep it

This comment has been minimized.

Copy link
@joscollin

joscollin Nov 28, 2017

Author Member

Done. Please verify.

@joscollin joscollin force-pushed the joscollin:wip-update-radosgw-admin-doc branch 4 times, most recently from bb3567e to cc7dd85 Nov 28, 2017

@oritwas

This comment has been minimized.

Copy link
Contributor

commented Nov 29, 2017

jenkins test this please

@joscollin

This comment has been minimized.

Copy link
Member Author

commented Nov 29, 2017

@oritwas Now there is an error, as we have reverted the --pool option. Please suggest how to proceed. Thanks.

Warning, treated as error:
/home/jenkins-build/build/workspace/ceph-pr-docs/doc/man/8/radosgw-admin.rst:830:Duplicate explicit target name: "cmdoption-radosgw-admin--pool".
Build step 'Execute shell' marked build as failure
@oritwas

This comment has been minimized.

Copy link
Contributor

commented Nov 29, 2017

There was a misunderstanding as I was fine with the --pool change.
And if reverting it causes an error than the change is needed

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 <jcollin@redhat.com>

@joscollin joscollin force-pushed the joscollin:wip-update-radosgw-admin-doc branch from cc7dd85 to 76a8dc1 Nov 29, 2017

@joscollin

This comment has been minimized.

Copy link
Member Author

commented Nov 29, 2017

@oritwas Docs build passed. Please verify and merge.

@oritwas oritwas merged commit 1ad4b8d into ceph:master Nov 29, 2017

5 checks passed

Docs: build check OK - docs built
Details
Signed-off-by all commits in this PR are signed
Details
Unmodified Submodules submodules for project are unmodified
Details
make check make check succeeded
Details
make check (arm64) make check succeeded
Details

@joscollin joscollin deleted the joscollin:wip-update-radosgw-admin-doc branch Nov 29, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.