forked from opendatahub-io/opendatahub-operator
-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
allow setting default deployment mode for Kserve in DSC (#864)
* allow setting default deployment mode for Kserve in DSC Signed-off-by: Vedant Mahabaleshwarkar <vmahabal@redhat.com> * move kserve config logic to separate file + enhancements Signed-off-by: Vedant Mahabaleshwarkar <vmahabal@redhat.com> * revert dev image set in operator CSV Signed-off-by: Vedant Mahabaleshwarkar <vmahabal@redhat.com> * only setup kserve config if component is enabled Signed-off-by: Vedant Mahabaleshwarkar <vmahabal@redhat.com> * bug fix Signed-off-by: Vedant Mahabaleshwarkar <vmahabal@redhat.com> * address PR feedback Signed-off-by: Vedant Mahabaleshwarkar <vmahabal@redhat.com> * cleanup Signed-off-by: Vedant Mahabaleshwarkar <vmahabal@redhat.com> * fix lint error Signed-off-by: Vedant Mahabaleshwarkar <vmahabal@redhat.com> * set default value for Kserve defaultDeploymentMode to be empty Signed-off-by: Vedant Mahabaleshwarkar <vmahabal@redhat.com> * more pr feedback Signed-off-by: Vedant Mahabaleshwarkar <vmahabal@redhat.com> * update bundle Signed-off-by: Vedant Mahabaleshwarkar <vmahabal@redhat.com> * enhance documentation Signed-off-by: Vedant Mahabaleshwarkar <vmahabal@redhat.com> * add readme for dev preview Signed-off-by: Vedant Mahabaleshwarkar <vmahabal@redhat.com> --------- Signed-off-by: Vedant Mahabaleshwarkar <vmahabal@redhat.com>
- Loading branch information
1 parent
4ce4dce
commit cebd287
Showing
6 changed files
with
249 additions
and
66 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,175 @@ | ||
| package kserve | ||
|
|
||
| import ( | ||
| "context" | ||
| "encoding/json" | ||
| "fmt" | ||
|
|
||
| "github.com/hashicorp/go-multierror" | ||
| operatorv1 "github.com/openshift/api/operator/v1" | ||
| corev1 "k8s.io/api/core/v1" | ||
| "sigs.k8s.io/controller-runtime/pkg/client" | ||
|
|
||
| dsciv1 "github.com/opendatahub-io/opendatahub-operator/v2/apis/dscinitialization/v1" | ||
| "github.com/opendatahub-io/opendatahub-operator/v2/pkg/deploy" | ||
| "github.com/opendatahub-io/opendatahub-operator/v2/pkg/feature" | ||
| ) | ||
|
|
||
| const ( | ||
| KserveConfigMapName string = "inferenceservice-config" | ||
| ) | ||
|
|
||
| func (k *Kserve) setupKserveConfig(ctx context.Context, cli client.Client, dscispec *dsciv1.DSCInitializationSpec) error { | ||
| // as long as Kserve.Serving is not 'Removed', we will setup the dependencies | ||
|
|
||
| switch k.Serving.ManagementState { | ||
| case operatorv1.Managed, operatorv1.Unmanaged: | ||
| if k.DefaultDeploymentMode == "" { | ||
| // if the default mode is empty in the DSC, assume mode is "Serverless" since k.Serving is Managed | ||
| if err := k.setDefaultDeploymentMode(ctx, cli, dscispec, Serverless); err != nil { | ||
| return err | ||
| } | ||
| } else { | ||
| // if the default mode is explicitly specified, respect that | ||
| if err := k.setDefaultDeploymentMode(ctx, cli, dscispec, k.DefaultDeploymentMode); err != nil { | ||
| return err | ||
| } | ||
| } | ||
| case operatorv1.Removed: | ||
| if k.DefaultDeploymentMode == Serverless { | ||
| return fmt.Errorf("setting defaultdeployment mode as Serverless is incompatible with having Serving 'Removed'") | ||
| } | ||
| if k.DefaultDeploymentMode == "" { | ||
| fmt.Println("Serving is removed, Kserve will default to rawdeployment") | ||
| } | ||
| if err := k.setDefaultDeploymentMode(ctx, cli, dscispec, RawDeployment); err != nil { | ||
| return err | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (k *Kserve) setDefaultDeploymentMode(ctx context.Context, cli client.Client, dscispec *dsciv1.DSCInitializationSpec, defaultmode DefaultDeploymentMode) error { | ||
| inferenceServiceConfigMap := &corev1.ConfigMap{} | ||
| err := cli.Get(ctx, client.ObjectKey{ | ||
| Namespace: dscispec.ApplicationsNamespace, | ||
| Name: KserveConfigMapName, | ||
| }, inferenceServiceConfigMap) | ||
| if err != nil { | ||
| return fmt.Errorf("error getting configmap 'inferenceservice-config'. %w", err) | ||
| } | ||
|
|
||
| // set data.deploy.defaultDeploymentMode to the model specified in the Kserve spec | ||
| var deployData map[string]interface{} | ||
| if err = json.Unmarshal([]byte(inferenceServiceConfigMap.Data["deploy"]), &deployData); err != nil { | ||
| return fmt.Errorf("error retrieving value for key 'deploy' from configmap %s. %w", KserveConfigMapName, err) | ||
| } | ||
| modeFound := deployData["defaultDeploymentMode"] | ||
| if modeFound != string(defaultmode) { | ||
| deployData["defaultDeploymentMode"] = defaultmode | ||
| deployDataBytes, err := json.MarshalIndent(deployData, "", " ") | ||
| if err != nil { | ||
| return fmt.Errorf("could not set values in configmap %s. %w", KserveConfigMapName, err) | ||
| } | ||
| inferenceServiceConfigMap.Data["deploy"] = string(deployDataBytes) | ||
|
|
||
| var ingressData map[string]interface{} | ||
| if err = json.Unmarshal([]byte(inferenceServiceConfigMap.Data["ingress"]), &ingressData); err != nil { | ||
| return fmt.Errorf("error retrieving value for key 'ingress' from configmap %s. %w", KserveConfigMapName, err) | ||
| } | ||
| if defaultmode == RawDeployment { | ||
| ingressData["disableIngressCreation"] = true | ||
| } else { | ||
| ingressData["disableIngressCreation"] = false | ||
| } | ||
| ingressDataBytes, err := json.MarshalIndent(ingressData, "", " ") | ||
| if err != nil { | ||
| return fmt.Errorf("could not set values in configmap %s. %w", KserveConfigMapName, err) | ||
| } | ||
| inferenceServiceConfigMap.Data["ingress"] = string(ingressDataBytes) | ||
|
|
||
| if err = cli.Update(ctx, inferenceServiceConfigMap); err != nil { | ||
| return fmt.Errorf("could not set default deployment mode for Kserve. %w", err) | ||
| } | ||
|
|
||
| // Restart the pod if configmap is updated so that kserve boots with the correct value | ||
| podList := &corev1.PodList{} | ||
| listOpts := []client.ListOption{ | ||
| client.InNamespace(dscispec.ApplicationsNamespace), | ||
| client.MatchingLabels{ | ||
| "app.opendatahub.io/kserve": "true", | ||
| "control-plane": "kserve-controller-manager", | ||
| }, | ||
| } | ||
| if err := cli.List(ctx, podList, listOpts...); err != nil { | ||
| return fmt.Errorf("failed to list pods: %w", err) | ||
| } | ||
| for _, pod := range podList.Items { | ||
| pod := pod | ||
| if err := cli.Delete(ctx, &pod); err != nil { | ||
| return fmt.Errorf("failed to delete pod %s: %w", pod.Name, err) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func (k *Kserve) configureServerless(cli client.Client, instance *dsciv1.DSCInitializationSpec) error { | ||
| switch k.Serving.ManagementState { | ||
| case operatorv1.Unmanaged: // Bring your own CR | ||
| fmt.Println("Serverless CR is not configured by the operator, we won't do anything") | ||
|
|
||
| case operatorv1.Removed: // we remove serving CR | ||
| fmt.Println("existing Serverless CR (owned by operator) will be removed") | ||
| if err := k.removeServerlessFeatures(instance); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| case operatorv1.Managed: // standard workflow to create CR | ||
| switch instance.ServiceMesh.ManagementState { | ||
| case operatorv1.Unmanaged, operatorv1.Removed: | ||
| return fmt.Errorf("ServiceMesh is need to set to 'Managed' in DSCI CR, it is required by KServe serving field") | ||
| } | ||
|
|
||
| // check on dependent operators if all installed in cluster | ||
| dependOpsErrors := checkDependentOperators(cli).ErrorOrNil() | ||
| if dependOpsErrors != nil { | ||
| return dependOpsErrors | ||
| } | ||
|
|
||
| serverlessFeatures := feature.ComponentFeaturesHandler(k, instance, k.configureServerlessFeatures()) | ||
|
|
||
| if err := serverlessFeatures.Apply(); err != nil { | ||
| return err | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (k *Kserve) removeServerlessFeatures(instance *dsciv1.DSCInitializationSpec) error { | ||
| serverlessFeatures := feature.ComponentFeaturesHandler(k, instance, k.configureServerlessFeatures()) | ||
|
|
||
| return serverlessFeatures.Delete() | ||
| } | ||
|
|
||
| func checkDependentOperators(cli client.Client) *multierror.Error { | ||
| var multiErr *multierror.Error | ||
|
|
||
| if found, err := deploy.OperatorExists(cli, ServiceMeshOperator); err != nil { | ||
| multiErr = multierror.Append(multiErr, err) | ||
| } else if !found { | ||
| err = fmt.Errorf("operator %s not found. Please install the operator before enabling %s component", | ||
| ServiceMeshOperator, ComponentName) | ||
| multiErr = multierror.Append(multiErr, err) | ||
| } | ||
|
|
||
| if found, err := deploy.OperatorExists(cli, ServerlessOperator); err != nil { | ||
| multiErr = multierror.Append(multiErr, err) | ||
| } else if !found { | ||
| err = fmt.Errorf("operator %s not found. Please install the operator before enabling %s component", | ||
| ServerlessOperator, ComponentName) | ||
| multiErr = multierror.Append(multiErr, err) | ||
| } | ||
| return multiErr | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.