Uploaded image for project: 'Red Hat Internal Developer Platform'
  1. Red Hat Internal Developer Platform
  2. RHIDP-10594

Add API URL(s) annotations to model server entities within model catalog

    • DEVAI Sprint 3280

      Task Description (Required)

      In order to provide full support for using the model catalog to choose models within the software templates for creating AI applications, we need to provide an annotation that is set to the external URL endpoint (i.e. the Route URL if a Route was created with the Inference Service) if it exists, or the internal URL endpoint (i.e. the Service URL which will always exist for the Inference Service to access the tied model server. Though the external API endpoint is stored in the list of links the software templates has two problems with this approach:

      1. Backstage software templates have a technical limitation in that they can't filter by attribute, therefore if we want to parse from a list we would need to hardcode the index and guarantee that the value at that index will always be the API endpoint
      2. Not all external endpoints work with software templates, if in an environment that does not expect external connections (i.e. air gapped) the external endpoint may not be available or the SSL certificate will be self signed which would make it required to code the target application with dealing with it

      Having an annotation for the external (if it exists) and internal endpoint URL(s) outside a list would address both problems.  Specifying both will allow for flexibility with the templates as they evolve.  

      This will require both a change in the bridge to store the URLs in the json array model catalog server annotation map

      and a change in the plugin to copy those annotation k/v's to the component (and perhaps api) entity(ies).

      we'll go with rhdh.modelcatalog.io/internal-service-url and rhdh.modelcatalog.io/external-route-url

              gmontero@redhat.com Gabe Montero
              mvaldron Michael Valdron
              RHIDP - AI
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: