Bug 2091672 - [MetroDR] Make description of RHACM setup more clear
Summary: [MetroDR] Make description of RHACM setup more clear
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat OpenShift Data Foundation
Classification: Red Hat Storage
Component: documentation
Version: 4.10
Hardware: Unspecified
OS: Unspecified
unspecified
high
Target Milestone: ---
: ODF 4.12.1
Assignee: Olive Lakra
QA Contact: akarsha
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2022-05-30 17:21 UTC by Martin Bukatovic
Modified: 2023-08-09 16:43 UTC (History)
7 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2023-03-09 12:47:11 UTC
Embargoed:


Attachments (Terms of Use)

Description Martin Bukatovic 2022-05-30 17:21:53 UTC
Describe the issue
==================

The text of chapter 2 about requirements for Metro DR could be more clear about
cluster architecture and RHACM setup.

Right now, it is mixing entitlements, available clusters and RHACM setup
in a single bullet point list, which is confusing and downplays RHACM
installation (one needs to understand cluster roles first, then which
entitlements are required for each role, and setup of RHACM is another
installation step).

Moreover high level overview of the solution (along with it's networking
requirements) is not available. That said, this is related to ongoing ODF 4.11
effort https://issues.redhat.com/browse/OCSDOCS-714, but some minimal overview
of the cluster architecture would be useful here as well. Otherwise, it's not
easy to understand what these requirements are reffering to.

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

Setup Metro DR with Advanced Cluster Management cluster environment from
scratch.

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

In the chapter 2, provide dedicated section for:

- cluster architecture and roles: Hub cluster and managed clusters (primary
  and secondary)
- entitlements for each role
- RHACM installation and setup

We could also add:

- brief description of the architecture, and networking constraints

For RHACM setup, we need to be more clear about the fact that we require RHACM
to be installed and configured:

- RHACM Operator installed, MultiClusterHub CR created, local cluster is
  visible.
- Import (or install) managed clusters into RHACM (for them to be managed by
  ACM)

We don't need to list detailed steps, referencing RHACM docs (as we do right
now) is ok, but need to list at least the goals above. Stricly speaking we
have this listed, but with level of detail which is not consistent: I would
rather see a high level description of the ACM installation goal with a
reference to appropriate RHACM guide for each step.

For ODF 4.11 we also needs to take BZ 2089679 into consideration here.

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 2. Requirements for enabling Metro-DR

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

ODF 4.10

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.

Additional information
======================

Text in ocs-training is more clear in this respect, but I understand a need to
not repeat information already covered in RHACM docs:

https://red-hat-storage.github.io/ocs-training/training/ocs4/odf4-metro-ramen.html#_deploy_and_configure_acm_for_multisite_connectivity


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