Bug 2178991

Summary: [rgw][doc]: Add doc on the usage of rgw-restore-bucket-index tool in the rhcs-6.0 guide.
Product: [Red Hat Storage] Red Hat Ceph Storage Reporter: Vidushi Mishra <vimishra>
Component: DocumentationAssignee: Akash Raj <akraj>
Documentation sub component: Object Gateway Guide QA Contact: Vidushi Mishra <vimishra>
Status: CLOSED CURRENTRELEASE Docs Contact: Ranjini M N <rmandyam>
Severity: urgent    
Priority: unspecified CC: akraj, aramteke, asriram, mkasturi, rmandyam, vereddy
Version: 6.0   
Target Milestone: ---   
Target Release: 6.1   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
.Resharding a bucket removes the bucket's metadata Resharding a bucket removes the bucket's metadata if the bucket was created with `bucket_index_max_shards` as `0`. You can recover the affected buckets by restoring the bucket index. The recovery can be done in two ways: By executing `radosgw-admin object reindex --bucket _BUCKET_NAME_ --object _OBJECT_NAME_` command. By executing the script `rgw-restore-bucket-index [--proceed] _BUCKET_NAME_ [_DATA_POOL_NAME_]`. This script in turn invokes `radosgw-admin object reindex ...`. Post performing the above steps, ensure to perform either a `radosgw-admin bucket list` or `radosgw-admin radoslist` command on the bucket for the bucket stats to correctly reflect the number of objects in the bucket. [NOTE] ==== Prior to the execution of the script, perform 'microdnf install jq' inside the `cephadm` shell. The tool does not work for versioned buckets. ---- [root@argo031 ~]# time rgw-restore-bucket-index --proceed serp-bu-ver-1 default.rgw.buckets.data NOTICE: This tool is currently considered EXPERIMENTAL. `marker` is e871fb65-b87f-4c16-a7c3-064b66feb1c4.25076.5. `bucket_id` is e871fb65-b87f-4c16-a7c3-064b66feb1c4.25076.5. Error: this bucket appears to be versioned, and this tool cannot work with versioned buckets. ---- The tool's scope is limited to a single site only and not on a multi-site. If you execute the `rgw-restore-bucket-index` tool at site-1, it does not recover objects on site-2 and vice versa. On a multi-site, the recovery tool and the object reindex command should be executed at both sites for a bucket. ====
Story Points: ---
Clone Of:
: 2183976 (view as bug list) Environment:
Last Closed: 2023-06-21 06:59:51 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On:    
Bug Blocks: 2126050, 2183976    

Comment 6 Aditya Ramteke 2023-05-31 04:02:35 UTC
Removing needinfo