Skip to content
This repository was archived by the owner on Sep 21, 2020. It is now read-only.

Generated CSV manifests are missing required description and displayName fields #39

Closed
hasbro17 opened this issue May 23, 2019 · 4 comments
Assignees
Labels
kind/bug Categorizes issue or PR as related to a bug.

Comments

@hasbro17
Copy link
Collaborator

In the section Generate an Operator Manifest users are told to generate their CSV manifests via the SDK's operator-sdk olm-catalog gen-csv command.

As of v0.8.0 the CSV will not generate the spec.customresourcedefinitions.owned.displayName and spec.customresourcedefinitions.owned.description which are required by OLM:

$ oc apply -f deploy/olm-catalog/memcached-operator/0.0.1/memcached-operator.v0.0.1.clusterserviceversion.yaml
spec.customresourcedefinitions.owned.displayName in body is required
spec.customresourcedefinitions.owned.description in body is required

Until this can be fixed upstream in the SDK the docs should point out this required change in the generated manifests.

@hasbro17
Copy link
Collaborator Author

@estroz Can you reference the related issue/PR in the SDK if we have one for this already.

@estroz
Copy link
Member

estroz commented May 23, 2019

@jianzhangbjz
Copy link
Contributor

/cc

@camilamacedo86 camilamacedo86 added kind/bug Categorizes issue or PR as related to a bug. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Sep 4, 2019
@camilamacedo86
Copy link
Contributor

Hi @hasbro17,

Note that we update the OLM steps as it example which make it more clear. Also, the need to populated dynamic the fields spec.customresourcedefinitions are tracked in operator-framework/operator-sdk#1132 already and as we described in operator-framework/operator-sdk#2071 the project has other plans in place to try to improve the user experience and make this process easier, for example, by implementing a new API lib to validate it. See https://github.com/operator-framework/api.

So, it shows to me that we could address the points raised here and is quite safe to close this one. In this way, I am closing it. However, please feel free to re-open if you see that something else need to get done with.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
kind/bug Categorizes issue or PR as related to a bug.
Projects
None yet
Development

No branches or pull requests

4 participants