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

No type-checking performed on the alm-examples: CSV field #106

Open
jsm84 opened this issue Apr 16, 2019 · 1 comment
Open

No type-checking performed on the alm-examples: CSV field #106

jsm84 opened this issue Apr 16, 2019 · 1 comment

Comments

@jsm84
Copy link

jsm84 commented Apr 16, 2019

Whilst building a CSV is still currently a manual process and therefore is error prone, taking the deploy/crds/cr.yaml file, converting to JSON, and pasting it under the alm-examples: field simply yields a type dict (the entire CR contents encapsulated in { }). If this is left as is, running operator-courier verify on the resulting bundle yields the following output: string indices must be integers.

Adding [ ] around the { } resolves this issue by converting alm-examples: JSON value from a type dict to a type list/array (but this value is of yaml type string as denoted by the | ). Can this be explicitly caught by the courier, perhaps adding a suggestion as with other missing or mis-populated fields?

Note that, this might not cause a deployment failure in OLM as with #104 as the courier verify exits abnormally (and this is done first in the CVP pipeline prior to deployment), but our partners (users) writing their operator using helm or ansible likely won't have a clue what to do to fix their CSV in the dev/testing stage if they get the error noted above.

@SamiSousa
Copy link
Contributor

@jsm84 Thank you for posting issue! We are looking into improving the error logs for the alm-example JSON validation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants