Skip to content

Conversation

@gabemontero
Copy link
Contributor

Update list of property overrides to describe how to change the rhdh.modelcatalog.io/model-name annotation on any Resource entities imported by the openshift ai connector

this doc update includes both

  • the updating the table with the set of override key/value pairs
  • the updating of the install yaml to use the version of the openshift-ai connector sidecar images with the code changes that allow this override

@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

@sonarqubecloud
Copy link

@gabemontero
Copy link
Contributor Author

to any reviewers, I don't seem to have permission to add labels per the PR instructions

@rhdh-bot
Copy link
Collaborator

@gabemontero
Copy link
Contributor Author

From the perview:
prop-table-update

@gabemontero
Copy link
Contributor Author

also
normalizer-image-update

Copy link
Member

@deerskindoll deerskindoll left a 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

Comment on lines +159 to 160
The {product-very-short} Pod requires two dynamic plugins.
.. In your {product-very-short} dynamic plugins ConfigMap, add the following code:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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:

Comment on lines +175 to 177
. 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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
. 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
|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.

Copy link
Member

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
|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.

@pabel-rh
Copy link
Member

@deerskindoll, thank you for reviewing this!

@deerskindoll
Copy link
Member

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants