Merge branch 'main' into RHIDP-7564-1

Author: Gerry-Forde

artifacts/attributes.adoc

@@ -65,6 +65,7 @@
 :rhdeveloper-name: Red Hat Developer
 :rhel: Red Hat Enterprise Linux
 :rhoai-brand-name: Red Hat OpenShift AI
+:rhoai-short: RHOAI
 :rhoserverless-brand-name: Red Hat OpenShift Serverless
 :rhsso-brand-name: Red Hat Single-Sign On
 :rhsso: RHSSO
@@ -171,8 +172,16 @@
 :plugin-type-name: custom
 :plugin-type-name-uppercase: Custom
 
+
 :scorecard-plugin-book-link: {product-docs-link}/html-single/understand_and_visualize_red_hat_developer_hub_project_health_using_scorecards/index
 :scorecard-plugin-book-title: Understand and visualize {product} project health using Scorecards
 
 :model-context-protocol-link: {product-docs-link}/html-single/interacting_with_model_context_protocol_tools_for_red_hat_developer_hub/index
 :model-context-protocol-title: Interacting with Model Context Protocol tools for {product}
+
+:openshift-ai-connector-for-rhdh-link: {product-docs-link}/html-single/accelerate_ai_development_with_openshift_ai_connector_for_red_hat_developer_hub/index
+
+:openshift-ai-connector-name: OpenShift AI Connector for {product}
+:openshift-ai-connector-name-short: OpenShift AI Connector for {product-very-short}
+
+:rhoai-docs-link: link:https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed/2.25/html-single

artifacts/snip-developer-preview-rhoai.adoc

@@ -0,0 +1,6 @@
+[IMPORTANT]
+====
+This section describes Developer Preview features in the {openshift-ai-connector-name} plugin. Developer Preview features are not supported by Red Hat in any way and are not functionally complete or production-ready. Do not use Developer Preview features for production or business-critical workloads. Developer Preview features provide early access to functionality in advance of possible inclusion in a Red Hat product offering. Customers can use these features to test functionality and provide feedback during the development process. Developer Preview features might not have any documentation, are subject to change or removal at any time, and have received limited testing. Red Hat might provide ways to submit feedback on Developer Preview features without an associated SLA.
+
+For more information about the support scope of Red Hat Developer Preview features, see https://access.redhat.com/support/offerings/devpreview/[Developer Preview Support Scope].
+====

assemblies/assembly-configuring-rhdh-events-module.adoc

@@ -0,0 +1,17 @@
+:_mod-docs-content-type: ASSEMBLY
+
+[id="configuring-rhdh-events-module"]
+
+= Configuring {product} Events Module
+
+Use the Events Module together with scheduled updates to make sure your GitHub user or catalog entities are updated whenever changes occur in the external system.
+This is a Developer Preview feature.
+
+[IMPORTANT]
+====
+Developer Preview features are not supported by Red Hat in any way and are not functionally complete or production-ready. Do not use Developer Preview features for production or business-critical workloads. Developer Preview features provide early access to functionality in advance of possible inclusion in a Red Hat product offering. Customers can use these features to test functionality and provide feedback during the development process. Developer Preview features might not have any documentation, are subject to change or removal at any time, and have received limited testing. Red Hat might provide ways to submit feedback on Developer Preview features without an associated SLA.
+
+For more information about the support scope of Red Hat Developer Preview features, see link:https://access.redhat.com/support/offerings/devpreview/[Developer Preview Support Scope].
+====
+
+include::modules/dynamic-plugins/proc-configuring-events-module-for-github.adoc[leveloffset=+1]

assemblies/dynamic-plugins/assembly-configuring-rhdh-plugins.adoc

@@ -34,5 +34,8 @@ include::../assembly-using-servicenow.adoc[leveloffset=+1]
 // Kubernetes Custom Actions
 include::../assembly-using-kubernetes-custom-actions.adoc[leveloffset=+1]
 
+// Events Module
+include::../assembly-configuring-rhdh-events-module.adoc[leveloffset=+1]
+
 // Overriding Core Backend Service Configuration
 include::../modules/dynamic-plugins/proc-overriding-core-backend-services.adoc[leveloffset=+1]

modules/dynamic-plugins/proc-configuring-events-module-for-github.adoc

