doc: fix layout of the doc (#171)

camilamacedo86 · perdasilva · commit 2e65d95e5bc1 · 2021-12-03T13:45:40.000-08:00
Signed-off-by: Per G. da Silva &lt;perdasilva@redhat.com&gt;
diff --git a/crds/operators.coreos.com_catalogsources.yaml b/crds/operators.coreos.com_catalogsources.yaml
@@ -59,15 +59,26 @@ spec:
                 address:
                   description: 'Address is a host that OLM can use to connect to a pre-existing registry. Format: <registry-host or ip>:<port> Only used when SourceType = SourceTypeGrpc. Ignored when the Image field is set.'
                   type: string
-                config:
-                  description: Config adds additional optional settings, e.g. catalog source pod node selectors and tolerations
+                configMap:
+                  description: ConfigMap is the name of the ConfigMap to be used to back a configmap-server registry. Only used when SourceType = SourceTypeConfigmap or SourceTypeInternal.
+                  type: string
+                description:
+                  type: string
+                displayName:
+                  description: Metadata
+                  type: string
+                grpcPodConfig:
+                  description: GrpcPodConfig exposes different overrides for the pod spec of the CatalogSource Pod. Only used when SourceType = SourceTypeGrpc and Image is set.
                   type: object
                   properties:
                     nodeSelector:
                       description: 'NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node''s labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/'
                       type: object
                       additionalProperties:
                         type: string
+                    priorityClassName:
+                      description: If specified, indicates the pod's priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default.
+                      type: string
                     tolerations:
                       description: Tolerations are the catalog source's pod's tolerations.
                       type: array
@@ -91,14 +102,6 @@ spec:
                           value:
                             description: Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
                             type: string
-                configMap:
-                  description: ConfigMap is the name of the ConfigMap to be used to back a configmap-server registry. Only used when SourceType = SourceTypeConfigmap or SourceTypeInternal.
-                  type: string
-                description:
-                  type: string
-                displayName:
-                  description: Metadata
-                  type: string
                 icon:
                   type: object
                   required:
diff --git a/crds/zz_defs.go b/crds/zz_defs.go
diff --git a/pkg/operators/v1alpha1/catalogsource_types.go b/pkg/operators/v1alpha1/catalogsource_types.go
@@ -80,9 +80,10 @@ type CatalogSourceSpec struct {
 	// +Optional
 	Secrets []string `json:"secrets,omitempty"`
 
-	// Config adds additional optional settings, e.g. catalog source pod node selectors and tolerations
+	// GrpcPodConfig exposes different overrides for the pod spec of the CatalogSource Pod.
+	// Only used when SourceType = SourceTypeGrpc and Image is set.
 	// +Optional
-	Config *CatalogSourceConfig `json:"config,omitempty"`
+	GrpcPodConfig *GrpcPodConfig `json:"grpcPodConfig,omitempty"`
 
 	// Metadata
 	DisplayName string `json:"displayName,omitempty"`
@@ -91,8 +92,8 @@ type CatalogSourceSpec struct {
 	Icon        Icon   `json:"icon,omitempty"`
 }
 
-// CatalogSourceConfig contains configuration specified for a catalog source
-type CatalogSourceConfig struct {
+// GrpcPodConfig contains configuration specified for a catalog source
+type GrpcPodConfig struct {
 	// NodeSelector is a selector which must be true for the pod to fit on a node.
 	// Selector which must match a node's labels for the pod to be scheduled on that node.
 	// More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
@@ -102,6 +103,15 @@ type CatalogSourceConfig struct {
 	// Tolerations are the catalog source's pod's tolerations.
 	// +optional
 	Tolerations []corev1.Toleration `json:"tolerations,omitempty"`
+
+	// If specified, indicates the pod's priority. "system-node-critical" and
+	// "system-cluster-critical" are two special keywords which indicate the
+	// highest priorities with the former being the highest priority. Any other
+	// name must be defined by creating a PriorityClass object with that name.
+	// If not specified, the pod priority will be default or zero if there is no
+	// default.
+	// +optional
+	PriorityClassName string `json:"priorityClassName,omitempty" protobuf:"bytes,24,opt,name=priorityClassName"`
 }
 
 // UpdateStrategy holds all the different types of catalog source update strategies
diff --git a/pkg/operators/v1alpha1/zz_generated.deepcopy.go b/pkg/operators/v1alpha1/zz_generated.deepcopy.go
diff --git a/pkg/validation/internal/bundle.go b/pkg/validation/internal/bundle.go
@@ -52,11 +52,11 @@ func validateServiceAccounts(bundle *manifests.Bundle) []errors.Error {
 		sa := v1.ServiceAccount{}
 		if err := runtime.DefaultUnstructuredConverter.FromUnstructured(obj.Object, &sa); err == nil {
 			if _, ok := saNamesFromCSV[sa.Name]; ok {
-				errs = append(errs, errors.ErrInvalidBundle(fmt.Sprintf("invalid service account found in bundle. " +
-					"This service account %s in your bundle is not valid, because a service account with the same name " +
-					"was already specified in your CSV. If this was unintentional, please remove the service account " +
-					"manifest from your bundle. If it was intentional to specify a separate service account, " +
-					"please rename the SA in either the bundle manifest or the CSV.",sa.Name), sa.Name))
+				errs = append(errs, errors.ErrInvalidBundle(fmt.Sprintf("invalid service account found in bundle. "+
+					"This service account %s in your bundle is not valid, because a service account with the same name "+
+					"was already specified in your CSV. If this was unintentional, please remove the service account "+
+					"manifest from your bundle. If it was intentional to specify a separate service account, "+
+					"please rename the SA in either the bundle manifest or the CSV.", sa.Name), sa.Name))
 			}
 		}
 	}
diff --git a/pkg/validation/internal/operatorhub.go b/pkg/validation/internal/operatorhub.go
@@ -22,33 +22,55 @@ import (
 // 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"
+//
+// * 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"
-// * "Modernization & Migration"
-// * "Monitoring"
-// * "Networking"
-// * "OpenShift Optional"
-// * "Security"
-// * "Storage"
-// * "Streaming & Messaging"
-//
-// NOTE: The operatorhub validator can verify against custom bundle categories by setting the OPERATOR_BUNDLE_CATEGORIES
+//
+// * AI/Machine Learning
+//
+// * Application Runtime
+//
+// * Big Data
+//
+// * Cloud Provider
+//
+// * Developer Tools
+//
+// * Database
+//
+// * Integration & Delivery
+//
+// * Logging & Tracing
+//
+// * Modernization & Migration
+//
+// * 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:
+// OperatorHub validation. The json file should be in the following format:
 //
 //	```json
 //	{
@@ -60,24 +82,41 @@ import (
 //	}
 // 	```
 //
-// - 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"
+// - 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 `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

Original file line number	Diff line number	Diff line change
`@@ -52,11 +52,11 @@ func validateServiceAccounts(bundle *manifests.Bundle) []errors.Error {`
`52`	`52`	`sa := v1.ServiceAccount{}`
`53`	`53`	`if err := runtime.DefaultUnstructuredConverter.FromUnstructured(obj.Object, &sa); err == nil {`
`54`	`54`	`if _, ok := saNamesFromCSV[sa.Name]; ok {`
`55`		`- errs = append(errs, errors.ErrInvalidBundle(fmt.Sprintf("invalid service account found in bundle. " +`
`56`		`- "This service account %s in your bundle is not valid, because a service account with the same name " +`
`57`		`- "was already specified in your CSV. If this was unintentional, please remove the service account " +`
`58`		`- "manifest from your bundle. If it was intentional to specify a separate service account, " +`
`59`		`- "please rename the SA in either the bundle manifest or the CSV.",sa.Name), sa.Name))`
	`55`	`+ errs = append(errs, errors.ErrInvalidBundle(fmt.Sprintf("invalid service account found in bundle. "+`
	`56`	`+ "This service account %s in your bundle is not valid, because a service account with the same name "+`
	`57`	`+ "was already specified in your CSV. If this was unintentional, please remove the service account "+`
	`58`	`+ "manifest from your bundle. If it was intentional to specify a separate service account, "+`
	`59`	`+ "please rename the SA in either the bundle manifest or the CSV.", sa.Name), sa.Name))`
`60`	`60`	`}`
`61`	`61`	`}`
`62`	`62`	`}`