Bug 1796598

Summary: [DOCS] OLM on restricted networks mirror command description does not create CatalogSource
Product: OpenShift Container Platform Reporter: Erik Nelson <ernelson>
Component: DocumentationAssignee: Alex Dellapenta <adellape>
Status: CLOSED DUPLICATE QA Contact: Xiaoli Tian <xtian>
Severity: unspecified Docs Contact: Vikram Goyal <vigoyal>
Priority: unspecified    
Version: 4.3.0CC: adellape, aos-bugs, jiazha, jmatthew, jokerman, xjiang
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: 2020-02-04 03:29:54 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 Erik Nelson 2020-01-30 18:14:53 UTC
Document URL: https://docs.openshift.com/container-platform/4.3/operators/olm-restricted-networks.html#olm-building-operator-catalog-image_olm-restricted-networks

Section Number and Name: "Configure OperatorHub for restricted networks"

Describe the issue:

Step 2 reads "Extract the contents of your custom Operator catalog image to generate manifests required for mirroring:"

It's not only extracting contents with the oc adm catalog mirror command, but also actually mirroring the images into the cluster. It should be made clear this is the actual step that pushes the content into the cluster.

Larger issue however, is that it goes on to describe the "manifests" that are extracted. Steps 2-4 are written with the assumption that a CatalogSource object is part of the manifests that are extracted, with step 4 indicating a catalogsource should now be running in the cluster.

The manifests director that is produced from the mirror command ONLY contanis an imageContentSourcePolicy and a mapping.txt file. There is no CatalogSource as part of these manifests that will deploy the image you previously built.

Creating this CatalogSource is a critical part of the process of publishing your own content to OLM in a disconnected environment. I don't know if this is a missing feature from the mirror command, or if the documentation is missing a step that describes the catalogsource deployment, but nobody following the docs as written right now will succeed in using these commands to publish OLM content in a restricted cluster.

Suggestions for improvement: 

The documentation needs to describe how to actually run a CatalogSource, or the tool needs to be updated to actually create the correct resource file in the manifests/ dir.

Comment 1 Jian Zhang 2020-02-04 03:29:54 UTC

*** This bug has been marked as a duplicate of bug 1796464 ***