add multiarch optional validator (#5908)

Bump of the API + add the new validator

Author: camilamacedo86

changelog/fragments/add-muiltiarch.yaml

@@ -0,0 +1,13 @@
+# entries is a list of entries to include in
+# release notes and/or the migration guide
+entries:
+  - description: >
+      (Alpha) New optional validator to help verify if a bundle matches criteria for multiple architecture support. More info: https://olm.operatorframework.io/docs/advanced-tasks/ship-operator-supporting-multiarch/.
+      You can test it out by running `$ operator-sdk bundle validate ./bundle --select-optional name=multiarch`
+    kind: "addition"
+    breaking: false
+  - description: >
+      Moved bundle name validation check to the good-practices validator.
+      You can test it out by running `$ operator-sdk bundle validate ./bundle --select-optional name=good-practices`
+    kind: "addition"
+    breaking: false

go.mod

@@ -13,7 +13,7 @@ require (
 	github.com/maxbrunsfeld/counterfeiter/v6 v6.2.2
 	github.com/onsi/ginkgo v1.16.5
 	github.com/onsi/gomega v1.18.1
-	github.com/operator-framework/api v0.15.0
+	github.com/operator-framework/api v0.15.1-0.20220624132056-decf74800a17
 	github.com/operator-framework/helm-operator-plugins v0.0.12-0.20220616200420-1a695cb9f6a1
 	github.com/operator-framework/java-operator-plugins v0.5.1
 	github.com/operator-framework/operator-lib v0.11.0

go.sum

@@ -865,8 +865,8 @@ github.com/opencontainers/runtime-spec v1.0.3-0.20210326190908-1c3f411f0417/go.m
 github.com/opencontainers/selinux v1.8.2/go.mod h1:MUIHuUEvKB1wtJjQdOyYRgOnLD2xAPP8dBsCoU0KuF8=
 github.com/opentracing/opentracing-go v1.1.0/go.mod h1:UkNAQd3GIcIGf0SeVgPpRdFStlNbqXla1AfSYxPUl2o=
 github.com/openzipkin/zipkin-go v0.1.6/go.mod h1:QgAqvLzwWbR/WpD4A3cGpPtJrZXNIiJc5AZX7/PBEpw=
-github.com/operator-framework/api v0.15.0 h1:4f9i0drtqHj7ykLoHxv92GR43S7MmQHhmFQkfm5YaGI=
-github.com/operator-framework/api v0.15.0/go.mod h1:scnY9xqSeCsOdtJtNoHIXd7OtHZ14gj1hkDA4+DlgLY=
+github.com/operator-framework/api v0.15.1-0.20220624132056-decf74800a17 h1:05SuHwvLPituTsGnzoapFtJT+HVD+9noxCQBkmfWScw=
+github.com/operator-framework/api v0.15.1-0.20220624132056-decf74800a17/go.mod h1:scnY9xqSeCsOdtJtNoHIXd7OtHZ14gj1hkDA4+DlgLY=
 github.com/operator-framework/helm-operator-plugins v0.0.12-0.20220616200420-1a695cb9f6a1 h1:ulX/0zkiQIg2JkVuAtC329ygfXHg9Sb578vQ7kdNVkY=
 github.com/operator-framework/helm-operator-plugins v0.0.12-0.20220616200420-1a695cb9f6a1/go.mod h1:D7zPPwmIFBqHtWigU2iJiLuZ0v7hOJOb1/VC+/UuBAQ=
 github.com/operator-framework/java-operator-plugins v0.5.1 h1:HmiTocc61d/uqVPY/7EUR6ZTHDVeZ5/fgy7uo1QIBFc=

internal/cmd/operator-sdk/bundle/validate/cmd.go

@@ -100,7 +100,17 @@ To validate a bundle against the (alpha) validator for Deprecated APIs specifica
 To validate a bundle against an external validator, in addition to required bundle validators:
 
   $ operator-sdk bundle validate ./bundle --alpha-select-external /path/to/external-validator[:/path/to/optional-second-validator]
-	`
+
+To validate a bundle against the (alpha) validator for Multiple Architectures bundle validation, in addition to required bundle validators:
+
+IMPORTANT: To use this option it is required to have access to pull the images defined on the CSV.
+
+  $ operator-sdk bundle validate ./bundle --select-optional name=multiarch 
+
+NOTE: The --optional-values can be used to inform the container-tools that should be used i.e. "--optional-values=container-tools=docker".
+The valid values for the container-tools optional value are [docker, podman, none]. If no value is supplied then the command will default to using docker to inspect the images.
+More info: https://github.com/operator-framework/api/blob/master/pkg/validation/internal/multiarch.go
+`
 )
 
 // NewCmd returns a command that will validate an operator bundle.

internal/cmd/operator-sdk/bundle/validate/optional.go

@@ -70,6 +70,14 @@ var optionalValidators = validators{
 		},
 		desc: "Good Practices bundle validation. This validator validates the bundle against criteria and suggestions defined as good practices for bundles under the operator-framework solutions. More info: https://sdk.operatorframework.io/docs/best-practices/.",
 	},
+	{
+		Validator: apivalidation.MultipleArchitecturesValidator,
+		name:      "multiarch",
+		labels: map[string]string{
+			nameKey: "multiarch",
+		},
+		desc: "(Alpha) Multiple Architectures bundle validation. This validator validates the bundle against criteria defined to configure the support for multiple architectures. More info: https://olm.operatorframework.io/docs/advanced-tasks/ship-operator-supporting-multiarch/.",
+	},
 }
 
 // runOptionalValidators runs optional validators selected by sel on bundle.

website/content/en/docs/cli/operator-sdk_bundle_validate.md

@@ -86,7 +86,17 @@ To validate a bundle against the (alpha) validator for Deprecated APIs specifica
 To validate a bundle against an external validator, in addition to required bundle validators:
 
   $ operator-sdk bundle validate ./bundle --alpha-select-external /path/to/external-validator[:/path/to/optional-second-validator]
-	
+
+To validate a bundle against the (alpha) validator for Multiple Architectures bundle validation, in addition to required bundle validators:
+
+IMPORTANT: To use this option it is required to have access to pull the images defined on the CSV.
+
+  $ operator-sdk bundle validate ./bundle --select-optional name=multiarch 
+
+NOTE: The --optional-values can be used to inform the container-tools that should be used i.e. "--optional-values=container-tools=docker".
+The valid values for the container-tools optional value are [docker, podman, none]. If no value is supplied then the command will default to using docker to inspect the images.
+More info: https://github.com/operator-framework/api/blob/master/pkg/validation/internal/multiarch.go
+
 ```
 
 ### Options