GoDoc operatorhub validator #159
Conversation
dinhxuanvu
left a comment
dinhxuanvu
left a comment
There was a problem hiding this comment.
Looking good. A few small comments.
| // * "image/svg+xml" | ||
| // - If informed ONLY, check if the value csv.Spec.MinKubeVersion is parsable according to semver (https://semver.org/) | ||
| // Also, this validator will raise warnings when: | ||
| // - The bundle name (CSV.metadata.name) seems not following the naming convention: <operator-name>.v<semver> e.g. memcached-operator.v0.0.1 |
There was a problem hiding this comment.
Can we add a note about the name must be 63 characters or less because it will be used as k8s ownerref label which only allows max of 63 characters?
| // `k8s-version` key is allowed. If informed, it will perform the checks against this specific Kubernetes version where the | ||
| // operator bundle is intend to be distribute for. | ||
| // operator bundle is intend to be distribute for and will raise errors instead of warnings. | ||
| // Currently, this check is capable of to verify the removed APIs only for Kubernetes 1.22 version. |
| // Note that this validator allows to receive a List of optional values as key=values. Currently, only the | ||
| // `k8s-version` key is allowed. If informed, it will perform the checks against this specific Kubernetes version where the | ||
| // operator bundle is intend to be distribute for. | ||
| // operator bundle is intend to be distribute for and will raise errors instead of warnings. |
There was a problem hiding this comment.
I'm not sure what intend to be distribute for means. Can you elaborate further?
There was a problem hiding this comment.
I change the text. Please, let me know if it fits better.
| // * "Full Lifecycle" | ||
| // * "Deep Insights" | ||
| // * "Auto Pilot" | ||
| // - The annotations categories into the CSV has a valid option, which are: |
There was a problem hiding this comment.
we support custom categories too though. maybe worth mentioning.
https://olm.operatorframework.io/docs/tasks/creating-operator-bundle/#custom-bundle-categories
Signed-off-by: Camila Macedo <[email protected]>
|
Hi @dinhxuanvu and @exdx, All comments addressed. Thank you for your time and help on that. |
|
/lgtm |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: camilamacedo86, dinhxuanvu The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-ci
bot
added
the
approved
4 participants
Description
GoDoc operatorhub validator
When merged this documentation should appears in: https://pkg.go.dev/github.com/operator-framework/api@master/pkg/validation/internal#OperatorHubValidator