operator-framework / olm-docs

Hugo doc site for https://github.com/operator-framework/operator-lifecycle-manager
10 stars 79 forks source link

Update Arbitrary Properties example on the Dependency Resolution page #271

Open nschambu opened 1 year ago

nschambu commented 1 year ago

Issue: The example in the Arbitrary Properties section of the Dependency Resolution page is incorrect. Page in question: https://olm.operatorframework.io/docs/concepts/olm-architecture/dependency-resolution/#arbitrary-properties

Details

The Arbitrary Properties section of the Dependency Resolution page includes an additional "property" field that is unnecessary.

Current example:

properties:
  - property:
      type: sushi
      value: salmon
  - property:
      type: soup
      value: miso
  - property:
      type: olm.gvk
      value:
        group: olm.coreos.io
        version: v1alpha1
        kind: bento

Proposed update:

properties:
  - type: sushi
    value: salmon
  - type: soup
    value: miso
  - type: olm.gvk
    value:
      group: olm.coreos.io
      version: v1alpha1
      kind: bento

My dependency resolution was failing when using the current example, but was successful when I updated it to the proposed update.