Add empty CRD description validator #5603
Conversation
Operator-SDK has alpha support for running external validators. Validators are implemented as binaries that are given a path to bundle and print the result of the validation to the standard out. More information is available at operator-framework/enhancements#98. This commit adds in an external validator that errors when a CRD specified in the bundle `ClusterServiceVersion` does not have a description. This is enforced for both owned and required CRDs. Signed-off-by: Ryan King <ryking@redhat.com>
| BadValue: "", | ||
| Detail: "CRD descriptions cannot be empty", | ||
| } | ||
| } |
There was a problem hiding this comment.
/hold
I think we cannot move with this one here.
We need to check:
a) I the CRD description mandatory for the bundle works well on OLM?
OR
b) we would like to ask for it because is good practice and recommendation?
If we find out that is (a) then,
the check needs to be under the bundle validator OR csv validator
Otherwise, we cannot ensure that we are checking if the bundle/CSV is valid across all solutions that use OF. See that we have other tools which use the validators and we do not want them importing SDK as lib.
if we find out that is (b) then,
the checks would fit better in ; https://github.com/operator-framework/api/blob/master/pkg/validation/internal/good_practices.go
IHMO we cannot indeed have the external validators in this project since SDK itself is not responsible for the validations and these ones are used by many projects. I mean, we have OPM, Audit, as others importing these checks such as SDK from operator-framework/api.
c/c @jmrodri
openshift-ci
bot
added
the
do-not-merge/hold
Operator-SDK has alpha support for running external validators.
Validators are implemented as binaries that are given a path to bundle
and print the result of the validation to the standard out. More
information is available at
operator-framework/enhancements#98.
This commit adds in an external validator that errors when a CRD
specified in the bundle
ClusterServiceVersiondoes not have adescription. This is enforced for both owned and required CRDs.
Signed-off-by: Ryan King ryking@redhat.com