Bug 2186174

Summary: [DOC] cephadm cmd for ceph-objectstore-tool should be invoked for the osd container
Product: [Red Hat Storage] Red Hat Ceph Storage Reporter: Harsh Kumar <hakumar>
Component: DocumentationAssignee: Anjana Suparna Sriram <asriram>
Documentation sub component: Troubleshooting Guide QA Contact: Aditya Ramteke <aramteke>
Status: NEW --- Docs Contact:
Severity: medium    
Priority: unspecified    
Version: 6.0   
Target Milestone: ---   
Target Release: 6.1z2   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 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:

Description Harsh Kumar 2023-04-12 10:08:49 UTC
Describe the issue:
Our current documentation has several mentions of ceph-objectstore-tool, and also contains steps describing how to use this tool.
One of the prerequisite step is to invoke the cephadm shell, however it is imperative to mention the OSD container name during cephadm shell invocation or else the data-path of the OSD which a mandatory argument for ceph-objectstore-tool will not be available.

Describe the task you were trying to accomplish:
Checking the blocks released when data in an object is removed

Suggestions for improvement:
Every procedure step for ceph-objectstore-tool which currently stays "cephadm shell" needs to be replaced with "cephadm shell --name osd.<osd_id>"
Where osd_id is the id of the OSD on which we want to operate the ceph-objectstore-tool.

Please check Step 4 in this chapter for reference - https://access.redhat.com/documentation/en-us/red_hat_ceph_storage/6/html/administration_guide/bluestore#resharding-the-rocksdb-database-using-the-bluestore-admin-tool_admin

Document URL:
- https://access.redhat.com/documentation/en-us/red_hat_ceph_storage/6/html/troubleshooting_guide/troubleshooting-ceph-objects#troubleshooting-high-level-object-operations

- https://access.redhat.com/documentation/en-us/red_hat_ceph_storage/6/html/troubleshooting_guide/troubleshooting-ceph-objects#troubleshooting-low-level-object-operations


Chapter/Section Number and Title:
- 8.1.1. Listing objects
- 8.1.2. Fixing lost objects
- 8.2.2. Removing an object
- 8.2.3. Listing the object map
- 8.2.4. Manipulating the object map header
- 8.2.7. Manipulating the object attribute key

Product Version: RHCS 6.0

Environment Details:

Any other versions of this document that also needs this update:
RHCS 5.x

Additional information:
There could be additional mentions of the ceph-objectstore-tool apart from Troubleshooting guide, please implement the changes everywhere, if possible.