Bug 2186798

Summary: [DDF] The unit prefix used in these paragraphs are wrong, but is a common mistake. The IEEE 802.3 Ethernet standard
Product: [Red Hat Storage] Red Hat Ceph Storage Reporter: Direct Docs Feedback <ddf-bot>
Component: DocumentationAssignee: Anjana Suparna Sriram <asriram>
Documentation sub component: DDF QA Contact: Manisha Saini <msaini>
Status: RELEASE_PENDING --- Docs Contact:
Severity: low    
Priority: medium CC: jherron, msaini, rmandyam
Version: 5.0Keywords: NoDocsQEReview
Target Milestone: ---Flags: lysanche: needinfo? (msaini)
Target Release: Backlog   
Hardware: All   
OS: All   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Direct Docs Feedback 2023-04-14 14:32:33 UTC 
The unit prefix used in these paragraphs are wrong, but is a common mistake.  The IEEE 802.3 Ethernet standard uses (b)its as the unit prefix to measure port speeds and not (B)ytes.

This documentation also differs from upstream documentation.

For example

Upstream:
link: https://docs.ceph.com/en/latest/start/hardware-recommendations/#speed

"It takes three hours to replicate 1 TB of data across a 1 Gb/s network and it takes thirty hours to replicate 10 TB across a 1 Gb/s network."

Red Hat Documentation with the incorrect unit prefix and incorrect timeline:

"In the case of a drive failure, replicating 1 TB of data across a 1 GB Ethernet network takes 3 hours, and 3 TB takes 9 hours."

Reported by: jherron

https://access.redhat.com/documentation/en-us/red_hat_ceph_storage/5/html/installation_guide/red-hat-ceph-storage-considerations-and-recommendations#annotations:2b83c5dc-aa8c-4ae6-ba4e-7feb49c68593
Comment 1 RHEL Program Management 2023-04-14 14:32:40 UTC 
Please specify the severity of this bug. Severity is defined here:
https://bugzilla.redhat.com/page.cgi?id=fields.html#bug_severity.
Comment 2 lysanche 2023-04-28 15:45:47 UTC 
Hi Ranjini,

Could you please peer review this?


MR: https://gitlab.cee.redhat.com/red-hat-ceph-storage-documentation/doc-Red_Hat_Ceph_Storage_5-Installation_Guide/-/merge_requests/441

Preview: https://jenkins.dxp.redhat.com/job/CCS/job/ccs-mr-preview/47030/artifact/preview/index.html#network-considerations-for-red-hat-ceph-storage_install

Thanks,
Lynn
Comment 4 lysanche 2023-05-25 15:08:46 UTC 
Changes made for RHCS 6.x:


MR: https://gitlab.cee.redhat.com/red-hat-ceph-storage-documentation/red-hat-ceph-storage-6/-/merge_requests/132

Preview: https://jenkins.dxp.redhat.com/job/CCS/job/ccs-mr-preview/49074/artifact/titles/installation/preview/index.html#network-considerations-for-red-hat-ceph-storage_install
Comment 5 lysanche 2023-05-25 16:05:36 UTC 
Changes made for IBM 6.x:

MR: https://github.ibm.com/ibm-ceph-documentation/ibm-ceph-6.1/pull/51

Preview: https://ibmdocs-test.dcs.ibm.com/docs/en/storage-ceph/6?topic=recommendations-network-considerations-storage-ceph
Comment 6 lysanche 2023-05-30 14:44:28 UTC 
Changes made for IBM 5.x:

MRs: https://github.ibm.com/ibm-ceph-documentation/ibm-ceph-5.3/pull/132

https://github.ibm.com/ibm-ceph-documentation/ibm-ceph-5.3/pull/133


Preview: https://ibmdocs-test.dcs.ibm.com/docs/en/storage-ceph/5?topic=cr-network-considerations-storage-ceph
Comment 7 lysanche 2023-05-30 15:22:06 UTC 
Correction to Comment 6:

Preview: https://ibmdocs-test.dcs.ibm.com/docs/en/storage-ceph/5?topic=recommendations-network-considerations-storage-ceph