Merge pull request redhat-developer#2 from johnmcollier/entityproviderusebridge

RHDHPAI-505: Switch the entity provider to the model catalog bridge

Author: johnmcollier

workspaces/rhdh-ai/README.md

@@ -19,6 +19,12 @@ yarn backstage-repo-tools knip-reports
 
 To run the rhdh-ai backend module in development mode:
 
-1. Run `yarn install` to install dependencies
+1. Ensure the following environment variables are set:
 
-2. Run `yarn dev` to launch the module
+- `RHDH_AI_BRIDGE_SERVER`: Set to the server hosting the RHDH AI Bridge
+- `RHDH_BRIDGE_HOST`: Similar as above, but without the protocol
+- `RHDH_TOKEN`: Any 8 character password to use for authentication with RHDH
+
+2. Run `yarn install` to install dependencies
+
+3. Run `yarn dev` to launch the module

workspaces/rhdh-ai/app-config.yaml

@@ -91,6 +91,5 @@ catalog:
   providers:
     modelCatalog:
       ollama:
-        baseUrl: '${RHDH_AI_MODEL_SERVER}'
-        authorization: '${RHDH_AI_AUTH_TOKEN}'
+        baseUrl: '${RHDH_AI_BRIDGE_SERVER}'
         name: 'Ollama Model Service'

workspaces/rhdh-ai/plugins/catalog-backend-module-rhdh-ai/config.d.ts

@@ -24,8 +24,6 @@ export interface Config {
            * ModelCatalogConfig
            */
           baseUrl: string;
-          /** @visibility secret */
-          authorization: string;
           name?: string;
           system?: string;
           owner?: string;

workspaces/rhdh-ai/plugins/catalog-backend-module-rhdh-ai/package.json

@@ -28,7 +28,8 @@
     "@backstage/catalog-model": "^1.7.2",
     "@backstage/errors": "^1.2.7",
     "@backstage/plugin-catalog-common": "^1.1.3",
-    "@backstage/plugin-catalog-node": "^1.15.1"
+    "@backstage/plugin-catalog-node": "^1.15.1",
+    "yaml": "^2.7.0"
   },
   "devDependencies": {
     "@backstage/backend-test-utils": "^1.2.1",

…i/src/clients/OpenAIResourceConnector.ts …i/src/clients/BridgeResourceConnector.tsworkspaces/rhdh-ai/plugins/catalog-backend-module-rhdh-ai/src/clients/OpenAIResourceConnector.ts renamed to workspaces/rhdh-ai/plugins/catalog-backend-module-rhdh-ai/src/clients/BridgeResourceConnector.ts workspaces/rhdh-ai/plugins/catalog-backend-module-rhdh-ai/src/clients/OpenAIResourceConnector.ts renamed to workspaces/rhdh-ai/plugins/catalog-backend-module-rhdh-ai/src/clients/BridgeResourceConnector.ts

@@ -13,8 +13,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { ModelList } from './types';
+import { Entity } from '@backstage/catalog-model';
 
+import YAML from 'yaml';
+
+// listModels will list the models from an OpenAI compatible endpoint
+/*
 export async function listModels(
   baseUrl: string,
   access_token: string,
@@ -33,4 +37,23 @@ export async function listModels(
 
   const data = await res.json();
   return data;
+}*/
+
+export async function fetchCatalogEntities(baseUrl: string): Promise<Entity[]> {
+  // ToDo: Discover catalog-info endpoint?
+  const res = await fetch(`${baseUrl}/mnist/v1/catalog-info.yaml`, {
+    method: 'GET',
+  });
+
+  if (!res.ok) {
+    throw new Error(res.statusText);
+  }
+
+  // ToDo: Look at seeing if we can use the parser provided by the CatalogProcessorProvider package
+  const data = await res
+    .blob()
+    .then(blob => blob.text())
+    .then(yamlStr => YAML.parseAllDocuments(yamlStr))
+    .then(yamlData => yamlData.map(item => item.toJS()));
+  return data;
 }

workspaces/rhdh-ai/plugins/catalog-backend-module-rhdh-ai/src/clients/index.ts

@@ -13,4 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export * from './OpenAIResourceConnector';
+export * from './BridgeResourceConnector';

workspaces/rhdh-ai/plugins/catalog-backend-module-rhdh-ai/src/providers/ModelCatalogResourceEntityProvider.ts

@@ -18,19 +18,15 @@ import type {
   SchedulerService,
   SchedulerServiceTaskRunner,
 } from '@backstage/backend-plugin-api';
-import {
-  ANNOTATION_LOCATION,
-  ANNOTATION_ORIGIN_LOCATION,
-  ComponentEntity,
-  Entity,
-  ResourceEntity,
-} from '@backstage/catalog-model';
 import {
   EntityProvider,
   EntityProviderConnection,
 } from '@backstage/plugin-catalog-node';
-import { listModels } from '../clients/OpenAIResourceConnector';
-import type { ModelList } from '../clients/types';
+import {
+  ANNOTATION_LOCATION,
+  ANNOTATION_ORIGIN_LOCATION,
+} from '@backstage/catalog-model';
+import { fetchCatalogEntities } from '../clients/BridgeResourceConnector';
 import { ModelCatalogConfig } from './types';
 import { readModelCatalogApiEntityConfigs } from './config';
 import type { Config } from '@backstage/config';
@@ -41,10 +37,6 @@ import { InputError, isError } from '@backstage/errors';
 export class ModelCatalogResourceEntityProvider implements EntityProvider {
   private readonly env: string;
   private readonly baseUrl: string;
-  private readonly authorization: string;
-  private readonly name: string;
-  private readonly owner: string;
-  private readonly system: string;
   private readonly logger: LoggerService;
   private readonly scheduleFn: () => Promise<void>;
   private connection?: EntityProviderConnection;
@@ -91,10 +83,6 @@ export class ModelCatalogResourceEntityProvider implements EntityProvider {
   ) {
     this.env = config.id;
     this.baseUrl = config.baseUrl;
-    this.authorization = config.authorization;
-    this.name = config.name;
-    this.owner = config.owner;
-    this.system = config.system ?? '';
     this.logger = logger.child({
       target: this.getProviderName(),
     });
@@ -152,10 +140,24 @@ export class ModelCatalogResourceEntityProvider implements EntityProvider {
     this.logger.info(
       `Discovering ResourceEntities from Model Server ${this.baseUrl}`,
     );
-    const modelList = await listModels(this.baseUrl, this.authorization);
 
     /** [5]: Convert the fetched model and model server data into RHDH catalog entities */
-    const modelServerName: string = this.convertModeServerName(this.name);
+    const entityList = await fetchCatalogEntities(this.baseUrl);
+    entityList.forEach(entity => {
+      if (entity.metadata.annotations === undefined) {
+        entity.metadata.annotations = {
+          [ANNOTATION_LOCATION]: this.getProviderName(),
+          [ANNOTATION_ORIGIN_LOCATION]: this.getProviderName(),
+        };
+      } else {
+        entity.metadata.annotations[ANNOTATION_LOCATION] =
+          this.getProviderName();
+        entity.metadata.annotations[ANNOTATION_ORIGIN_LOCATION] =
+          this.getProviderName();
+      }
+    });
+
+    /* const modelServerName: string = this.convertModeServerName(this.name);
     let entities: Entity[] = [];
     const modelServerEntity: ComponentEntity =
       this.buildComponentEntityFromModelEndpoint(modelServerName);
@@ -166,14 +168,14 @@ export class ModelCatalogResourceEntityProvider implements EntityProvider {
     /** [6]: Add/update the catalog entities that correspond to the models */
     await this.connection.applyMutation({
       type: 'full',
-      entities: entities.map(entity => ({
+      entities: entityList.map(entity => ({
         entity,
         locationKey: this.getProviderName(),
       })),
     });
   }
 
-  private convertModelNameToEntityName(modelName: string): string {
+  /* private convertModelNameToEntityName(modelName: string): string {
     return modelName.replaceAll(/\:/g, '-');
   }
 
@@ -245,5 +247,5 @@ export class ModelCatalogResourceEntityProvider implements EntityProvider {
     };
 
     return modelServerComponent;
-  }
+  }*/
 }

workspaces/rhdh-ai/plugins/catalog-backend-module-rhdh-ai/src/providers/config.ts

@@ -39,10 +39,6 @@ function readModelCatalogApiEntityConfig(
   config: Config,
 ): ModelCatalogConfig {
   const baseUrl = config.getString('baseUrl');
-  const authorization = config.getString('authorization');
-  const name = config.getString('name');
-  const system = config.getOptionalString('system');
-  const owner = config.getOptionalString('owner') ?? 'unknown';
 
   const schedule = config.has('schedule')
     ? readSchedulerServiceTaskScheduleDefinitionFromConfig(
@@ -53,10 +49,6 @@ function readModelCatalogApiEntityConfig(
   return {
     id,
     baseUrl,
-    authorization,
-    name,
-    system,
-    owner,
     schedule,
   };
 }

workspaces/rhdh-ai/plugins/catalog-backend-module-rhdh-ai/src/providers/types.ts

@@ -18,9 +18,5 @@ import type { SchedulerServiceTaskScheduleDefinition } from '@backstage/backend-
 export type ModelCatalogConfig = {
   id: string;
   baseUrl: string;
-  authorization: string;
-  name: string;
-  owner: string;
-  system?: string;
   schedule?: SchedulerServiceTaskScheduleDefinition;
 };

workspaces/rhdh-ai/yarn.lock

@@ -10177,6 +10177,7 @@ __metadata:
     "@backstage/errors": ^1.2.7
     "@backstage/plugin-catalog-common": ^1.1.3
     "@backstage/plugin-catalog-node": ^1.15.1
+    yaml: ^2.7.0
   languageName: unknown
   linkType: soft
 
@@ -34105,7 +34106,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"yaml@npm:^2.0.0, yaml@npm:^2.0.0-10, yaml@npm:^2.2.1, yaml@npm:^2.2.2":
+"yaml@npm:^2.0.0, yaml@npm:^2.0.0-10, yaml@npm:^2.2.1, yaml@npm:^2.2.2, yaml@npm:^2.7.0":
   version: 2.7.0
   resolution: "yaml@npm:2.7.0"
   bin: