Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OLM scorecard tests missing #3022

Closed
phantomjinx opened this issue Feb 17, 2022 · 2 comments
Closed

OLM scorecard tests missing #3022

phantomjinx opened this issue Feb 17, 2022 · 2 comments
Labels
area/olm Related to the Operator Lifecycle Manager status/stale

Comments

@phantomjinx
Copy link
Contributor

The following scorecard tests are missing from the olm patch. These need to be incorporated to fully satisfy the OLM specification (and possible future gateway checks).

  • olm-status-descriptors
  • olm-crds-have-resources
  • olm-spec-descriptors

Once these are included, they also need to pass. This will require the following markers to be added to the CRD code:

  • Spec descriptors that document important attributes in the spec of each CRD
// +operator-sdk:csv:customresourcedefinitions:type=spec
// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Task"
Task string ....
  • Status descriptors that document important attributes in the status of each CRD
// +operator-sdk:csv:customresourcedefinitions:type=status
// +operator-sdk:csv:customresourcedefinitions:type=status,displayName="Phase"
// +operator-sdk:csv:customresourcedefinitions:type=status,xDescriptors="urn:alm:descriptor:io.kubernetes.phase"
Phase phase ...
  • Descriptor that lists the resource types owned by the CRD
// +operator-sdk:csv:customresourcedefinitions:resources={{...}, {...}}
type Build struct { ...

Since camelcatalog does not have a status attribute (its Status type is empty), it fails the scorecard test but cannot be remedied. An issue has been logged here.

@phantomjinx
Copy link
Contributor Author

@squakez squakez added the area/olm Related to the Operator Lifecycle Manager label Feb 21, 2022
@github-actions
Copy link
Contributor

This issue has been automatically marked as stale due to 90 days of inactivity.
It will be closed if no further activity occurs within 15 days.
If you think that’s incorrect or the issue should never stale, please simply write any comment.
Thanks for your contributions!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/olm Related to the Operator Lifecycle Manager status/stale
Projects
None yet
Development

No branches or pull requests

2 participants