Bug 1796464 - [DOC] Need to create CatalogSource object to consume the CatalogSource image
Summary: [DOC] Need to create CatalogSource object to consume the CatalogSource image
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 4.3.0
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: ---
: 4.3.z
Assignee: Alex Dellapenta
QA Contact: Jian Zhang
Vikram Goyal
URL:
Whiteboard:
: 1796598 (view as bug list)
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-01-30 13:36 UTC by Jian Zhang
Modified: 2023-09-15 00:21 UTC (History)
5 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2021-03-08 14:35:40 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Jian Zhang 2020-01-30 13:36:34 UTC
Document URL: 
https://docs.openshift.com/container-platform/4.3/operators/olm-restricted-networks.html#olm-restricted-networks-operatorhub_olm-restricted-networks


Section Number and Name: 
4. Verify the CatalogSource and package manifest are created successfully:

Describe the issue: 
`oc adm catalog build`, `oc adm catalog mirror` and `oc apply -f ./manifests` don't create the CatalogSource object automatically.
But, we list the below validation info in step 4, it's confusing.

# oc get pods -n openshift-marketplace
NAME READY STATUS RESTARTS AGE
my-operator-catalog-6njx6 1/1 Running 0 28s
marketplace-operator-d9f549946-96sgr 1/1 Running 0 26h

# oc get catalogsource -n openshift-marketplace
NAME DISPLAY TYPE PUBLISHER AGE
my-operator-catalog My Operator Catalog grpc 5s


Suggestions for improvement: 
I know we have already a step to describe the CatalogSource creation in https://docs.openshift.com/container-platform/4.3/operators/olm-restricted-networks.html#olm-testing-operator-catalog-image_olm-restricted-networks

But, it's better if we add a step before step 4 to introduce the CatalogSource object creation.


Additional information: 
For example:
$ cat CatalogSource.yaml
apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
  name: my-operator-catalog
  namespace: openshift-marketplace
spec:
  sourceType: grpc
  image: <registry_host_name>:<port>/<namespace>/redhat-operators:v1
  displayName: My Operator Catalog
  publisher: grpc

Comment 2 Jian Zhang 2020-02-04 03:29:54 UTC
*** Bug 1796598 has been marked as a duplicate of this bug. ***

Comment 3 Alex Dellapenta 2020-02-04 21:29:22 UTC
https://github.com/openshift/openshift-docs/pull/19512

Comment 4 Jian Zhang 2020-02-05 08:43:10 UTC
Comments left, thanks!

Comment 6 Jian Zhang 2020-02-06 01:07:14 UTC
LGTM, thanks! Verify it.

Comment 7 Red Hat Bugzilla 2023-09-15 00:21:05 UTC
The needinfo request[s] on this closed bug have been removed as they have been unresolved for 500 days


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