Bug 1881207

Summary: [Documentation Bug] crush_rules configuration for ceph-ansible is wrong
Product: [Red Hat Storage] Red Hat Ceph Storage Reporter: Matthew Secaur <msecaur>
Component: DocumentationAssignee: Ranjini M N <rmandyam>
Status: CLOSED CURRENTRELEASE QA Contact: Veera Raghava Reddy <vereddy>
Severity: medium Docs Contact:
Priority: unspecified    
Version: 4.0CC: agunn, kdreyer, rmandyam
Target Milestone: rcKeywords: NoDocsQEReview
Target Release: 5.*   
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: 2020-09-25 14:47:06 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:

Description Matthew Secaur 2020-09-21 19:42:52 UTC
Describe the issue:
The Ceph 4.x documentation section titled "4.8. Deploying OSDs with different hardware on the same host" has incorrect syntax and a typo.

Describe the task you were trying to accomplish:
Configuring an SSD tier and an HDD tier on a single Ceph cluster using ceph-ansible

Suggestions for improvement:
The documentation has this stanza which has erroneous formatting and a typo that will cause a failure:

create_crush_tree: true
crush_rule_config: true
crush_rules:
  name: HDD
    root: default
    type: host
    class: hdd
    default: true
  name: SDD
    root: default
    type: host
    class: sdd
    default: true

This is the correct formatting of the "crush_rules" section and using a valid device class (s/sdd/ssd/):

create_crush_tree: true
crush_rule_config: true
crush_rules:
  - name: HDD
    root: default
    type: host
    class: hdd
    default: true
  - name: SDD
    root: default
    type: host
    class: ssd
    default: true

Document URL:
https://access.redhat.com/documentation/en-us/red_hat_ceph_storage/4/html-single/installation_guide/index#deploying-osds-with-different-hardware-on-the-same-host_install

Chapter/Section Number and Title:
4.8. Deploying OSDs with different hardware on the same host

Product Version:
Ceph 4.x

Environment Details:
Environments with two tiers of disks.

Any other versions of this document that also needs this update:
Probably all of the Ceph 4 versions.

Additional information:
none

Comment 1 RHEL Program Management 2020-09-21 19:42:59 UTC
Please specify the severity of this bug. Severity is defined here:
https://bugzilla.redhat.com/page.cgi?id=fields.html#bug_severity.