Bug 1880744 - OLM dependencies.yaml format is incorrect
Summary: OLM dependencies.yaml format is incorrect
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 4.5
Hardware: Unspecified
OS: Unspecified
low
low
Target Milestone: ---
: 4.5.z
Assignee: Jonquil Williams
QA Contact: Jian Zhang
Vikram Goyal
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-09-19 15:23 UTC by Chris Johnson
Modified: 2021-03-03 16:20 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2021-03-03 16:20:11 UTC
Target Upstream Version:
Embargoed:

Attachments (Terms of Use)

Description Chris Johnson 2020-09-19 15:23:11 UTC 
Document URL: 
https://docs.openshift.com/container-platform/4.5/operators/olm-packaging-format.html#olm-bundle-format-dependencies_olm-packaging-format

Section Number and Name: 

Describe the issue: 
The example for the dependencies.yaml is not correct.  If this schema format is used, it results in the entire dependencies.yaml being ignored by OLM.

Suggestions for improvement: 
Update the example as follows:

dependencies:
  - type: olm.package
    value:
      packageName: prometheus
      version: >0.27.0
  - type: olm.gvk
    value: 
      group: etcd.database.coreos.com
      kind: EtcdCluster
      version: v1beta2

Additional information:
Comment 2 Jonquil Williams 2020-09-21 18:41:55 UTC 
https://github.com/openshift/openshift-docs/pull/25633

QA review needed.
Comment 4 Jian Zhang 2020-09-22 09:22:13 UTC 
LGTM, verify it.
Comment 5 Jonquil Williams 2021-03-03 16:20:11 UTC 
This fix has been published.
Note You need to log in before you can comment on or make changes to this bug.