Merge pull request #2123 from opendatahub-io/f/model-serving

Merge `f/model-serving` to `main`
opendatahub-io · Nov 13, 2023 · 34c5a09 · 34c5a09
2 parents b13896b + 051fe59
commit 34c5a09
Show file tree

Hide file tree

Showing 135 changed files with 4,836 additions and 1,329 deletions.
diff --git a/backend/src/routes/api/cluster-settings/clusterSettingsUtils.ts b/backend/src/routes/api/cluster-settings/clusterSettingsUtils.ts
@@ -18,6 +18,10 @@ const DEFAULT_CLUSTER_SETTINGS: ClusterSettings = {
   cullerTimeout: DEFAULT_CULLER_TIMEOUT,
   userTrackingEnabled: false,
   notebookTolerationSettings: { enabled: false, key: 'NotebooksOnly' },
+  modelServingPlatformEnabled: {
+    kServe: true,
+    modelMesh: false,
+  },
 };
 
 export const updateClusterSettings = async (
@@ -28,10 +32,30 @@ export const updateClusterSettings = async (
 ): Promise<{ success: boolean; error: string }> => {
   const coreV1Api = fastify.kube.coreV1Api;
   const namespace = fastify.kube.namespace;
-  const { pvcSize, cullerTimeout, userTrackingEnabled, notebookTolerationSettings } = request.body;
+  const {
+    pvcSize,
+    cullerTimeout,
+    userTrackingEnabled,
+    notebookTolerationSettings,
+    modelServingPlatformEnabled,
+  } = request.body;
   const dashConfig = getDashboardConfig();
   const isJupyterEnabled = checkJupyterEnabled();
   try {
+    if (
+      modelServingPlatformEnabled.kServe !== !dashConfig.spec.dashboardConfig.disableKServe ||
+      modelServingPlatformEnabled.modelMesh !== !dashConfig.spec.dashboardConfig.disableModelMesh
+    ) {
+      await setDashboardConfig(fastify, {
+        spec: {
+          dashboardConfig: {
+            disableKServe: !modelServingPlatformEnabled.kServe,
+            disableModelMesh: !modelServingPlatformEnabled.modelMesh,
+          },
+        },
+      });
+    }
+
     await patchCM(fastify, segmentKeyCfg, {
       data: { segmentKeyEnabled: String(userTrackingEnabled) },
     }).catch((e) => {
@@ -41,7 +65,6 @@ export const updateClusterSettings = async (
       if (isJupyterEnabled) {
         await setDashboardConfig(fastify, {
           spec: {
-            dashboardConfig: dashConfig.spec.dashboardConfig,
             notebookController: {
               enabled: isJupyterEnabled,
               pvcSize: `${pvcSize}Gi`,
@@ -124,10 +147,14 @@ export const getClusterSettings = async (
 ): Promise<ClusterSettings | string> => {
   const coreV1Api = fastify.kube.coreV1Api;
   const namespace = fastify.kube.namespace;
-  const clusterSettings = {
+  const dashConfig = getDashboardConfig();
+  const clusterSettings: ClusterSettings = {
     ...DEFAULT_CLUSTER_SETTINGS,
+    modelServingPlatformEnabled: {
+      kServe: !dashConfig.spec.dashboardConfig.disableKServe,
+      modelMesh: !dashConfig.spec.dashboardConfig.disableModelMesh,
+    },
   };
-  const dashConfig = getDashboardConfig();
   const isJupyterEnabled = checkJupyterEnabled();
   if (!dashConfig.spec.dashboardConfig.disableTracking) {
     try {

diff --git a/backend/src/routes/api/namespaces/const.ts b/backend/src/routes/api/namespaces/const.ts
@@ -4,7 +4,11 @@ export enum NamespaceApplicationCase {
    */
   DSG_CREATION,
   /**
-   * Upgrade an existing DSG project to work with model serving.
+   * Upgrade an existing DSG project to work with model mesh.
    */
-  MODEL_SERVING_PROMOTION,
+  MODEL_MESH_PROMOTION,
+  /**
+   * Upgrade an existing DSG project to work with model kserve.
+   */
+  KSERVE_PROMOTION,
 }
diff --git a/backend/src/routes/api/namespaces/namespaceUtils.ts b/backend/src/routes/api/namespaces/namespaceUtils.ts
@@ -67,11 +67,16 @@ export const applyNamespaceChange = async (
         'opendatahub.io/dashboard': 'true',
       };
       break;
-    case NamespaceApplicationCase.MODEL_SERVING_PROMOTION:
+    case NamespaceApplicationCase.MODEL_MESH_PROMOTION:
       labels = {
         'modelmesh-enabled': 'true',
       };
       break;
+    case NamespaceApplicationCase.KSERVE_PROMOTION:
+      labels = {
+        'modelmesh-enabled': 'false',
+      };
+      break;
     default:
       throw createCustomError('Unknown configuration', 'Cannot apply namespace change', 400);
   }

diff --git a/backend/src/types.ts b/backend/src/types.ts
@@ -29,6 +29,8 @@ export type DashboardConfig = K8sResourceCommon & {
       disableCustomServingRuntimes: boolean;
       modelMetricsNamespace: string;
       disablePipelines: boolean;
+      disableKServe: boolean;
+      disableModelMesh: boolean;
     };
     groupsConfig?: {
       adminGroups: string;
@@ -100,6 +102,10 @@ export type ClusterSettings = {
   cullerTimeout: number;
   userTrackingEnabled: boolean;
   notebookTolerationSettings: NotebookTolerationSettings | null;
+  modelServingPlatformEnabled: {
+    kServe: boolean;
+    modelMesh: boolean;
+  };
 };
 
 // Add a minimal QuickStart type here as there is no way to get types without pulling in frontend (React) modules
@@ -947,7 +953,7 @@ type ComponentNames =
 
 export type DataScienceClusterKindStatus = {
   conditions: [];
-  installedComponents: { [key in ComponentNames]: boolean };
+  installedComponents: { [key in ComponentNames]?: boolean };
   phase?: string;
 };
 

diff --git a/backend/src/utils/constants.ts b/backend/src/utils/constants.ts
@@ -53,6 +53,8 @@ export const blankDashboardCR: DashboardConfig = {
       disableCustomServingRuntimes: false,
       modelMetricsNamespace: '',
       disablePipelines: false,
+      disableKServe: false,
+      disableModelMesh: true,
     },
     notebookController: {
       enabled: true,

diff --git a/backend/src/utils/resourceUtils.ts b/backend/src/utils/resourceUtils.ts
@@ -105,6 +105,21 @@ const fetchOrCreateDashboardCR = async (
     )
     .then((res) => {
       const dashboardCR = res?.body as DashboardConfig;
+      if (
+        dashboardCR &&
+        dashboardCR.spec.dashboardConfig.disableKServe === undefined &&
+        dashboardCR.spec.dashboardConfig.disableModelMesh === undefined
+      ) {
+        // return a merge between dashboardCR and blankDashboardCR but changing spec.disableKServe to true and spec.disableModelMesh to false
+        return _.merge({}, blankDashboardCR, dashboardCR, {
+          spec: {
+            dashboardConfig: {
+              disableKServe: true,
+              disableModelMesh: false,
+            },
+          },
+        });
+      }
       return _.merge({}, blankDashboardCR, dashboardCR); // merge with blank CR to prevent any missing values
     })
     .catch((e) => {

diff --git a/docs/dashboard-config.md b/docs/dashboard-config.md
@@ -24,6 +24,8 @@ The following are a list of features that are supported, along with there defaul
 | disableModelServing          | false   | Disables Model Serving from the dashboard and from Data Science Projects.                            |
 | disableProjectSharing        | false   | Disables Project Sharing from Data Science Projects.                                                 |
 | disableCustomServingRuntimes | false   | Disables Custom Serving Runtimes from the Admin Panel.                                               |
+| disableKServe                | false   | Disables the ability to select KServe as a Serving Platform.                                         |
+| disableModelMesh             | true    | Disables the ability to select ModelMesh as a Serving Platform.                                      |
 | modelMetricsNamespace        | false   | Enables the namespace in which the Model Serving Metrics' Prometheus Operator is installed.          |
 
 ## Defaults

diff --git a/frontend/src/__mocks__/mockClusterSettings.ts b/frontend/src/__mocks__/mockClusterSettings.ts
@@ -9,9 +9,14 @@ export const mockClusterSettings = ({
     key: 'NotebooksOnlyChange',
     enabled: true,
   },
+  modelServingPlatformEnabled = {
+    kServe: true,
+    modelMesh: true,
+  },
 }: Partial<ClusterSettingsType>): ClusterSettingsType => ({
   userTrackingEnabled,
   cullerTimeout,
   pvcSize,
   notebookTolerationSettings,
+  modelServingPlatformEnabled,
 });
diff --git a/frontend/src/__mocks__/mockDashboardConfig.ts b/frontend/src/__mocks__/mockDashboardConfig.ts
@@ -13,6 +13,8 @@ type MockDashboardConfigType = {
   disablePipelines?: boolean;
   disableModelServing?: boolean;
   disableCustomServingRuntimes?: boolean;
+  disableKServe?: boolean;
+  disableModelMesh?: boolean;
 };
 
 export const mockDashboardConfig = ({
@@ -28,6 +30,8 @@ export const mockDashboardConfig = ({
   disableModelServing = false,
   disableCustomServingRuntimes = false,
   disablePipelines = false,
+  disableKServe = false,
+  disableModelMesh = true,
 }: MockDashboardConfigType): DashboardConfigKind => ({
   apiVersion: 'opendatahub.io/v1alpha',
   kind: 'OdhDashboardConfig',
@@ -55,6 +59,8 @@ export const mockDashboardConfig = ({
       disablePipelines,
       modelMetricsNamespace: 'test-project',
       disableProjectSharing: false,
+      disableKServe,
+      disableModelMesh,
     },
     notebookController: {
       enabled: true,

diff --git a/frontend/src/__mocks__/mockDscStatus.ts b/frontend/src/__mocks__/mockDscStatus.ts
@@ -1,20 +1,116 @@
-import { DataScienceClusterKindStatus } from '~/k8sTypes';
+import { DataScienceClusterKindStatus, K8sCondition } from '~/k8sTypes';
 import { StackComponent } from '~/concepts/areas/types';
 
-type MockDscStatus = {
+export type MockDscStatus = {
+  conditions?: K8sCondition[];
+  phase?: string;
   installedComponents?: DataScienceClusterKindStatus['installedComponents'];
 };
 
 export const mockDscStatus = ({
   installedComponents,
+  conditions = [],
+  phase = 'Ready',
 }: MockDscStatus): DataScienceClusterKindStatus => ({
-  conditions: [],
+  conditions: [
+    ...[
+      {
+        lastHeartbeatTime: '2023-10-20T11:44:48Z',
+        lastTransitionTime: '2023-10-15T19:04:21Z',
+        message: 'DataScienceCluster resource reconciled successfully',
+        reason: 'ReconcileCompleted',
+        status: 'True',
+        type: 'ReconcileComplete',
+      },
+      {
+        lastHeartbeatTime: '2023-10-20T11:44:48Z',
+        lastTransitionTime: '2023-10-15T19:04:21Z',
+        message: 'DataScienceCluster resource reconciled successfully',
+        reason: 'ReconcileCompleted',
+        status: 'True',
+        type: 'Available',
+      },
+      {
+        lastHeartbeatTime: '2023-10-20T11:44:48Z',
+        lastTransitionTime: '2023-10-15T19:04:21Z',
+        message: 'DataScienceCluster resource reconciled successfully',
+        reason: 'ReconcileCompleted',
+        status: 'False',
+        type: 'Progressing',
+      },
+      {
+        lastHeartbeatTime: '2023-10-20T11:44:48Z',
+        lastTransitionTime: '2023-10-15T19:04:10Z',
+        message: 'DataScienceCluster resource reconciled successfully',
+        reason: 'ReconcileCompleted',
+        status: 'False',
+        type: 'Degraded',
+      },
+      {
+        lastHeartbeatTime: '2023-10-20T11:44:48Z',
+        lastTransitionTime: '2023-10-15T19:04:21Z',
+        message: 'DataScienceCluster resource reconciled successfully',
+        reason: 'ReconcileCompleted',
+        status: 'True',
+        type: 'Upgradeable',
+      },
+      {
+        lastHeartbeatTime: '2023-10-20T11:44:59Z',
+        lastTransitionTime: '2023-10-20T11:44:59Z',
+        message: 'Component reconciled successfully',
+        reason: 'ReconcileCompleted',
+        status: 'True',
+        type: 'odh-dashboardReady',
+      },
+      {
+        lastHeartbeatTime: '2023-10-20T11:44:59Z',
+        lastTransitionTime: '2023-10-20T11:44:59Z',
+        message: 'Component reconciled successfully',
+        reason: 'ReconcileCompleted',
+        status: 'True',
+        type: 'data-science-pipelines-operatorReady',
+      },
+      {
+        lastHeartbeatTime: '2023-10-20T11:45:01Z',
+        lastTransitionTime: '2023-10-20T11:45:01Z',
+        message: 'Component reconciled successfully',
+        reason: 'ReconcileCompleted',
+        status: 'True',
+        type: 'workbenchesReady',
+      },
+      {
+        lastHeartbeatTime: '2023-10-20T11:45:04Z',
+        lastTransitionTime: '2023-10-20T11:45:04Z',
+        message: 'Component reconciled successfully',
+        reason: 'ReconcileCompleted',
+        status: 'True',
+        type: 'kserveReady',
+      },
+      {
+        lastHeartbeatTime: '2023-10-20T11:45:04Z',
+        lastTransitionTime: '2023-10-20T11:45:04Z',
+        message: 'Component reconciled successfully',
+        reason: 'ReconcileCompleted',
+        status: 'True',
+        type: 'model-meshReady',
+      },
+      {
+        lastHeartbeatTime: '2023-10-20T11:45:06Z',
+        lastTransitionTime: '2023-10-20T11:45:06Z',
+        message: 'Component is disabled',
+        reason: 'ReconcileInit',
+        status: 'Unknown',
+        type: 'rayReady',
+      },
+    ],
+    ...conditions,
+  ],
   installedComponents: Object.values(StackComponent).reduce(
     (acc, component) => ({
       ...acc,
       [component]: installedComponents?.[component] ?? false,
     }),
     {},
   ),
-  phase: 'Ready',
+  phase,
 });
diff --git a/frontend/src/__mocks__/mockInferenceServiceK8sResource.ts b/frontend/src/__mocks__/mockInferenceServiceK8sResource.ts
@@ -7,6 +7,10 @@ type MockResourceConfigType = {
   displayName?: string;
   modelName?: string;
   secretName?: string;
+  deleted?: boolean;
+  isModelMesh?: boolean;
+  activeModelState?: string;
+  url?: string;
 };
 
 export const mockInferenceServicek8sError = () => ({
@@ -37,15 +41,26 @@ export const mockInferenceServiceK8sResource = ({
   displayName = 'Test Inference Service',
   modelName = 'test-model',
   secretName = 'test-secret',
+  deleted = false,
+  isModelMesh = false,
+  activeModelState = 'Pending',
+  url = '',
 }: MockResourceConfigType): InferenceServiceKind => ({
   apiVersion: 'serving.kserve.io/v1beta1',
   kind: 'InferenceService',
   metadata: {
     annotations: {
       'openshift.io/display-name': displayName,
-      'serving.kserve.io/deploymentMode': 'ModelMesh',
+      ...(isModelMesh
+        ? { 'serving.kserve.io/deploymentMode': 'ModelMesh' }
+        : {
+            'serving.knative.openshift.io/enablePassthrough': 'true',
+            'sidecar.istio.io/inject': 'true',
+            'sidecar.istio.io/rewriteAppHTTPProbers': 'true',
+          }),
     },
     creationTimestamp: '2023-03-17T16:12:41Z',
+    ...(deleted ? { deletionTimestamp: new Date().toUTCString() } : {}),
     generation: 1,
     labels: {
       name: name,
@@ -73,7 +88,7 @@ export const mockInferenceServiceK8sResource = ({
   },
   status: {
     components: {},
-    url: '',
+    url,
     conditions: [
       {
         lastTransitionTime: '2023-03-17T16:12:41Z',
@@ -99,7 +114,7 @@ export const mockInferenceServiceK8sResource = ({
         time: '',
       },
       states: {
-        activeModelState: 'Pending',
+        activeModelState,
         targetModelState: '',
       },
       transitionStatus: '',