]>
Commit | Line | Data |
---|---|---|
e306af50 TL |
1 | :orphan: |
2 | ||
3 | ================================================================== | |
4 | rgw-orphan-list -- list rados objects that are not indexed by rgw | |
5 | ================================================================== | |
6 | ||
7 | .. program:: rgw-orphan-list | |
8 | ||
9 | Synopsis | |
10 | ======== | |
11 | ||
12 | | **rgw-orphan-list** | |
13 | ||
14 | Description | |
15 | =========== | |
16 | ||
17 | :program:`rgw-orphan-list` is an *EXPERIMENTAL* RADOS gateway user | |
18 | administration utility. It produces a listing of rados objects that | |
19 | are not directly or indirectly referenced through the bucket indexes | |
20 | on a pool. It places the results and intermediate files on the local | |
21 | filesystem rather than on the ceph cluster itself, and therefore will | |
22 | not itself consume additional cluster storage. | |
23 | ||
24 | In theory orphans should not exist. However because ceph evolves | |
25 | rapidly, bugs do crop up, and they may result in orphans that are left | |
26 | behind. | |
27 | ||
28 | In its current form this utility does not take any command-line | |
29 | arguments or options. It will list the available pools and prompt the | |
30 | user to enter the pool they would like to list orphans for. | |
31 | ||
32 | Behind the scenes it runs `rados ls` and `radosgw-admin bucket | |
33 | radoslist ...` and produces a list of those entries that appear in the | |
34 | former but not the latter. Those entries are presumed to be the | |
35 | orphans. | |
36 | ||
37 | Warnings | |
38 | ======== | |
39 | ||
40 | This utility is currently considered *EXPERIMENTAL*. | |
41 | ||
42 | This utility will produce false orphan entries for unindexed buckets | |
43 | since such buckets have no bucket indices that can provide the | |
44 | starting point for tracing. | |
45 | ||
46 | Options | |
47 | ======= | |
48 | ||
49 | At present there are no options. | |
50 | ||
51 | Examples | |
52 | ======== | |
53 | ||
54 | Launch the tool:: | |
55 | ||
56 | $ rgw-orphan-list | |
57 | ||
58 | Availability | |
59 | ============ | |
60 | ||
61 | :program:`radosgw-admin` is part of Ceph, a massively scalable, open-source, | |
62 | distributed storage system. Please refer to the Ceph documentation at | |
63 | http://ceph.com/docs for more information. | |
64 | ||
65 | See also | |
66 | ======== | |
67 | ||
68 | :doc:`radosgw-admin <radosgw-admin>`\(8) | |
69 | :doc:`ceph-diff-sorted <ceph-diff-sorted>`\(8) |