add description

Author: katieperry4

frontend/src/__mocks__/mockInferenceServiceK8sResource.ts

@@ -7,6 +7,7 @@ type MockResourceConfigType = {
   name?: string;
   namespace?: string;
   displayName?: string;
+  description?: string;
   modelName?: string;
   secretName?: string;
   deleted?: boolean;
@@ -88,6 +89,7 @@ export const mockInferenceServiceK8sResource = ({
   name = 'test-inference-service',
   namespace = 'test-project',
   displayName = 'Test Inference Service',
+  description = undefined,
   modelName = 'test-model',
   secretName = 'test-secret',
   deleted = false,
@@ -128,6 +130,7 @@ export const mockInferenceServiceK8sResource = ({
   metadata: {
     annotations: {
       'openshift.io/display-name': displayName,
+      ...(description && { 'openshift.io/description': description }),
       'serving.kserve.io/deploymentMode': isModelMesh
         ? DeploymentMode.ModelMesh
         : isKserveRaw

frontend/src/__tests__/cypress/cypress/pages/modelServing.ts

@@ -889,6 +889,10 @@ class ModelServingWizard extends Wizard {
     return cy.findByTestId('model-deployment-name');
   }
 
+  findModelDeploymentDescriptionInput() {
+    return cy.findByTestId('model-deployment-description');
+  }
+
   findModelFormatSelect() {
     return cy.findByTestId('model-framework-select');
   }

frontend/src/__tests__/cypress/cypress/tests/mocked/modelServing/modelServingDeploy.cy.ts

@@ -306,6 +306,7 @@ describe('Model Serving Deploy Wizard', () => {
     modelServingWizard.findAdvancedOptionsStep().should('be.disabled');
     modelServingWizard.findNextButton().should('be.disabled');
     modelServingWizard.findModelDeploymentNameInput().type('test-model');
+    modelServingWizard.findModelDeploymentDescriptionInput().type('test-description');
     modelServingWizard.findAdvancedOptionsStep().should('be.enabled');
     hardwareProfileSection.findSelect().should('contain.text', 'Small');
 
@@ -360,6 +361,7 @@ describe('Model Serving Deploy Wizard', () => {
         },
         annotations: {
           'openshift.io/display-name': 'test-model',
+          'openshift.io/description': 'test-description',
           'opendatahub.io/hardware-profile-namespace': 'opendatahub',
           'opendatahub.io/hardware-profile-name': 'small-profile',
           'opendatahub.io/model-type': 'generative',
@@ -652,6 +654,7 @@ describe('Model Serving Deploy Wizard', () => {
           modelType: ServingRuntimeModelType.PREDICTIVE,
           hardwareProfileName: 'large-profile',
           hardwareProfileNamespace: 'opendatahub',
+          description: 'test-description',
           resources: {
             requests: {
               cpu: '4',
@@ -690,6 +693,9 @@ describe('Model Serving Deploy Wizard', () => {
     modelServingWizardEdit.findNextButton().should('be.enabled').click();
 
     // Step 2: Model deployment
+    modelServingWizardEdit
+      .findModelDeploymentDescriptionInput()
+      .should('contain.text', 'test-description');
     modelServingWizardEdit.findModelDeploymentStep().should('be.enabled');
     modelServingWizardEdit.findAdvancedOptionsStep().should('be.enabled');
     modelServingWizardEdit.findNextButton().should('be.enabled');

packages/kserve/src/deploy.ts

@@ -21,6 +21,7 @@ export type CreatingInferenceServiceObject = {
   project: string;
   name: string;
   k8sName: string;
+  description: string;
   modelType: ServingRuntimeModelType;
   hardwareProfile: HardwareProfileConfig;
   modelFormat: SupportedModelFormats;
@@ -49,6 +50,7 @@ export const deployKServeDeployment = async (
     project: projectName,
     name: wizardData.k8sNameDesc.data.name,
     k8sName: wizardData.k8sNameDesc.data.k8sName.value,
+    description: wizardData.k8sNameDesc.data.description,
     modelType: wizardData.modelType.data,
     hardwareProfile: wizardData.hardwareProfileConfig.formData,
     modelFormat: wizardData.modelFormatState.modelFormat,
@@ -89,12 +91,9 @@ const assembleInferenceService = (
 ): InferenceServiceKind => {
   const {
     project,
-    name,
     k8sName,
-    modelType,
     hardwareProfile,
     modelFormat,
-    tokenAuth,
     externalRoute,
     numReplicas,
     runtimeArgs,
@@ -127,20 +126,9 @@ const assembleInferenceService = (
       };
 
   const annotations = { ...inferenceService.metadata.annotations };
-  annotations['openshift.io/display-name'] = name.trim();
-  annotations['opendatahub.io/model-type'] = modelType;
+  const updatedAnnotations = applyAnnotations(annotations, data);
 
-  annotations['opendatahub.io/hardware-profile-name'] =
-    hardwareProfile.selectedProfile?.metadata.name;
-
-  annotations['opendatahub.io/hardware-profile-namespace'] =
-    hardwareProfile.selectedProfile?.metadata.namespace;
-
-  if (tokenAuth && tokenAuth.length > 0) {
-    annotations['security.opendatahub.io/enable-auth'] = 'true';
-  }
-
-  inferenceService.metadata.annotations = annotations;
+  inferenceService.metadata.annotations = updatedAnnotations;
 
   if (externalRoute) {
     if (!inferenceService.metadata.labels) {
@@ -194,3 +182,33 @@ const createInferenceService = (
     ),
   );
 };
+
+const applyAnnotations = (
+  annotations: Record<string, string>,
+  data: CreatingInferenceServiceObject,
+) => {
+  const { name, description, modelType, hardwareProfile, tokenAuth } = data;
+  const updatedAnnotations = { ...annotations };
+  updatedAnnotations['openshift.io/display-name'] = name.trim();
+  if (description) {
+    updatedAnnotations['openshift.io/description'] = description;
+  }
+  updatedAnnotations['opendatahub.io/model-type'] = modelType;
+  const isLegacyHardwareProfile = !hardwareProfile.selectedProfile?.metadata.uid;
+  if (!isLegacyHardwareProfile) {
+    updatedAnnotations['opendatahub.io/hardware-profile-name'] =
+      hardwareProfile.selectedProfile?.metadata.name || '';
+  } else {
+    const legacyName = hardwareProfile.selectedProfile?.metadata.name;
+    if (legacyName) {
+      updatedAnnotations['opendatahub.io/legacy-hardware-profile-name'] = legacyName;
+    }
+  }
+  updatedAnnotations['opendatahub.io/hardware-profile-namespace'] =
+    hardwareProfile.selectedProfile?.metadata.namespace || '';
+
+  if (tokenAuth && tokenAuth.length > 0) {
+    updatedAnnotations['security.opendatahub.io/enable-auth'] = 'true';
+  }
+  return updatedAnnotations;
+};

packages/model-serving/src/components/deploymentWizard/steps/ModelDeploymentStep.tsx

@@ -26,7 +26,6 @@ export const ModelDeploymentStepContent: React.FC<ModelDeploymentStepProps> = ({
           dataTestId="model-deployment"
           nameLabel="Model deployment name"
           nameHelperText="This is the name of the inference service created when the model is deployed." // TODO: make this non-Kserve specific
-          hideDescription
         />
         <ModelServingHardwareProfileSection
           project={projectName}