Bug 2029932

Summary:	CatalogSource name requirement for disconnected deployment
Product:	[Red Hat Storage] Red Hat OpenShift Data Foundation	Reporter:	Daniel Horák <dahorak>
Component:	documentation	Assignee:	Olive Lakra <olakra>
Status:	CLOSED CURRENTRELEASE	QA Contact:	Petr Balogh <pbalogh>
Severity:	high	Docs Contact:
Priority:	unspecified
Version:	4.9	CC:	bkunal, branto, ebenahar, kbg, mmuench, muagarwa, ocs-bugs, odf-bz-bot, olakra, pbalogh, rcyriac, yprokule
Target Milestone:	---
Target Release:	ODF 4.9.0
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-01-07 17:46:31 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 Daniel Horák 2021-12-07 15:32:40 UTC

Describe the issue:
  It seems, that for successful installation is required that CatalogSource providing the ODF operator have to be named `redhat-operators`. This is not an issue in normal deployment, because `redhat-operators` is between the default sources. 
  But it might be a problem in disconnected environment, where user disable the default sources and creates own CatalogSource from pruned and mirrored index image - and in this case, the CatalogSource name can be customized.

Describe the task you were trying to accomplish:

Suggestions for improvement:
  We should provide information, that the CatalogSource should be `redhat-operators` or steps how to install ODF from CatalogSource named differently.

Document URL:

Chapter/Section Number and Title:
  Planning your deployment - Chapter 9. Disconnected environment


Product Version:
  ODF 4.9

Environment Details:

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

Additional information:

Comment 3 Mudit Agarwal 2021-12-09 13:20:52 UTC

Boris, can you or someone from the build team help the documentation team for this issue?

Comment 4 Boris Ranto 2021-12-09 13:42:24 UTC

All the necessary information should be provided in the linked email thread and the OCP documentation.

Comment 5 Petr Balogh 2021-12-09 14:06:30 UTC

All info should be in this gchat thread: https://chat.google.com/room/AAAAREGEba8/cKUHznKGO_8 
Room: OCS Virtual Teams (invite only)

Comment 7 Petr Balogh 2021-12-12 13:09:45 UTC

We have two options here:
1) Limit user to use only this redhat-operators catalog source .
2) Be more verbose and provide the description about config map how to allow different name using catalog source.

Second approach will require to mention:
https://github.com/red-hat-storage/odf-operator/blob/main/docs/customizing-subscriptions.md#customize-odf-operator-via-editing-configmap
And describe to use:
OCS_SUBSCRIPTION_CATALOGSOURCE
NOOBAA_SUBSCRIPTION_CATALOGSOURCE
IBM_SUBSCRIPTION_CATALOGSOURCE

Saying that those has to be set to the new name of catalog source.

As quick fix for this GA I am fine with first option as well. For the other approach we can maybe have article how to do that.
@bkunal , WDYT?

Also as the second approach was not tested by QE I prefer to stick with 1st one anyway.

Comment 11 Petr Balogh 2021-12-13 10:13:09 UTC

Looks OK to me. Marking as verified.

Comment 12 Daniel Horák 2021-12-13 10:23:50 UTC

Looks good to me too.