diff --git a/artifacts/attributes.adoc b/artifacts/attributes.adoc index 37fa9224b2b..25226b8bb8a 100644 --- a/artifacts/attributes.adoc +++ b/artifacts/attributes.adoc @@ -187,7 +187,7 @@ :release-notes-book-title: {product} release notes :release-notes-category-link: {product-docs-link}/#Release Notes :rhbk-docs-link: link:https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/{keycloak-version} -:rhoai-docs-link: link:https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed/2.25/html-single +:rhoai-docs-link: link:https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed/3.4/html-single :rhoserverless-link: link:https://docs.redhat.com/en/documentation/red_hat_openshift_serverless/{rhoserverless-version-major} :scorecard-plugin-book-link: {product-docs-link}/html-single/evaluate_project_health_using_scorecards/index :scorecard-plugin-book-title: Evaluate project health using Scorecards diff --git a/modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/con-understand-how-ai-assets-map-to-the-rhdh-catalog.adoc b/modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/con-understand-how-ai-assets-map-to-the-rhdh-catalog.adoc index 5bc2961675d..532e677b118 100644 --- a/modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/con-understand-how-ai-assets-map-to-the-rhdh-catalog.adoc +++ b/modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/con-understand-how-ai-assets-map-to-the-rhdh-catalog.adoc @@ -6,6 +6,6 @@ include::{docdir}/artifacts/snip-developer-preview-rhoai.adoc[] [role="_abstract"] -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. +The {openshift-ai-connector-name} ({openshift-ai-connector-name-short}) discovers AI assets managed within {rhoai-brand-name}. The connector automatically converts AI models and model servers into {backstage} entities to provide a unified view for developer teams. -For more information on model registry components, see {rhoai-docs-link}/enabling_the_model_registry_component/index#overview-of-model-registries_model-registry-config[Overview of model registries and model catalog]. \ No newline at end of file +For more information on model registry components, see {rhoai-docs-link}/managing_model_registries/index#overview-of-model-registries_managing-model-registries[Overview of model registries and model catalog]. \ No newline at end of file diff --git a/modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/proc-set-up-with.adoc b/modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/proc-set-up-with.adoc index dfcf9dff987..1665c7b9c3d 100644 --- a/modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/proc-set-up-with.adoc +++ b/modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/proc-set-up-with.adoc @@ -4,7 +4,7 @@ = Set up {openshift-ai-connector-name} with {rhoai-brand-name} [role="_abstract"] -The installation of the {openshift-ai-connector-name} requires manual updates to {product-very-short}-related Kubernetes resources. +To install the {openshift-ai-connector-name}, you must manually update your {product-very-short}-related Kubernetes resources. include::{docdir}/artifacts/snip-developer-preview-rhoai.adoc[] @@ -22,7 +22,7 @@ If you upgraded to {rhoai-short} 2.25 from an earlier version, you must manually * 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. For best overall experience, {rhoai-short} 2.25 is recommended. -For more details, see {rhoai-docs-link}/enabling_the_model_registry_component/index[Enabling the model registry component]. +For more details, see {rhoai-docs-link}/managing_model_registries/index#enabling-the-model-registry-component_managing-model-registries[Enabling the model registry component]. .Procedure @@ -168,9 +168,9 @@ The {product-very-short} Pod requires two dynamic plugins. ---- plugins: - disabled: false - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-catalog-backend-module-model-catalog:bs_1.42.5__0.7.0 + package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-catalog-backend-module-model-catalog:bs_1.49.4__0.9.0 - disabled: false - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-catalog-techdoc-url-reader-backend:bs_1.42.5__0.3.0 + package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-catalog-techdoc-url-reader-backend:bs_1.49.4__0.5.0 ---- . Add the `Connector` sidecar containers to the {product-very-short} Pod. @@ -234,7 +234,7 @@ spec: envFrom: - secretRef: name: rhdh-rhoai-connector-token - image: quay.io/redhat-ai-dev/model-catalog-storage-rest@sha256:398095e7469e86d84b1196371286363f4b7668aa3e26370b4d78cb8d4ace1dc9 + image: quay.io/redhat-ai-dev/model-catalog-storage-rest@sha256:609f6866c7913a87c51912260803c219e564fa7dc90c2ff735ff6dfc5797bc3b imagePullPolicy: Always name: storage-rest volumeMounts: diff --git a/modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/ref-enrich-ai-model-metadata-for-enhanced-rhdh-experience.adoc b/modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/ref-enrich-ai-model-metadata-for-enhanced-rhdh-experience.adoc index 9a7aace8ad0..c19fd84757a 100644 --- a/modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/ref-enrich-ai-model-metadata-for-enhanced-rhdh-experience.adoc +++ b/modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/ref-enrich-ai-model-metadata-for-enhanced-rhdh-experience.adoc @@ -21,11 +21,11 @@ For more details, see {rhoai-docs-link}/working_with_model_registries/index#edit |`TechDocs` |TechDocs -|URL pointing to a Git repository that follows {product-very-short} TechDocs conventions for the Model Card. Use this setting only if the *Model Card to TechDocs* mapping is not active. +|URL pointing to a Git repository that follows {product-very-short} TechDocs conventions for the Model Card. Use this setting only if the *Model Card to TechDocs* mapping is inactive. |`Homepage URL` |Links -|A URL considered the home page for the model. +|The home page URL for the model. |`Owner` |Owner @@ -33,7 +33,7 @@ For more details, see {rhoai-docs-link}/working_with_model_registries/index#edit |`Lifecycle` |Lifecycle -|Serves a means to express the lifecycle concept of {product-very-short}/{backstage}. +|Expresses the lifecycle concept of {product-very-short}/{backstage}. |`How to use` |Links diff --git a/modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/ref-model-to-entity-mapping.adoc b/modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/ref-model-to-entity-mapping.adoc index fd61e729e8c..a6fcafb52c2 100644 --- a/modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/ref-model-to-entity-mapping.adoc +++ b/modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/ref-model-to-entity-mapping.adoc @@ -4,9 +4,7 @@ = Model-to-Entity mapping [role="_abstract"] -The {openshift-ai-connector-name-short} automatically converts AI/ML artifacts into {backstage} entities, providing a unified view of your available AI models to your developer teams. - -The following table describes how {rhoai-short} artifacts map to {backstage} entity kinds. +The following table maps {rhoai-short} components to {backstage} entity kinds. |=== |{rhoai-short} Artifact |{product-very-short}/{backstage} Entity Kind |{product-very-short}/{backstage} Entity Type |Purpose @@ -29,7 +27,7 @@ The following table describes how {rhoai-short} artifacts map to {backstage} ent |Model Cards |TechDocs |N/A -|Model cards from the {rhoai-short} model catalog are associated with the Component and Resource entities. See {rhoai-docs-link}/working_with_the_model_catalog/registering-a-model-from-the-model-catalog_working-model-catalog#registering-a-model-from-the-model-catalog_working-model-catalog[Registering a model from the model catalog]. +|Associates model cards from the {rhoai-short} model catalog with the Resource entities. See {rhoai-docs-link}/working_with_the_model_catalog/registering-a-model-from-the-model-catalog_working-model-catalog#registering-a-model-from-the-model-catalog_working-model-catalog[Registering a model from the model catalog]. |=== Once the {openshift-ai-connector-name-short} is installed and connected with {rhoai-short}, the transfer of information commences automatically. \ No newline at end of file diff --git a/modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/ref-out-of-the-box-as-asset-details-synched-from.adoc b/modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/ref-out-of-the-box-as-asset-details-synched-from.adoc index 0e0029846f2..3ac6fcd2143 100644 --- a/modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/ref-out-of-the-box-as-asset-details-synched-from.adoc +++ b/modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/ref-out-of-the-box-as-asset-details-synched-from.adoc @@ -11,7 +11,7 @@ Review the key data that the connector automatically propagates from {rhoai-shor ** URL of the Kubernetes Service. ** Authentication requirement status. * Model registry (Resource type `ai-model`): -** Model description, artifact URIs, and author/owner information. +** Model description, asset URIs, and author or owner information. * Model catalog: ** Links to the Model Card (as {product-very-short} TechDocs). ** Model license URL. \ No newline at end of file diff --git a/modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/ref-troubleshooting-connector-functionality.adoc b/modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/ref-troubleshoot-connector-functionality.adoc similarity index 91% rename from modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/ref-troubleshooting-connector-functionality.adoc rename to modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/ref-troubleshoot-connector-functionality.adoc index d2fb7675766..6d59d8bed4a 100644 --- a/modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/ref-troubleshooting-connector-functionality.adoc +++ b/modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/ref-troubleshoot-connector-functionality.adoc @@ -1,10 +1,10 @@ :_mod-docs-content-type: REFERENCE -[id="troubleshooting-connector-functionality_{context}"] -= Troubleshooting Connector functionality +[id="troubleshoot-connector-functionality_{context}"] += Troubleshoot Connector functionality [role="_abstract"] -The connector system consists of the two dynamic plugins and the three {openshift-ai-connector-name-short} sidecar containers. Generally speaking, the logs collected must be provided to {company-name} Support for analysis. +The connector system consists of the two dynamic plugins and the three {openshift-ai-connector-name-short} sidecar containers. You must gather logs from these components and provide them to {company-name} Support for diagnostic analysis. The actual contents of the diagnostic data are not part of any product guaranteed specification, and can change at any time. diff --git a/titles/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/master.adoc b/titles/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/master.adoc index 31836f29b39..d75e2d9f0c4 100644 --- a/titles/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/master.adoc +++ b/titles/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/master.adoc @@ -26,6 +26,6 @@ include::modules/integrate_accelerating-ai-development-with-openshift-ai-connect include::modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/proc-populate-the-api-definition-tab-in-rhdh-api-entities.adoc[leveloffset=+2] -include::modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/ref-troubleshooting-connector-functionality.adoc[leveloffset=+1] +include::modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/ref-troubleshoot-connector-functionality.adoc[leveloffset=+1] include::modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/ref-model-registry-and-model-catalog-queries.adoc[leveloffset=+2]