Merge branch 'main' into RHOAIENG-40473-add-debugging-for-gen-ai-bff

Author: jharan1

docs/onboard-modular-architecture.md

@@ -0,0 +1,107 @@
+# Onboarding a New Modular Architecture Module
+
+This guide outlines the steps to create and onboard a new modular architecture module into the ODH Dashboard.
+
+## Prerequisites
+
+- Node.js and npm installed.
+- Access to the ODH Dashboard repository.
+
+## Steps
+
+### 1. Navigate to the Packages Directory
+
+Open your terminal and navigate to the `packages` folder within the repository:
+
+```bash
+cd packages
+```
+
+### 2. Initialize the Module
+
+Start a new modular architecture project using the installer. Replace `<your-module-name>` with the desired name for your module.
+
+```bash
+npx mod-arch-installer <your-module-name> --flavor default
+```
+
+### 3. Adapt the Module Name
+
+After initialization, you need to update the generated code to match your specific module name. Search for occurrences of `mod-arch` and `modArch` in your new package and replace them with your module's identifier.
+
+Key files to check:
+
+- `package.json`
+- `frontend/src/odh/extensions.ts` (or similar entry point to change the nav)
+- `frontend/config/moduleFederation.js`
+
+In BFF you can do a replace-all searching for `mod-arch` and will change the package name.
+
+### 4. Configure the Port
+
+By default, the modular architecture component runs on port `9103`. If you need to use a different port or want to ensure it doesn't conflict with other modules:
+
+1. **Update `Makefile`**:
+   Open `packages/<your-module-name>/Makefile` and find the `dev-frontend-federated` target. Update the `PORT` variable:
+
+   ```makefile
+   dev-frontend-federated:
+       cd frontend && AUTH_METHOD=user_token DEPLOYMENT_MODE=federated STYLE_THEME=patternfly PORT=<your-port> npm run start:dev
+   ```
+
+2. **Update `package.json`**:
+   Open `packages/<your-module-name>/package.json` and update the `module-federation` configuration:
+
+   ```json
+   "module-federation": {
+     "local": {
+       "port": <your-port>
+     }
+   }
+   ```
+
+### 5. Add Feature Flag
+
+To enable your module in the main dashboard, you need to add a feature flag.
+
+1. Open `frontend/src/concepts/areas/const.ts` in the root of the repository.
+2. Search for existing flags (e.g., search for `disable` or `techPreviewFlags`).
+3. Add your new feature flag to the appropriate group (e.g., `techPreviewFlags`):
+
+   ```typescript
+   export const techPreviewFlags = {
+     // ... existing flags
+     // yourModuleName: true, // Set to true to enable by default in tech preview, or false otherwise
+   } satisfies Partial<DashboardCommonConfig>;
+   ```
+
+### 6. Run the Application
+
+Now that your project is configured, you can run the entire stack (backend, frontend, and your new module).
+
+From the root of the repository, run:
+
+```bash
+npm run dev:frontend
+```
+
+And in other terminal
+
+```bash
+npm run dev:backend
+```
+
+And once you have that in another terminal run
+
+```bash
+cd packages/<your-module>
+make dev-start-federated
+```
+
+This command will start:
+
+- The Dashboard Backend
+- The Dashboard Frontend (Shell)
+- Your new Modular Architecture Module (Federated)
+
+Access the dashboard in your browser (usually at `http://localhost:4000` or the port configured for the shell) and verify that your module is loaded.

frontend/src/__tests__/cypress/cypress/fixtures/e2e/featureStoreResources/testFeatureStoreResources.yaml

@@ -0,0 +1,5 @@
+# Feature Store test data
+projectName: "test-fs-ui-proj"
+feastInstanceName: "test-s3"
+feastCreditScoringProject: "credit_scoring_local"
+feastDriverRankingProject: "driver_ranking"

frontend/src/__tests__/cypress/cypress/fixtures/resources/yaml/feast.yaml

@@ -0,0 +1,36 @@
+kind: Secret
+apiVersion: v1
+metadata:
+  name: s3-credentials-secret
+  namespace: ${namespace}
+stringData:
+  AWS_ACCESS_KEY_ID: ${awsAccessKey}
+  AWS_SECRET_ACCESS_KEY: ${awsSecretKey}
+  AWS_DEFAULT_REGION: ${awsDefaultRegion}
+---
+apiVersion: feast.dev/v1alpha1
+kind: FeatureStore
+metadata:
+  name: test-s3
+  namespace: ${namespace}
+  labels:
+    feature-store-ui: enabled
+spec:
+  feastProject: driver_ranking
+  services:
+    onlineStore:
+      server:
+        envFrom:
+          - secretRef:
+              name: s3-credentials-secret
+    registry:
+      local:
+        persistence:
+          file:
+            path: s3://${awsBucketName}/feast-test/feast-credit-score-remote-data/registry.pb
+        server:
+          envFrom:
+          - secretRef:
+              name: s3-credentials-secret
+          grpc: true
+          restAPI: true

frontend/src/__tests__/cypress/cypress/fixtures/resources/yaml/model_registry.yaml

@@ -11,24 +11,24 @@ spec:
   rest: {}
   kubeRBACProxy: {}
   mysql:
-    host: model-registry-db
+    host: {{DATABASE_NAME}}
     port: 3306
     database: model_registry
     username: mlmduser
     skipDBCreation: false
     passwordSecret:
-      name: model-registry-db
+      name: {{DATABASE_NAME}}
       key: database-password
 ---
 apiVersion: v1
 kind: Secret
 metadata:
-  name: model-registry-db
+  name: {{DATABASE_NAME}}
   namespace: {{NAMESPACE}}
   labels:
-    app.kubernetes.io/name: model-registry-db
-    app.kubernetes.io/instance: model-registry-db
-    app.kubernetes.io/part-of: model-registry-db
+    app.kubernetes.io/name: {{DATABASE_NAME}}
+    app.kubernetes.io/instance: {{DATABASE_NAME}}
+    app.kubernetes.io/part-of: {{DATABASE_NAME}}
     app.kubernetes.io/managed-by: kustomize
   annotations:
     template.openshift.io/expose-database_name: '{.data[''database-name'']}'
@@ -37,4 +37,4 @@ metadata:
 stringData:
   database-name: "model_registry"
   database-password: "TheBlurstOfTimes"
-  database-user: "mlmduser"
+  database-user: "mlmduser"

frontend/src/__tests__/cypress/cypress/fixtures/resources/yaml/model_registry_database.yaml

@@ -4,13 +4,13 @@ items:
   kind: Service
   metadata:
     labels:
-      app.kubernetes.io/name: model-registry-db
-      app.kubernetes.io/instance: model-registry-db
-      app.kubernetes.io/part-of: model-registry-db
+      app.kubernetes.io/name: {{DATABASE_NAME}}
+      app.kubernetes.io/instance: {{DATABASE_NAME}}
+      app.kubernetes.io/part-of: {{DATABASE_NAME}}
       app.kubernetes.io/managed-by: kustomize
     annotations:
       template.openshift.io/expose-uri: mysql://{.spec.clusterIP}:{.spec.ports[?(.name==\mysql\)].port}
-    name: model-registry-db
+    name: {{DATABASE_NAME}}
     namespace: {{NAMESPACE}}
   spec:
     ports:
@@ -21,18 +21,18 @@ items:
       appProtocol: tcp
       targetPort: 3306
     selector:
-      name: model-registry-db
+      name: {{DATABASE_NAME}}
     sessionAffinity: None
     type: ClusterIP
 - apiVersion: v1
   kind: PersistentVolumeClaim
   metadata:
     labels:
-      app.kubernetes.io/name: model-registry-db
-      app.kubernetes.io/instance: model-registry-db
-      app.kubernetes.io/part-of: model-registry-db
+      app.kubernetes.io/name: {{DATABASE_NAME}}
+      app.kubernetes.io/instance: {{DATABASE_NAME}}
+      app.kubernetes.io/part-of: {{DATABASE_NAME}}
       app.kubernetes.io/managed-by: kustomize
-    name: model-registry-db
+    name: {{DATABASE_NAME}}
     namespace: {{NAMESPACE}}
   spec:
     accessModes:
@@ -44,26 +44,26 @@ items:
   kind: Deployment
   metadata:
     labels:
-      app.kubernetes.io/name: model-registry-db
-      app.kubernetes.io/instance: model-registry-db
-      app.kubernetes.io/part-of: model-registry-db
+      app.kubernetes.io/name: {{DATABASE_NAME}}
+      app.kubernetes.io/instance: {{DATABASE_NAME}}
+      app.kubernetes.io/part-of: {{DATABASE_NAME}}
       app.kubernetes.io/managed-by: kustomize
     annotations:
       template.alpha.openshift.io/wait-for-ready: "true"
-    name: model-registry-db
+    name: {{DATABASE_NAME}}
     namespace: {{NAMESPACE}}
   spec:
     replicas: 1
     revisionHistoryLimit: 0
     selector:
       matchLabels:
-        name: model-registry-db
+        name: {{DATABASE_NAME}}
     strategy:
       type: Recreate
     template:
       metadata:
         labels:
-          name: model-registry-db
+          name: {{DATABASE_NAME}}
           sidecar.istio.io/inject: "false"
       spec:
         containers:
@@ -72,22 +72,22 @@ items:
             valueFrom:
               secretKeyRef:
                 key: database-user
-                name: model-registry-db
+                name: {{DATABASE_NAME}}
           - name: MYSQL_PASSWORD
             valueFrom:
               secretKeyRef:
                 key: database-password
-                name: model-registry-db
+                name: {{DATABASE_NAME}}
           - name: MYSQL_ROOT_PASSWORD
             valueFrom:
               secretKeyRef:
                 key: database-password
-                name: model-registry-db
+                name: {{DATABASE_NAME}}
           - name: MYSQL_DATABASE
             valueFrom:
               secretKeyRef:
                 key: database-name
-                name: model-registry-db
+                name: {{DATABASE_NAME}}
           args:
             - --datadir
             - /var/lib/mysql/datadir
@@ -126,30 +126,30 @@ items:
           terminationMessagePath: /dev/termination-log
           volumeMounts:
           - mountPath: /var/lib/mysql
-            name: model-registry-db-data
+            name: {{DATABASE_NAME}}-data
         dnsPolicy: ClusterFirst
         restartPolicy: Always
         volumes:
-        - name: model-registry-db-data
+        - name: {{DATABASE_NAME}}-data
           persistentVolumeClaim:
-            claimName: model-registry-db
+            claimName: {{DATABASE_NAME}}
 - apiVersion: v1
   kind: Secret
   metadata:
     labels:
-      app.kubernetes.io/name: model-registry-db
-      app.kubernetes.io/instance: model-registry-db
-      app.kubernetes.io/part-of: model-registry-db
+      app.kubernetes.io/name: {{DATABASE_NAME}}
+      app.kubernetes.io/instance: {{DATABASE_NAME}}
+      app.kubernetes.io/part-of: {{DATABASE_NAME}}
       app.kubernetes.io/managed-by: kustomize
     annotations:
       template.openshift.io/expose-database_name: '{.data[''database-name'']}'
       template.openshift.io/expose-password: '{.data[''database-password'']}'
       template.openshift.io/expose-username: '{.data[''database-user'']}'
-    name: model-registry-db
+    name: {{DATABASE_NAME}}
     namespace: {{NAMESPACE}}
   stringData:
     database-name: "model_registry"
     database-password: "TheBlurstOfTimes" # notsecret
     database-user: "mlmduser" # notsecret
 kind: List
-metadata: {}
+metadata: {}

frontend/src/__tests__/cypress/cypress/pages/featureStore/featureStoreGlobal.ts

@@ -88,6 +88,17 @@ class FeatureStoreGlobal {
     this.waitForFeatureServiceDetails(featureService);
   }
 
+  navigateToOverview() {
+    appChrome
+      .findNavItem({
+        name: 'Overview',
+        rootSection: 'Develop & train',
+        subSection: 'Feature store',
+      })
+      .click();
+    this.waitForOverview();
+  }
+
   navigateToFeatureViews() {
     appChrome
       .findNavItem({
@@ -121,6 +132,39 @@ class FeatureStoreGlobal {
     this.waitForFeatures();
   }
 
+  navigateToDataSources() {
+    appChrome
+      .findNavItem({
+        name: 'Data sources',
+        rootSection: 'Develop & train',
+        subSection: 'Feature store',
+      })
+      .click();
+    this.waitForDataSources();
+  }
+
+  navigateToDatasets() {
+    appChrome
+      .findNavItem({
+        name: 'Datasets',
+        rootSection: 'Develop & train',
+        subSection: 'Feature store',
+      })
+      .click();
+    this.waitForDataSets();
+  }
+
+  navigateToFeatureServices() {
+    appChrome
+      .findNavItem({
+        name: 'Feature services',
+        rootSection: 'Develop & train',
+        subSection: 'Feature store',
+      })
+      .click();
+    this.waitForFeatureServices();
+  }
+
   findHeading() {
     return cy.findByTestId('app-page-title');
   }
@@ -252,6 +296,10 @@ class FeatureStoreGlobal {
     const testId = `global-search-item-${type}-${title.toLowerCase().replace(/\s+/g, '-')}`;
     return cy.findByTestId(testId);
   }
+
+  findPaginationToggle() {
+    return cy.get('#table-pagination-top-toggle');
+  }
 }
 
 class FeatureStoreProjectSelector extends Contextual<HTMLElement> {