-
Story
-
Resolution: Done
-
Critical
-
None
-
None
-
None
-
RHDHPAI Sprint 3271
Story (Required)
_As a Platform Engineer, I would like to have a way to generate the model catalog from a given input, using a formalized schema.
_
Background (Required)
As part of RHDHPAI-608, a schema for defining model catalogs will be defined using JSON Schema. As part of this issue, a basic generator library should use the JSON Schema to generate the model catalog entities, using the native Backstage catalog entities available to us (e.g. APIs, Components, Resources, Systems). This library will be used by the model catalog plugin to convert model catalog metadata sent from the Bridge into the catalog entities that the Backstage catalog expects.
The mapping of model / model server metadata to Backstage catalog entities can be found here: https://docs.google.com/document/d/1ArB8w-TawZ_DuMbZoukk4inVsAgqHntB8yN2lttwjyo/edit
Out of scope
- Techdocs integration (see
RHDHPAI-607)
Approach (Required)
The library should be written in Typescript (to allow for consumption within the RHDH model catalog plugin), and should pull in the native Backstage catalog types.
Dependencies
Acceptance Criteria (Required)
<Describe edge cases to consider when implementing the story and defining tests>
<Provides a required and minimum list of acceptance tests for this story. More is expected as the engineer implements this story>
documentation updates (design docs, release notes etc)
demo needed
SOP required
education module update (Filled by RHDHPAI team only)
R&D label required (Filled by RHDHPAI team only)
Done Checklist
Code is completed, reviewed, documented and checked in
Unit and integration test automation have been delivered and running cleanly in continuous integration/staging/canary environment
Continuous Delivery pipeline(s) is able to proceed with new code included
Customer facing documentation, API docs, design docs etc. are produced/updated, reviewed and published
Acceptance criteria are met
If the Grafana dashboard is updated, ensure the corresponding SOP is updated as well
- depends on
-
RHIDP-10623 Define a schema that can be used to generate model catalogs
-
- Closed
-
- is depended on by
-
RHIDP-10564 pivot from catalog-info.yaml to catalog jsonschema
-
- Closed
-