Merge pull request #663 from dinhxuanvu/min-kube

Add minimum kube version to CSV & check it against server version

Author: openshift-merge-robot

Documentation/design/building-your-csv.md

@@ -44,7 +44,7 @@ It’s common for your Operator to use multiple CRDs to link together concepts,
 
 **Name**: The full name of your CRD
 
-The next two sections require more explanation. 
+The next two sections require more explanation.
 
 **Resources**:
 Your CRDs will own one or more types of Kubernetes objects. These are listed in the resources section to inform your end-users of the objects they might need to troubleshoot or how to connect to the application, such as the Service or Ingress rule that exposes a database.
@@ -178,7 +178,7 @@ An APIService is uniquely identified by the group-version it provides and can be
 
 **Kind**: A kind that the APIService is expected to provide.
 
-**DeploymentName**: 
+**DeploymentName**:
 Name of the deployment defined by your CSV that corresponds to your APIService (required for owned APIServices). During the CSV pending phase, the OLM Operator will search your CSV's InstallStrategy for a deployment spec with a matching name, and if not found, will not transition the CSV to the install ready phase.  
 
 **Resources**:
@@ -190,8 +190,8 @@ It’s recommended to only list out the objects that are important to a human, n
 Essentially the same as for owned CRDs.
 
 ### APIService Resource Creation
-The Lifecycle Manage is responsible for creating or replacing the Service and APIService resources for each unique owned APIService. 
-* Service pod selectors are copied from the CSV deployment matching the APIServiceDescription's DeploymentName. 
+The Lifecycle Manage is responsible for creating or replacing the Service and APIService resources for each unique owned APIService.
+* Service pod selectors are copied from the CSV deployment matching the APIServiceDescription's DeploymentName.
 * A new CA key/cert pair is generated for for each installation and the base64 encoded CA bundle is embedded in the respective APIService resource.
 
 ### APIService Serving Certs
@@ -232,6 +232,8 @@ The metadata section contains general metadata around the name, version and othe
 
 **Description**: A markdown blob that describes the Operator. Important information to include: features, limitations and common use-cases for the Operator. If your Operator manages different types of installs, eg. standalone vs clustered, it is useful to give an overview of how each differs from each other, or which ones are supported for production use.
 
+**MinKubeVersion**: A minimum version of Kubernetes that server is supposed to have so operator(s) can be deployed.
+
 **Labels** (optional): Any key/value pairs used to organize and categorize this CSV object.
 
 **Selectors** (optional): A label selector to identify related resources. Set this to select on current labels applied to this CSV object (if applicable).

deploy/chart/templates/0000_30_02-clusterserviceversion.crd.yaml

@@ -60,6 +60,10 @@ spec:
               type: string
               description: Human readable description of what the application does
 
+            minKubeVersion:
+              type: string
+              description: Minimum kubernetes version requirement on the server to deploy operator
+
             keywords:
               type: array
               description: List of keywords which will be used to discover and categorize app types
@@ -198,7 +202,7 @@ spec:
                     description: Version of the API resource
                   kind:
                     type: string
-                    description: Kind of the API resource        
+                    description: Kind of the API resource
             apiservicedefinitions:
               type: object
               properties:

deploy/chart/templates/_packageserver.clusterserviceversion.yaml

@@ -7,6 +7,7 @@
   spec:
     displayName: Package Server
     description: Represents an Operator package that is available from a given CatalogSource which will resolve to a ClusterServiceVersion.
+    minKubeVersion: {{ .Values.minKubeVersion }}
     keywords: ['packagemanifests', 'olm', 'packages']
     maintainers:
     - name: Red Hat

deploy/chart/values.yaml

@@ -2,6 +2,7 @@ rbacApiVersion: rbac.authorization.k8s.io
 namespace: operator-lifecycle-manager
 catalog_namespace: operator-lifecycle-manager
 operator_namespace: operators
+minKubeVersion: 1.11.0
 imagestream: false
 debug: false
 olm:

manifests/0000_30_02-clusterserviceversion.crd.yaml

@@ -62,6 +62,10 @@ spec:
               type: string
               description: Human readable description of what the application does
 
+            minKubeVersion:
+              type: string
+              description: Minimum kubernetes version requirement on the server to deploy operator
+
             keywords:
               type: array
               description: List of keywords which will be used to discover and categorize app types
@@ -200,7 +204,7 @@ spec:
                     description: Version of the API resource
                   kind:
                     type: string
-                    description: Kind of the API resource        
+                    description: Kind of the API resource
             apiservicedefinitions:
               type: object
               properties:

pkg/api/apis/operators/v1alpha1/clusterserviceversion_types.go

@@ -133,6 +133,7 @@ type ClusterServiceVersionSpec struct {
 	CustomResourceDefinitions CustomResourceDefinitions `json:"customresourcedefinitions,omitempty"`
 	APIServiceDefinitions     APIServiceDefinitions     `json:"apiservicedefinitions,omitempty"`
 	NativeAPIs                []metav1.GroupVersionKind `json:"nativeAPIs,omitempty"`
+	MinKubeVersion            string                    `json:"minKubeVersion,omitempty"`
 	DisplayName               string                    `json:"displayName"`
 	Description               string                    `json:"description,omitempty"`
 	Keywords                  []string                  `json:"keywords,omitempty"`
@@ -478,3 +479,4 @@ func (csv ClusterServiceVersion) GetOwnedAPIServiceDescriptions() []APIServiceDe
 
 	return descs
 }
+