doc operatorhub validator (openshift#159)

Signed-off-by: Camila Macedo <[email protected]>

Upstream-repository: api
Upstream-commit: dd58de2b37096fb5fcd8b5538cf58cfc811b113a

Author: camilamacedo86

staging/api/pkg/validation/internal/operatorhub.go

@@ -21,9 +21,68 @@ import (
 // OperatorHubValidator validates the bundle manifests against the required criteria to publish
 // the projects on OperatorHub.io.
 //
+// This validator will ensure that:
+// - The annotations capabilities into the CSV has a valid option, which are:
+// * "Basic Install"
+// * "Seamless Upgrades"
+// * "Full Lifecycle"
+// * "Deep Insights"
+// * "Auto Pilot"
+// - The annotations categories into the CSV has a valid option, which are:
+// * "AI/Machine Learning"
+// * "Application Runtime"
+// * "Big Data"
+// * "Cloud Provider"
+// * "Developer Tools"
+// * "Database"
+// * "Integration & Delivery"
+// * "Logging & Tracing"
+// * "Monitoring"
+// * "Networking"
+// * "OpenShift Optional"
+// * "Security"
+// * "Storage"
+// * "Streaming & Messaging"
+//
+// NOTE: The operatorhub validator can verify against custom bundle categories by setting the OPERATOR_BUNDLE_CATEGORIES
+// environment variable. Setting the OPERATOR_BUNDLE_CATEGORIES environment variable to the path to a json file
+// containing a list of categories will enable those categories to be used when comparing CSV categories for
+// operatorhub validation. The json file should be in the following format:
+//
+//	```json
+//	{
+//		"categories":[
+//      "Cloud Pak",
+//      "Registry",
+//      "MyCoolThing",
+//  	 ]
+//	}
+// 	```
+//
+// - The csv.Spec.Provider.Name was provided
+// - The csv.Spec.Maintainers elements contains both name and email
+// - The csv.Spec.Links elements contains both name and url
+// - The csv.Spec.Links.Url is a valid value
+// - The csv.Spec.Version is provided
+// - The checks.csv.Spec.Icon was provided and has not more than one element
+// - The csv.Spec.Icon elements should contain both data and mediatype
+// - The csv.Spec.Icon elements should contain both data and mediatype
+// - The csv.Spec.Icon has a valid mediatype, which are
+// * "image/gif"
+// * "image/jpeg"
+// * "image/png"
+// * "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) does not follow the naming convention: <operator-name>.v<semver> e.g. memcached-operator.v0.0.1
+// NOTE: The bundle name must be 63 characters or less because it will be used as k8s ownerref label which only allows max of 63 characters.
+// - The channel names seems are not following the convention https://olm.operatorframework.io/docs/best-practices/channel-naming/
+// - The usage of the removed APIs on Kubernetes 1.22 is found. More info: https://kubernetes.io/docs/reference/using-api/deprecation-guide/#v1-22
+//
 // 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 used and will raise errors instead of warnings.
+// Currently, this check is capable of verifying the removed APIs only for Kubernetes 1.22 version.
 var OperatorHubValidator interfaces.Validator = interfaces.ValidatorFunc(validateOperatorHub)
 
 var validCapabilities = map[string]struct{}{