Bug 1304601 - Documentation for "orphans find" tool
Summary: Documentation for "orphans find" tool
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Ceph Storage
Classification: Red Hat Storage
Component: Documentation
Version: 1.3.2
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: rc
: 1.3.2
Assignee: Aron Gunn
QA Contact: ceph-qe-bugs
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-02-04 06:14 UTC by shilpa
Modified: 2016-03-01 08:21 UTC (History)
10 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2016-03-01 08:21:47 UTC
Embargoed:


Attachments (Terms of Use)

Description shilpa 2016-02-04 06:14:11 UTC
Description of problem:
Need to document the RGW orphans tool usage. https://bugzilla.redhat.com/show_bug.cgi?id=1254398. 

The commands are: 

#radosgw-admin orphans find --pool=<data pool> --job-id=<name> [--num-shards=<num shards>] [--orphan-stale-secs=<seconds>]
#radosgw-admin orphans finish --job-id=<job_name>


Version-Release number of selected component (if applicable):
1.3.2

Upstream discussion:
https://www.mail-archive.com/ceph-users@lists.ceph.com/msg19654.html

Comment 2 Ken Dreyer (Red Hat) 2016-02-05 17:19:41 UTC
Feel free to borrow from https://github.com/ceph/ceph/pull/7524

Comment 11 shilpa 2016-02-16 07:03:33 UTC
Hi Aron,

It would be nice to add Yehuda's C#10 to the doc. We should be more specific in what cases do objects leave behind orphans.  


Also, there is a prerequisite to running " radosgw-admin orphans find" command.

The tool tries to open a radosgw log pool and fails. A log pool needs to exist prior to running the above command. The following command on the admin node should do it:

$ rados mkpool .log

Comment 12 shilpa 2016-02-16 17:24:00 UTC
Also, would be nice to add description for each option. For example:

option: --pool
Data pool to scan for leaked rados objects

option: --num-shards
Number of shards to use for keeping the temporary scan info

Comment 14 shilpa 2016-02-17 08:25:35 UTC
Thanks Aron. Doc looks fine. Moving the BZ to verified.


Note You need to log in before you can comment on or make changes to this bug.