Skip to content

Commit 8a7db05

Browse files
committed
Added links to RHOAI
1 parent eac66ba commit 8a7db05

7 files changed

+29
-25
lines changed

artifacts/attributes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,4 +178,4 @@
178178
:openshift-ai-connector-for-rhdh-title: Integrate {product} with {openshift-ai-connector-name} to leverage AI models
179179

180180
:openshift-ai-connector-name: OpenShift AI Connector for {product}
181-
:openshift-ai-connector-name-short: OpenShift AI Connector for {product-very-short}
181+
:openshift-ai-connector-name-short: OpenShift AI Connector for {product-very-short}

modules/openshift-ai-connector-for-rhdh/con-understand-how-ai-assets-map-to-rhdh-catalog.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,6 @@
55

66
include::{docdir}/artifacts/snip-developer-preview-rhoai.adoc[]
77

8-
The {openshift-ai-connector-name} ({openshift-ai-connector-name-short}) serves as a crucial link, enabling the discovery and accessibility of AI assets managed within the {rhoai-brand-name} offering directly within your {product-very-short} instance.
8+
The {openshift-ai-connector-name} ({openshift-ai-connector-name-short}) serves as a crucial link, enabling the discovery and accessibility of AI assets managed within the {rhoai-brand-name} offering directly within your {product-very-short} instance.
9+
10+
For more information on model registry components, see https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed/2.25/html/enabling_the_model_registry_component/overview-of-model-registries_model-registry-config[Overview of model registries and model catalog].

modules/openshift-ai-connector-for-rhdh/proc-setting-up-openshift-ai-connector-for-rhdh-with-rhoai.adoc

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,18 @@ The installation of the {openshift-ai-connector-name} requires manual updates to
77

88
.{rhoai-short} Prerequisites
99

10-
* To have Model Cards from the Model Catalog imported as TechDocs, you must use {rhoai-short} version 2.25 or later, and the *Model Catalog* dashboard and a Model Registry need to be enabled (they are both disabled by default).
11-
* If you employed Model Catalog at earlier versions of {rhoai-short}, Tech Doc propagation does not work for any models you registered into the Model Registry while at those earlier versions; only models registered into Model Registry from a 2.25 (or later) Model Catalog have their Model Cards transferred to {product-very-short} as TechDocs.
12-
* For the rest of the features, version 2.20 or later suffices. Enabling Model Registry and its associated dashboard allows for a user experience that more directly allows for customizing AI Model metadata.
10+
* To import model cards from the model catalog as TechDocs, you must use {rhoai-short} version 2.25 or later, and you must ensure that the model registry component is enabled.
1311

14-
//connect with Lindsey to update the above prereqs
12+
* If you employed model catalog at earlier versions of {rhoai-short}, TechDocs propagation does not work for any models you registered into the model registry while at those earlier versions; only models registered into model registry from a 2.25 (or later) model catalog have their model cards transferred to {product-very-short} as TechDocs.
13+
14+
* For the rest of the features, version 2.20 or later suffices. Enabling model registry and its associated dashboard allows for a user experience that more directly allows for customizing AI Model metadata.
15+
16+
For more details, see link:https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed/2.25/html-single/enabling_the_model_registry_component/index[Enabling the model registry component].
1517

1618
.Procedure
1719

1820
. Configure {rhoai-short}-related RBAC and credentials.
19-
A Kubernetes `ServiceAccount` and a `service-account-token` Secret are required for the connector to retrieve data from {rhoai-short}. The following resources must be created, replacing namespace names (`ai-rhdh` for {product-very-short}, `rhoai-model-registries` for {rhoa``}) as needed:
21+
A Kubernetes `ServiceAccount` and a `service-account-token` Secret are required for the connector to retrieve data from {rhoai-short}. The following resources must be created, replacing namespace names (`ai-rhdh` for {product-very-short}, `rhoai-model-registries` for {rhoai-short}) as needed:
2022
** `ServiceAccount` (`rhdh-rhoai-bridge`)
2123
** `ClusterRole` and `ClusterRoleBinding` (`rhdh-rhoai-bridge`) to allow access to OCP resources like `routes`, `services`, and `inferenceservices`.
2224
** `Role` and `RoleBinding` to allow ConfigMap updates within the {product-very-short} namespace.

modules/openshift-ai-connector-for-rhdh/proc-troubleshooting-connector-functionality.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55

66
The connector system consists of the two dynamic plugins and the three Model Catalog Bridge sidecar containers. Generally speaking, the logs collected should be provided to {company-name} Support for analysis.
77

8+
The actual contents of the diagnostic data are not part of any product guaranteed specification, and can change at any time.
9+
810
== Checking Dynamic Plugins status
911

1012
Validate that the dynamic plugins have been successfully installed into your {product-very-short} project Pod by using the following command:

modules/openshift-ai-connector-for-rhdh/ref-model-to-entity-mapping.adoc

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,32 +3,30 @@
33
[id="ref-model-to-entity-mapping_{context}"]
44
= Model-to-Entity mapping
55

6-
This offering interfaces with the {openshift-ai-connector-name-short}, Model Catalog, and KServe-based Model Deployments (InferenceServices) to create familiar {backstage} entities.
6+
This offering interfaces with the {openshift-ai-connector-name-short}, model catalog, and KServe-based Model Deployments (InferenceServices) to create familiar {backstage} entities.
77

