Bug 2164517 - 6.0 admin guide needs finetunes
Summary: 6.0 admin guide needs finetunes
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Ceph Storage
Classification: Red Hat Storage
Component: Documentation
Version: 6.0
Hardware: Unspecified
OS: Unspecified
unspecified
high
Target Milestone: ---
: 6.1z1
Assignee: Ranjini M N
QA Contact: Aditya Ramteke
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2023-01-25 16:59 UTC by Vasishta
Modified: 2023-08-28 07:31 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2023-08-28 07:31:48 UTC
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker RHCEPH-6034 0 None None None 2023-01-25 17:00:59 UTC

Description Vasishta 2023-01-25 16:59:34 UTC
Describe the issue:
1) 2.1. Ceph process management -> Additional Resources section
rhel-8 needs to be changed to rhel-9 and thus links to rhel guides

2) 2.2. Starting, stopping, and restarting all Ceph daemons
this subsection title needs to be changed to highlight that this subsection explains usage of systemctl only.

ceph orchestrator has its own set of commands to manage ceph daemons
>> orch daemon start|stop|restart|reconfig <name>

3) 2.4. Viewing log files of Ceph daemons that run in containers
In step 1 the workd EXAMPLE is missing before example.

4) 3.1.1. Using the Ceph command interface interactively
This section completely looks outdated by at least 2 major releases.
Please contact cephadm smes to reform/remove this subsection which is not at all making sense while we have cephadm shell utility.

5) 3.1.2. Checking the storage cluster health
The list of elements in Step 3 can be updated, cluster status displayed

i)
  io:
    client:   853 KiB/s rd, 788 KiB/s wr, 858 op/s rd, 787 op/s wr
ii) 
  progress:
    Upgrade to 17.2.5-63.el9cp (25s)
      [............................] (remaining: 13m)

6) 3.1.2. Checking the storage cluster health
and 
3.1.7. Checking the storage cluster status

seem highly overlapping and duplicate
can be merged.

7) 3.1.9. Using the Ceph administration socket
Step 4 commands seemed not working  tried for a mon http://pastebin.test.redhat.com/1089477
Can it please be checked again ?

8) 5.2.6. Print a Ceph user key
step 2 is actually just extended information after step 1, the intended procedure is not related.

9) 6.2. Why does ceph-volume replace ceph-disk?
Below sentence seems to be false. ceph-disk was depricated in rhcs 4
 Starting with Red Hat Ceph Storage 6, ceph-disk is replaced by the ceph-volume utility that aims to be a single purpose command-line tool to deploy logical volumes as OSDs, while maintaining a similar API to ceph-disk when preparing, activating, and creating OSDs.

10) 7.3. Benchmarking Ceph block performance

First 6 steps seem redundant. can be removed upon discussion with rbd dev team.


Describe the task you were trying to accomplish:
Was scrubbing admin guide

Suggestions for improvement:
MEntioned above

Chapter/Section Number and Title:
Mentioned above

Product Version:
6.0

Environment Details:
NA

Any other versions of this document that also needs this update:
some changes might apply to 5.x


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