@@ -0,0 +1,88 @@
+:_mod-docs-content-type: PROCEDURE
+
+[id="proc-configuring-events-module-for-github"]
+
+= Configuring Events Module for GitHub
+
+Learn how to configure Events Module for use with the {product-very-short} GitHub Discovery feature and GitHub organization data.
+This is a Developer Preview feature.
+
+[IMPORTANT]
+====
+Developer Preview features are not supported by Red Hat in any way and are not functionally complete or production-ready. Do not use Developer Preview features for production or business-critical workloads. Developer Preview features provide early access to functionality in advance of possible inclusion in a Red Hat product offering. Customers can use these features to test functionality and provide feedback during the development process. Developer Preview features might not have any documentation, are subject to change or removal at any time, and have received limited testing. Red Hat might provide ways to submit feedback on Developer Preview features without an associated SLA.
+
+For more information about the support scope of Red Hat Developer Preview features, see link:https://access.redhat.com/support/offerings/devpreview/[Developer Preview Support Scope].
+====
+
+.Prerequisites
+* You have added your GitHub integration credentials in the `{my-app-config-file}` file.
+* You have defined the `schedule.frequency` in the `{my-app-config-file}` file as longer time period, such as 24 hours.
+* For GitHub Discovery only: You have enabled {product-docs-link}/html-single/integrating_red_hat_developer_hub_with_github/index#enabling-github-repository-discovery[GitHub Discovery].
+* For GitHub Organizational Data only: You have enabled {product-docs-link}/html-single/authentication_in_red_hat_developer_hub/index#enabling-user-authentication-with-github[Github Authentication with user ingestion].
+
+.Procedure
+. Add the GitHub Events Module to your `dynamic-plugins.yaml` configuration file as follows:
++
+[source,yaml]
+----
+data:
+dynamic-plugins.yaml: |
+includes:
+- dynamic-plugins.default.yaml
+plugins:
+- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-plugin-events-backend-module-github:bs_1.42.5__0.4.3!backstage-plugin-events-backend-module-github
+disabled: false
+----
+. To create HTTP endpoints to receive events for the `github`, add the following to your `{my-app-config-file}` file:
++
+[source,yaml]
+----
+events:
+  http:
+   topics:
+    - github
+  modules:
+    github:
+      webhookSecret: ${GITHUB_WEBHOOK_SECRET}
+----
++
+[IMPORTANT]
+====
+Secure your workflow by adding a webhook secret token to link:https://docs.github.com/en/webhooks/using-webhooks/validating-webhook-deliveries[validate webhook deliveries].
+====
+. Create a link:https://docs.github.com/en/webhooks/using-webhooks/creating-webhooks[GitHub webhook] with the following specifications:
+** *For Github Discovery Events*: push, repository
+** *For Github Organizational Data Events*: organization, team and membership
+** *Content Type*: application/json
+** *Payload URL*: https://<your_instance_name>/api/events/http/github
++
+[NOTE]
+====
+*Payload URL* is the URL exposed after configuring the HTTP endpoint.
+====
+
+.Verification
+* Check the log for an entry that confirms that http endpoint was set up successfully to receive events from the GitHub webhook.
++
+Example of a log of successfully set up http endpoint::
++
+[source,code]
+----
+{"level":"\u001b[32minfo\u001b[39m","message":"Registered /api/events/http/github to receive events","plugin":"events","service":"backstage","timestamp":"2025-11-03 02:19:12"}
+----
+* For GitHub Discovery only:
+** Trigger a GitHub push event by adding,
+modifying or deleting the  `catalog-info.yaml` file in the repository where you set up your webhook.
+A record of this event should appear in the pod logs of your {product-very-short} instance.
++
+Example of a log with changes to `catalog-info.yaml` file::
++
+[source,code]
+----
+{"level":"\u001b[32minfo\u001b[39m","message":"Processed Github push event: added 0 - removed 0 - modified 1","plugin":"catalog","service":"backstage","span_id":"47534b96c4afc654","target":"github-provider:providerId","timestamp":"2025-06-15 21:33:14","trace_flags":"01","trace_id":"ecc782deb86aed2027da0ae6b1999e5c"}
+----
+
+* For GitHub Organizational Data only:
+** Newly added users and teams appear in the {product-very-short} catalog.
+
+

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

@@ -0,0 +1,10 @@
+:_mod-docs-content-type: CONCEPT
+
+[id="con-understand-how-ai-assets-map-to-rhdh-catalog_{context}"]
+= Understand how AI assets map to the {product} Catalog
+
+include::{docdir}/artifacts/snip-developer-preview-rhoai.adoc[]
+
+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.
+
+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].

modules/openshift-ai-connector-for-rhdh/proc-populating-the-api-definition-tab.adoc

@@ -0,0 +1,27 @@
+:_mod-docs-content-type: PROCEDURE
+
+[id="proc-populating-the-api-definition-tab_{context}"]
+= Populating the API Definition tab in {product-very-short} API entities
+
+Since {rhoai-short} does not expose the OpenAPI specification by default, the AI platform engineer can take the following steps to provide this valuable information:
+
+.Procedure
+
+. Retrieve OpenAPI JSON: Use a tool like `curl` to fetch the specification directly from the running endpoint of the AI model server. The following command provides the precise endpoint (`/openapi.json`) and shows how to include a `Bearer` token if the model requires authentication for access.
++
+[source,bash]
+----
+curl -k -H "Authorization: Bearer $MODEL_API_KEY" https://$MODEL_ROOT_URL_INCLUDING_PORT/openapi.json | jq > open-api.json
+----
+
+. Set Property in {rhoai-short}.
+.. In the *{rhoai-short}* dashboard, go to *Model Registry* and select the appropriate *Model Version*.
++
+[NOTE]
+====
+We recommend using *Model Version* instead of *Registered Model* to maintain stability if the API changes between versions.
+====
+
+.. In the **Properties** section, set a key/value pair where the key is `API Spec` and the value is the entire JSON content from the `open-api.json` file.
+
+. Propagation: The {openshift-ai-connector-name} periodically polls the {rhoai-short} Model Registry, propagates this JSON, and renders the interactive API documentation in the *Definition* tab of the {product-very-short} API entity.