88
|===
99
|{rhoai-short} Artifact |{product-very-short}/{backstage} Entity Kind |{product-very-short}/{backstage} Entity Type |Purpose
1010

1111
|Model Server (InferenceService)
1212
|Component
1313
|`model-server`
14-
|Represents a running, accessible AI model endpoint. //Requires RHOAI 2.20 or later to obtain this mapping.
14+
|Represents a running, accessible AI model endpoint. See https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed/2.25/html/configuring_your_model-serving_platform/index[Configuring your model-serving platform].
1515

1616
|AI Model (Model Registry Version)
1717
|Resource
1818
|`ai-model`
19-
|Represents the specific AI model artifact (e.g., Llama-3-8B). Requires RHOAI 2.20 or later to obtain this mapping.
19+
|Represents the specific AI model artifact, for example, `Llama-3-8B`.
2020

2121
|Model Server API Details
2222
|API
2323
|`openapi` (Default)
24-
|Provides the OpenAPI/Swagger specification for the model's REST endpoint. Requires RHOAI 2.20 or later to obtain this mapping.
24+
|Provides the OpenAPI/Swagger specification for the REST endpoint of the model. See https://access.redhat.com/articles/7047935[Red Hat OpenShifT AI: API Tiers]
2525

2626
|Model Cards
2727
|TechDocs
2828
|N/A
29-
|Model Cards from the {rhoai-short} Model Catalog are associated with the Component and Resource entities. Requires RHOAI 2.25 to obtain this mapping.
29+
|Model cards from the {rhoai-short} model catalog are associated with the Component and Resource entities. See https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed/2.25/html/working_with_the_model_catalog/registering-a-model-from-the-model-catalog_working-model-catalog[Registering a model from the model catalog].
3030
|===
3131

32-
Once the {openshift-ai-connector-name-short} is installed and connected with {rhoai-short}, the transfer of information commences automatically.
33-
34-
//To connect with Lindsey to update links here
32+
Once the {openshift-ai-connector-name-short} is installed and connected with {rhoai-short}, the transfer of information commences automatically.

modules/openshift-ai-connector-for-rhdh/ref-openshift-ai-model-registry-and-model-catalog-queries.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,46 @@
11
:_mod-docs-content-type: REFERENCE
22

33
[id="ref-openshift-ai-model-registry-and-model-catalog-queries_{context}"]
4-
= OpenShift AI Model Registry and Model Catalog queries
4+
= OpenShift AI model registry and model catalog queries
55

6-
To access the same {rhoai-short} data as the connector, use `curl` to query the {rhoai-short} Model Registry and Model Catalog APIs, ensuring the ServiceAccount token has correct access control:
6+
To access the same {rhoai-short} data as the connector, use `curl` to query the {rhoai-short} model registry and model catalog APIs, ensuring the `ServiceAccount` token has correct access control:
77

8-
* Example: Fetch Registered Models
8+
* Example: Fetch registered models
99
+
1010
[source,bash]
1111
----
1212
curl -k -H "Authorization: Bearer $TOKEN" $RHOAI_MODEL_REGISTRY_URL/api/model_registry/v1alpha3/registered_models | jq
1313
----
1414

15-
* Example: Fetch Model Versions
15+
* Example: Fetch model versions
1616
+
1717
[source,bash]
1818
----
1919
curl -k -H "Authorization: Bearer $TOKEN" $RHOAI_MODEL_REGISTRY_URL/api/model_registry/v1alpha3/model_versions | jq
2020
----
2121

22-
* Example: Fetch Model Artifacts
22+
* Example: Fetch model artifacts
2323
+
2424
[source,bash]
2525
----
2626
curl -k -H "Authorization: Bearer $TOKEN" $RHOAI_MODEL_REGISTRY_URL/api/model_registry/v1alpha3/model_artifacts | jq
2727
----
2828

29-
* Example: Fetch Inference Services
29+
* Example: Fetch inference services
3030
+
3131
[source,bash]
3232
----
3333
curl -k -H "Authorization: Bearer $TOKEN" $RHOAI_MODEL_REGISTRY_URL/api/model_registry/v1alpha3/inference_services | jq
3434
----
3535

36-
* Example: Fetch Serving Environments
36+
* Example: Fetch serving environments
3737
+
3838
[source,bash]
3939
----
4040
curl -k -H "Authorization: Bearer $TOKEN" $RHOAI_MODEL_REGISTRY_URL/api/model_registry/v1alpha3/serving_environments | jq
4141
----
4242

43-
* Example: Fetch Catalog Sources
43+
* Example: Fetch catalog sources
4444
+
4545
[source,bash]
4646
----

modules/openshift-ai-connector-for-rhdh/ref-out-of-the-box-details-from-rhoai.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ The connector propagates the following key data:
99
** URL of the OpenShift Route (if exposed).
1010
** URL of the Kubernetes Service.
1111
** Authentication requirement status.
12-
* Model Registry (Resource type `ai-model`):
12+
* Model registry (Resource type `ai-model`):
1313
** Model description, artifact URIs, and author/owner information.
14-
* Model Catalog:
14+
* Model catalog:
1515
** Links to the Model Card (as {product-very-short} TechDocs).
1616
** Model license URL.

0 commit comments

Comments
 (0)