-
Notifications
You must be signed in to change notification settings - Fork 59
RHDHBUGS-2501: openshift-ai connector allow for 'rhdh.modelcatalog.io/model-name' override #1683
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
…/model-name' override
|
|
to any reviewers, I don't seem to have permission to add labels per the PR instructions |
deerskindoll
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
a couple of suggestions
| The {product-very-short} Pod requires two dynamic plugins. | ||
| .. In your {product-very-short} dynamic plugins ConfigMap, add the following code: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| The {product-very-short} Pod requires two dynamic plugins. | |
| .. In your {product-very-short} dynamic plugins ConfigMap, add the following code: | |
| The {product-very-short} Pod requires two dynamic plugins. In your {product-very-short} dynamic plugins ConfigMap, add the following code: |
| . The system relies on three sidecar containers ({openshift-ai-connector-name}) running alongside the `backstage-backend` container. | ||
|
|
||
| Add these sidecar containers to your configuration referencing the `rhdh-rhoai-connector-token` Secret: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| . The system relies on three sidecar containers ({openshift-ai-connector-name}) running alongside the `backstage-backend` container. | |
| Add these sidecar containers to your configuration referencing the `rhdh-rhoai-connector-token` Secret: | |
| . The system relies on three sidecar containers ({openshift-ai-connector-name}) running alongside the `backstage-backend` container. Add these sidecar containers to your configuration referencing the `rhdh-rhoai-connector-token` Secret: |
|
|
||
| |`rhdh.modelcatalog.io/model-name` | ||
| |Annotations | ||
| |A key piece of metadata is the name of the model used when communicating with the model server's REST API. {openshift-ai-connector-name} stores this name in the `rhdh.modelcatalog.io/model-name` annotation on the `Resource` entity, and will default this annotation's value to the combined names of the `ResourceModel` and `ModelVersion` in the model registry, or the `KServe InferenceService` name if the model registry is not used, as those often line up with the model name used when communicating with the model server's REST API. But the names are not guaranteed to match. When the names do not match, provide the correct model name for model REST API invocations. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| |A key piece of metadata is the name of the model used when communicating with the model server's REST API. {openshift-ai-connector-name} stores this name in the `rhdh.modelcatalog.io/model-name` annotation on the `Resource` entity, and will default this annotation's value to the combined names of the `ResourceModel` and `ModelVersion` in the model registry, or the `KServe InferenceService` name if the model registry is not used, as those often line up with the model name used when communicating with the model server's REST API. But the names are not guaranteed to match. When the names do not match, provide the correct model name for model REST API invocations. | |
| |A name of the model used when communicating with the model server's REST API. {openshift-ai-connector-name} stores this name in the `rhdh.modelcatalog.io/model-name` annotation on the `Resource` entity, and defaults this annotation's value to the combined names of the `ResourceModel` and `ModelVersion` in the model registry. | |
| If the model registry is not used, the `KServe InferenceService` name becomes the default value instead, as it often is the same as the model name used when communicating with the model server's REST API. However, the names are not guaranteed to match. If the names do not match, provide the correct model name for model REST API invocations. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are a few extra spaces here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| |A key piece of metadata is the name of the model used when communicating with the model server's REST API. {openshift-ai-connector-name} stores this name in the `rhdh.modelcatalog.io/model-name` annotation on the `Resource` entity, and will default this annotation's value to the combined names of the `ResourceModel` and `ModelVersion` in the model registry, or the `KServe InferenceService` name if the model registry is not used, as those often line up with the model name used when communicating with the model server's REST API. But the names are not guaranteed to match. When the names do not match, provide the correct model name for model REST API invocations. | |
| |A name of the model used when communicating with the model server's REST API. {openshift-ai-connector-name} stores this name in the `rhdh.modelcatalog.io/model-name` annotation on the `Resource` entity, and defaults this annotation's value to the combined names of the `ResourceModel` and `ModelVersion` in the model registry. If the model registry is not used, the `KServe InferenceService` name becomes the default value instead, as it often is the same as the model name used when communicating with the model server's REST API. However, the names are not guaranteed to match. If the names do not match, provide the correct model name for model REST API invocations. |
|
@deerskindoll, thank you for reviewing this! |
you're welcome. feel free to add your suggestions since you were in touch with Gabe and know more about this than I do. |





Update list of property overrides to describe how to change the
rhdh.modelcatalog.io/model-nameannotation on anyResourceentities imported by the openshift ai connectorthis doc update includes both
@pabel-rh - this is the change we discussed in https://redhat-internal.slack.com/archives/C04CUSD4JSG/p1768421642057969
IMPORTANT: Do Not Merge - To be merged by Docs Team Only
Version(s):
1.9 for sure
1.8 if we are making any more 1.8 updates to https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.8/
Issue:
https://issues.redhat.com/browse/RHDHBUGS-2501
Preview:
Files changed:
modules/openshift-ai-connector-for-rhdh/proc-setting-up-openshift-ai-connector-for-rhdh-with-rhoai.adoc
modules/openshift-ai-connector-for-rhdh/ref-enrich-ai-model-metadata.adoc