Procedure

1. Configure RHOAI-related RBAC and credentials. A Kubernetes ServiceAccount and a service-account-token Secret are required for the connector to retrieve data from RHOAI. The following resources must be created, replacing namespace names (ai-rhdh for RHDH, rhoai-model-registries for RHOAI) as needed:

   • ServiceAccount (rhdh-rhoai-bridge)
   • ClusterRole and ClusterRoleBinding (rhdh-rhoai-bridge) to allow access to OCP resources like routes, services, and inferenceservices.
   • Role and RoleBinding to allow ConfigMap updates within the RHDH namespace.
   • RoleBinding in the RHOAI namespace to grant the RHDH ServiceAccount read permissions to the Model Registry data (binding to registry-user-modelregistry-public).
   • Secret (rhdh-rhoai-bridge-token) of type kubernetes.io/service-account-token that goes along with the rhdh-rhoai-bridge ServiceAccount.

2. Update your RHDH dynamic plugin configuration. The RHDH Pod requires two dynamic plugins.

   1. In your RHDH dynamic plugins ConfigMap, add the following code:

      plugins:
        - disabled: false
          package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-catalog-backend-module-model-catalog:bs_1.42.5__0.7.0!red-hat-developer-hub-backstage-plugin-catalog-backend-module-model-catalog
        - disabled: false
          package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-catalog-techdoc-url-reader-backend:bs_1.42.5__0.3.0!red-hat-developer-hub-backstage-plugin-catalog-techdoc-url-reader-backend

3. Add the Connector sidecar containers to the RHDH Pod.

   • If RHDH was installed using the Operator, modify your RHDH custom resource (CR) instance.
   • If RHDH was installed using the Helm charts, modify the Deployment specification.

4. The system relies on three sidecar containers (model catalog bridge) running alongside the backstage-backend container. Add these sidecar containers to your configuration referencing the rhdh-rhoai-bridge-token Secret:

   • location: Provides the REST API for RHDH plugins to fetch model metadata.
   • storage-rest: Maintains a cache of AI Model metadata in a ConfigMap called bac-import-model.

   • rhoai-normalizer: Acts as a Kubernetes controller and RHOAI client, normalizing RHOAI metadata for the connector. The following code block is an example:

     spec:
       template:
         spec:
           containers:
             - name: backstage-backend
             - env:
                 - name: NORMALIZER_FORMAT
                   value: JsonArrayFormat
                 - name: POD_IP
                   valueFrom:
                     fieldRef:
                       fieldPath: status.podIP
                 - name: POD_NAMESPACE
                   valueFrom:
                     fieldRef:
                       fieldPath: metadata.namespace
               envFrom:
                 - secretRef:
                     name: rhdh-rhoai-bridge-token
               image: quay.io/redhat-ai-dev/model-catalog-location-service@sha256:4f6ab6624a29f627f9f861cfcd5d18177d46aa2c67a81a75a1502c49bc2ff012
     
               imagePullPolicy: Always
               name: location
               ports:
                 - containerPort: 9090
                   name: location
                   protocol: TCP
               volumeMounts:
                 - mountPath: /opt/app-root/src/dynamic-plugins-root
                   name: dynamic-plugins-root
                 workingDir: /opt/app-root/src
               - env:
                 - name: NORMALIZER_FORMAT
                   value: JsonArrayFormat
                 - name: STORAGE_TYPE
                   value: ConfigMap
                 - name: BRIDGE_URL
                   value: http://localhost:9090
                 - name: POD_IP
                   valueFrom:
                     fieldRef:
                       fieldPath: status.podIP
                 - name: POD_NAMESPACE
                   valueFrom:
                     fieldRef:
                       fieldPath: metadata.namespace
               envFrom:
                 - secretRef:
                     name: rhdh-rhoai-bridge-token
               image: quay.io/redhat-ai-dev/model-catalog-storage-rest@sha256:398095e7469e86d84b1196371286363f4b7668aa3e26370b4d78cb8d4ace1dc9
     
               imagePullPolicy: Always
               name: storage-rest
               volumeMounts:
                 - mountPath: /opt/app-root/src/dynamic-plugins-root
                   name: dynamic-plugins-root
                 workingDir: /opt/app-root/src
               - env:
                 - name: NORMALIZER_FORMAT
                   value: JsonArrayFormat
                 - name: POD_IP
                   valueFrom:
                     fieldRef:
                       fieldPath: status.podIP
                 - name: POD_NAMESPACE
                   valueFrom:
                     fieldRef:
                       fieldPath: metadata.namespace
               envFrom:
                 - secretRef:
                     name: rhdh-rhoai-bridge-token
               image: quay.io/redhat-ai-dev/model-catalog-rhoai-normalizer@sha256:fe6c05d57495d6217c4d584940ec552c3727847ff60f39f5d04f94be024576d8
     
               imagePullPolicy: Always
               name: rhoai-normalizer
               volumeMounts:
                 - mountPath: /opt/app-root/src/dynamic-plugins-root
                   name: dynamic-plugins-root
                 workingDir: /opt/app-root/src

5. Enable Connector in your RHDHapp-config.yaml file. In your Backstage `app-config.extra.yaml file, configure Entity Provider under the catalog.providers section:

   providers:
     modelCatalog:
       development:
         baseUrl: http://localhost:9090