Split framework struct (kubeflow#1956)

* rename framework struct SupportedModelTypes -> SupportedModelFormats ServingRuntimeFramework -> SupportedModelFormat Framework -> ModelFormat Signed-off-by: Suresh Nakkeran <suresh.n@ideas2it.com> * added openapi-gen marker for servingruntime structs Signed-off-by: Suresh Nakkeran <suresh.n@ideas2it.com> * updated openapigen and swagger for servingruntime Signed-off-by: Suresh Nakkeran <suresh.n@ideas2it.com> * update supportedmodelformat in runtime yaml files Signed-off-by: Suresh Nakkeran <suresh.n@ideas2it.com>
magdalenakuhn17 · Dec 21, 2021 · 9bac2b3 · 9bac2b3
1 parent e900189
commit 9bac2b3
Show file tree

Hide file tree

Showing 27 changed files with 1,162 additions and 189 deletions.
diff --git a/config/crd/serving.kserve.io_clusterservingruntimes.yaml b/config/crd/serving.kserve.io_clusterservingruntimes.yaml
@@ -566,7 +566,7 @@ spec:
                   disabled:
                     type: boolean
                 type: object
-              supportedModelTypes:
+              supportedModelFormats:
                 items:
                   properties:
                     autoSelect:

diff --git a/config/crd/serving.kserve.io_inferenceservices.yaml b/config/crd/serving.kserve.io_inferenceservices.yaml
@@ -4941,17 +4941,6 @@ spec:
                                 type: object
                             type: object
                           type: array
-                        framework:
-                          properties:
-                            autoSelect:
-                              type: boolean
-                            name:
-                              type: string
-                            version:
-                              type: string
-                          required:
-                            - name
-                          type: object
                         image:
                           type: string
                         imagePullPolicy:
@@ -5120,6 +5109,15 @@ spec:
                               format: int32
                               type: integer
                           type: object
+                        modelFormat:
+                          properties:
+                            name:
+                              type: string
+                            version:
+                              type: string
+                          required:
+                            - name
+                          type: object
                         name:
                           type: string
                         ports:

diff --git a/config/crd/serving.kserve.io_servingruntimes.yaml b/config/crd/serving.kserve.io_servingruntimes.yaml
@@ -566,7 +566,7 @@ spec:
                   disabled:
                     type: boolean
                 type: object
-              supportedModelTypes:
+              supportedModelFormats:
                 items:
                   properties:
                     autoSelect:

diff --git a/config/runtimes/kserve-lgbserver.yaml b/config/runtimes/kserve-lgbserver.yaml
@@ -3,7 +3,7 @@ kind: ClusterServingRuntime
 metadata:
   name: kserve-lgbserver
 spec:
-  supportedModelTypes:
+  supportedModelFormats:
     - name: lightgbm
       version: "2"
       autoSelect: true

diff --git a/config/runtimes/kserve-mlserver.yaml b/config/runtimes/kserve-mlserver.yaml
@@ -3,7 +3,7 @@ kind: ClusterServingRuntime
 metadata:
   name: kserve-mlserver
 spec:
-  supportedModelTypes:
+  supportedModelFormats:
     - name: sklearn
       version: "0"
     - name: xgboost

diff --git a/config/runtimes/kserve-paddleserver.yaml b/config/runtimes/kserve-paddleserver.yaml
@@ -3,7 +3,7 @@ kind: ClusterServingRuntime
 metadata:
   name: kserve-paddleserver
 spec:
-  supportedModelTypes:
+  supportedModelFormats:
     - name: paddle
       version: "2"
       autoSelect: true

diff --git a/config/runtimes/kserve-pmmlserver.yaml b/config/runtimes/kserve-pmmlserver.yaml
@@ -3,7 +3,7 @@ kind: ClusterServingRuntime
 metadata:
   name: kserve-pmmlserver
 spec:
-  supportedModelTypes:
+  supportedModelFormats:
     - name: pmml
       version: "3"
       autoSelect: true

diff --git a/config/runtimes/kserve-sklearnserver.yaml b/config/runtimes/kserve-sklearnserver.yaml
@@ -3,7 +3,7 @@ kind: ClusterServingRuntime
 metadata:
   name: kserve-sklearnserver
 spec:
-  supportedModelTypes:
+  supportedModelFormats:
     - name: sklearn
       version: "0"
       autoSelect: true

diff --git a/config/runtimes/kserve-tensorflow-serving.yaml b/config/runtimes/kserve-tensorflow-serving.yaml
@@ -3,7 +3,7 @@ kind: ClusterServingRuntime
 metadata:
   name: kserve-tensorflow-serving
 spec:
-  supportedModelTypes:
+  supportedModelFormats:
     - name: tensorflow
       version: "1"
       autoSelect: true

diff --git a/config/runtimes/kserve-torchserve.yaml b/config/runtimes/kserve-torchserve.yaml
@@ -3,7 +3,7 @@ kind: ClusterServingRuntime
 metadata:
   name: kserve-torchserve
 spec:
-  supportedModelTypes:
+  supportedModelFormats:
     - name: pytorch
       version: "1"
       autoSelect: true

diff --git a/config/runtimes/kserve-tritonserver.yaml b/config/runtimes/kserve-tritonserver.yaml
@@ -3,7 +3,7 @@ kind: ClusterServingRuntime
 metadata:
   name: kserve-tritonserver
 spec:
-  supportedModelTypes:
+  supportedModelFormats:
     - name: tensorrt
       version: "8"
     - name: tensorflow

diff --git a/config/runtimes/kserve-xgbserver.yaml b/config/runtimes/kserve-xgbserver.yaml
@@ -3,7 +3,7 @@ kind: ClusterServingRuntime
 metadata:
   name: kserve-xgbserver
 spec:
-  supportedModelTypes:
+  supportedModelFormats:
     - name: xgboost
       version: "0"
       autoSelect: true

diff --git a/hack/update-openapigen.sh b/hack/update-openapigen.sh
@@ -30,6 +30,7 @@ go run k8s.io/kube-openapi/cmd/openapi-gen \
 
 # Hack, the name is required in openAPI specification even if set "+optional" for v1.Container in PredictorExtensionSpec.
 sed -i'.bak' -e 's/Required: \[\]string{\"name\"},//g' $OPENAPI_SPEC_FILE && rm -rf $OPENAPI_SPEC_FILE.bak
+sed -i'.bak' -e 's/Required: \[\]string{\"modelFormat\", \"name\"},/Required: \[\]string{\"modelFormat\"},/g' $OPENAPI_SPEC_FILE && rm -rf $OPENAPI_SPEC_FILE.bak
 
 test -f $CURRENT_VIOLATION_EXCEPTIONS || touch $CURRENT_VIOLATION_EXCEPTIONS
 

diff --git a/hack/violation_exceptions.list b/hack/violation_exceptions.list
@@ -1,3 +1,9 @@
+API rule violation: list_type_missing,./pkg/apis/serving/v1alpha1,Container,Args
+API rule violation: list_type_missing,./pkg/apis/serving/v1alpha1,Container,Command
+API rule violation: list_type_missing,./pkg/apis/serving/v1alpha1,Container,Env
+API rule violation: list_type_missing,./pkg/apis/serving/v1alpha1,ServingRuntimePodSpec,Containers
+API rule violation: list_type_missing,./pkg/apis/serving/v1alpha1,ServingRuntimePodSpec,Tolerations
+API rule violation: list_type_missing,./pkg/apis/serving/v1alpha1,ServingRuntimeSpec,SupportedModelFormats
 API rule violation: list_type_missing,./pkg/apis/serving/v1alpha1,TrainedModelList,Items
 API rule violation: list_type_missing,./pkg/apis/serving/v1beta1,ComponentStatusSpec,Traffic
 API rule violation: list_type_missing,./pkg/apis/serving/v1beta1,InferenceServiceList,Items
@@ -11,6 +17,7 @@ API rule violation: list_type_missing,./pkg/apis/serving/v1beta1,PodSpec,Tolerat
 API rule violation: list_type_missing,./pkg/apis/serving/v1beta1,PodSpec,Volumes
 API rule violation: list_type_missing,./pkg/apis/serving/v1beta1,PredictorConfig,SupportedFrameworks
 API rule violation: names_match,./pkg/apis/serving/v1alpha1,ModelSpec,StorageURI
+API rule violation: names_match,./pkg/apis/serving/v1alpha1,ServingRuntimeSpec,GrpcMultiModelManagementEndpoint
 API rule violation: names_match,./pkg/apis/serving/v1beta1,ComponentExtensionSpec,TimeoutSeconds
 API rule violation: names_match,./pkg/apis/serving/v1beta1,ExplainerConfig,ContainerImage
 API rule violation: names_match,./pkg/apis/serving/v1beta1,ExplainerExtensionSpec,StorageURI

diff --git a/pkg/apis/serving/v1alpha1/servingruntime_types.go b/pkg/apis/serving/v1alpha1/servingruntime_types.go
@@ -21,21 +21,23 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
-type Framework struct {
-	// Name of the model format/framework.
+// +k8s:openapi-gen=true
+type SupportedModelFormat struct {
+	// Name of the model format.
 	// +required
 	Name string `json:"name"`
-	// Version of the model format/framework.
+	// Version of the model format.
 	// Used in validating that a predictor is supported by a runtime.
 	// Can be "major", "major.minor" or "major.minor.patch".
 	// +optional
 	Version *string `json:"version,omitempty"`
 	// Set to true to allow the ServingRuntime to be used for automatic model placement if
-	// this framework is specified with no explicit runtime.
+	// this model format is specified with no explicit runtime.
 	// +optional
 	AutoSelect *bool `json:"autoSelect,omitempty"`
 }
 
+// +k8s:openapi-gen=true
 type Container struct {
 	Name            string                      `json:"name,omitempty" validate:"required"`
 	Image           string                      `json:"image,omitempty" validate:"required"`
@@ -54,11 +56,13 @@ type Container struct {
 	ReadinessProbe *corev1.Probe `json:"readinessProbe,omitempty"`
 }
 
+// +k8s:openapi-gen=true
 type StorageHelper struct {
 	// +optional
 	Disabled bool `json:"disabled,omitempty"`
 }
 
+// +k8s:openapi-gen=true
 type ServingRuntimePodSpec struct {
 	// List of containers belonging to the pod.
 	// Containers cannot currently be added or removed.
@@ -88,9 +92,10 @@ type ServingRuntimePodSpec struct {
 // ServingRuntimeSpec defines the desired state of ServingRuntime. This spec is currently provisional
 // and are subject to change as details regarding single-model serving and multi-model serving
 // are hammered out.
+// +k8s:openapi-gen=true
 type ServingRuntimeSpec struct {
 	// Model formats and version supported by this runtime
-	SupportedModelTypes []Framework `json:"supportedModelTypes,omitempty"`
+	SupportedModelFormats []SupportedModelFormat `json:"supportedModelFormats,omitempty"`
 	// Set to true to disable use of this runtime
 	// +optional
 	Disabled *bool `json:"disabled,omitempty"`
@@ -129,10 +134,12 @@ type ServingRuntimeSpec struct {
 }
 
 // ServingRuntimeStatus defines the observed state of ServingRuntime
+// +k8s:openapi-gen=true
 type ServingRuntimeStatus struct {
 }
 
 // ServerType constant for specifying the runtime name
+// +k8s:openapi-gen=true
 // +kubebuilder:validation:Enum=triton;mlserver
 type ServerType string
 
@@ -144,6 +151,7 @@ const (
 	MLServer ServerType = "mlserver"
 )
 
+// +k8s:openapi-gen=true
 type BuiltInAdapter struct {
 	// ServerType can be one of triton/mlserver and the runtime's container must have the same name
 	ServerType ServerType `json:"serverType,omitempty"`
@@ -156,6 +164,7 @@ type BuiltInAdapter struct {
 }
 
 // ServingRuntime is the Schema for the servingruntimes API
+// +k8s:openapi-gen=true
 // +kubebuilder:object:root=true
 // +kubebuilder:printcolumn:name="Disabled",type="boolean",JSONPath=".spec.disabled"
 // +kubebuilder:printcolumn:name="ModelType",type="string",JSONPath=".spec.supportedModelTypes[*].name"
@@ -170,6 +179,7 @@ type ServingRuntime struct {
 }
 
 // ServingRuntimeList contains a list of ServingRuntime
+// +k8s:openapi-gen=true
 // +kubebuilder:object:root=true
 type ServingRuntimeList struct {
 	metav1.TypeMeta `json:",inline"`
@@ -178,6 +188,7 @@ type ServingRuntimeList struct {
 }
 
 // ClusterServingRuntime is the Schema for the servingruntimes API
+// +k8s:openapi-gen=true
 // +kubebuilder:object:root=true
 // +kubebuilder:resource:scope="Cluster"
 // +kubebuilder:printcolumn:name="Disabled",type="boolean",JSONPath=".spec.disabled"
@@ -193,6 +204,7 @@ type ClusterServingRuntime struct {
 }
 
 // ServingRuntimeList contains a list of ServingRuntime
+// +k8s:openapi-gen=true
 // +kubebuilder:object:root=true
 type ClusterServingRuntimeList struct {
 	metav1.TypeMeta `json:",inline"`

diff --git a/pkg/apis/serving/v1alpha1/servingruntime_types_test.go b/pkg/apis/serving/v1alpha1/servingruntime_types_test.go
@@ -56,7 +56,7 @@ func TestMarshalServingRuntime(t *testing.T) {
 					},
 				},
 			},
-			SupportedModelTypes: []Framework{
+			SupportedModelFormats: []SupportedModelFormat{
 				{
 					Name:    "name",
 					Version: &version,

diff --git a/pkg/apis/serving/v1alpha1/zz_generated.deepcopy.go b/pkg/apis/serving/v1alpha1/zz_generated.deepcopy.go