Bug 2091678

Summary:	[MetroDR] Make it more clear that Metro DR setup includes ceph cluster installation
Product:	[Red Hat Storage] Red Hat OpenShift Data Foundation	Reporter:	Martin Bukatovic <mbukatov>
Component:	documentation	Assignee:	Olive Lakra <olakra>
Status:	CLOSED CURRENTRELEASE	QA Contact:	Martin Bukatovic <mbukatov>
Severity:	medium	Docs Contact:
Priority:	unspecified
Version:	4.10	CC:	asriram, dparkes, ebenahar, hnallurv, ocs-bugs, odf-bz-bot, olakra
Target Milestone:	---
Target Release:	---
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:	2022-09-08 14:51:41 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 Martin Bukatovic 2022-05-30 17:33:44 UTC

Describe the issue
==================

Chapter about Ceph setup is misnamed as "requirements" even though it actually
covers full installation and setup of a Ceph cluster. Requirements are covered
only in the beginning (which is ok).

This sends a misleading message as if one could also use existing Ceph
cluster, which is not the case. Customer is expected to deploy new dedicated
stretched Ceph cluster for MetroDR.

Describe the task you were trying to accomplish
===============================================

Install stretched Ceph cluster for MetroDR.

Suggestions for improvement
===========================

Call the whole chapter as installation or Deployment instead of Requirements,
and clearly distinguish requirements from the actual deployment and setup
in the text of the chapter.

Document URL
============

https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.10/html-single/configuring_openshift_data_foundation_for_metro-dr_with_advanced_cluster_management/index


Chapter/Section Number and Title
================================

Chapter 3. Requirements for deploying Red Hat Ceph Storage stretch cluster with arbiter

Product Version
===============

ODF 4.10

Environment Details
===================

Stretched RHCS for Metro DR with ACM

Any other versions of this document that also needs this update
===============================================================

This text was introduced in 4.10, and should be fixed at least in 4.11.

Comment 5 Martin Bukatovic 2022-07-08 13:27:34 UTC

I don't see this addressed in the current draft from stage (commit ef84b6f):

There is a chapter "Chapter 3. Requirements for deploying Red Hat Ceph
Storage stretch cluster with arbiter", with subsections:

- 3.1. Hardware requirements
- 3.2. Software requirements
- 3.3. Network configuration requirements
- 3.4. Node pre-deployment requirements
- 3.5. Cluster bootstrapping and service deployment with Cephadm

And the problem is that half of the section 3.4 and whole
section 3.5 is concerned with ceph installation, not ceph
requirements.

We could either split these into 2 chapters (one for
requirements, and another for actual ceph installation,
but that would require to split section 3.4 which is
mixing both), or rename the whole section #3 to
"ceph deployment", and rename section "Node pre-deployment
requirements" to "Node pre-deployment steps" (or something
similar).

Comment 6 daniel parkes 2022-08-02 11:03:16 UTC

Olive, modifications made to gdoc: https://docs.google.com/document/d/1MfSmXbiGI76As3_nNElsdmibpSIduxi8jquwO1HGuYY/edit# Addressing Martin's comments.

Comment 8 Elad 2022-08-24 09:20:19 UTC

Re-targeting the verification part

Comment 10 Martin Bukatovic 2022-08-24 18:08:22 UTC

Checking preview build (commit 4e13663):

The stretched ceph setup is now placed in a separate section titled "4.5. Deploying Red Hat Ceph Storage", which clearly conveys the fact that the ceph installation is covered there.

>>> VERIFIED