Add docs to accompany AMD-accelerated OPEA ChatQnA pattern #567

jeremyary · 2025-05-12T14:54:57Z

Accompanying pattern code here: https://github.com/validatedpatterns-sandbox/qna-chat-amd

Adding documentation for new pattern which deploys OPEA's ChatQnA app and enables AMD Instinct hardware acceleration
similar to existing Intel-contributed pattern for Gaudi accel.
card/pattern reflect sandbox status indicator

mbaldessari · 2025-05-12T14:55:09Z

This is an automated message:

You can preview this docs PR at http://567.docs-pr.validatedpatterns.io
Note that they get generated every five minutes, so please wait a bit.

openshift-ci · 2025-05-12T14:55:10Z

Hi @jeremyary. Thanks for your PR.

I'm waiting for a validatedpatterns member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

mbaldessari · 2025-05-14T14:42:53Z

/ok-to-test

day0hero · 2025-05-14T22:53:16Z

/lgtm

abhatt-rh

Hi @jeremyary
Thank you for submitting this PR. On a cursory look, I have a added a couple of style-related comments based IBM Style and Red Hat Supplementary Style guides.

abhatt-rh · 2025-05-14T17:53:27Z

content/patterns/amd-rag-chat-qna/_index.adoc

+#pattern_logo: amd-rag-chat-qna.png
+links:
+  install: amd-rag-chat-qna-getting-started
+  help: https://groups.google.com/g/hybrid-cloud-patterns


Suggested change

help: https://groups.google.com/g/hybrid-cloud-patterns

help: https://groups.google.com/g/validatedpatterns

abhatt-rh · 2025-05-14T17:54:25Z

content/patterns/amd-rag-chat-qna/_index.adoc

+= About {amdqna-pattern}
+
+Background::
+This Validated Pattern implements an enterprise-ready question-and-answer chatbot utilizing retrieval-augmented generation (RAG) & capability reasoning via large language model (LLM). The application is based on the publicly-available


Suggested change

This Validated Pattern implements an enterprise-ready question-and-answer chatbot utilizing retrieval-augmented generation (RAG) & capability reasoning via large language model (LLM). The application is based on the publicly-available

This Validated Pattern implements an enterprise-ready question-and-answer chatbot utilizing retrieval-augmented generation (RAG) and capability reasoning using large language model (LLM). The application is based on the publicly-available

abhatt-rh · 2025-05-14T17:55:38Z

content/patterns/amd-rag-chat-qna/_index.adoc

+This pattern aims to leverage the strengths of OPEA's framework in combination with other OpenShift-centric toolings in order to deploy a modern, LLM-backed reasoning application stack capable of leveraging https://www.amd.com/en/products/accelerators/instinct.html[AMD's Instinct]
+hardware acceleration in an enterprise-ready & distributed manner. The pattern utilizes https://www.redhat.com/en/technologies/cloud-computing/openshift/gitops[Red Hat OpenShift GitOps] to bring a continuous delivery approach to the application's development & usage based on declarative
+Git-driven workflows, backed by a centralized, single-source-of-truth git repository.


Remove hard line breaks

abhatt-rh · 2025-05-14T17:56:02Z

content/patterns/amd-rag-chat-qna/_index.adoc

+hardware acceleration in an enterprise-ready & distributed manner. The pattern utilizes https://www.redhat.com/en/technologies/cloud-computing/openshift/gitops[Red Hat OpenShift GitOps] to bring a continuous delivery approach to the application's development & usage based on declarative
+Git-driven workflows, backed by a centralized, single-source-of-truth git repository.
+
+Key Features::


Suggested change

Key Features::

Key features::

abhatt-rh · 2025-05-14T17:56:31Z

content/patterns/amd-rag-chat-qna/_index.adoc

+The following solution integrates the https://github.com/opea-project/GenAIExamples/tree/main/ChatQnA[OPEA ChatQnA example app] with the http://localhost:1313/patterns/multicloud-gitops/[Multicloud GitOps] Validated Pattern to encapsulate every defined component as an
+easily trackable resource via OpenShift GitOps dashboard:


Remove hard line break

abhatt-rh · 2025-05-15T15:44:19Z

content/patterns/amd-rag-chat-qna/amd-rag-chat-qna-getting-started.adoc

+Once all the prerequisites are met, install the ChatQnA application
+* Clone the repository by running the following commands:
+
+    git clone https://github.com/validatedpatterns-sandbox/qna-chat-amd.git


Global comment: Use appropriate code blacks for commands and code snippets

Suggested change

git clone https://github.com/validatedpatterns-sandbox/qna-chat-amd.git

[source,terminal]

git clone https://github.com/validatedpatterns-sandbox/qna-chat-amd.git

abhatt-rh · 2025-05-15T15:45:20Z

content/patterns/amd-rag-chat-qna/amd-rag-chat-qna-getting-started.adoc

+
+* Modify the `value` field in `~/values-secret-qna-chat-amd.yaml` file
+
+----


Suggested change

----

[source,yaml]

----

for some reason it didn't recognize the fix for this one, but it's in there.

abhatt-rh · 2025-05-15T15:46:11Z

content/patterns/amd-rag-chat-qna/amd-rag-chat-qna-getting-started.adoc

+
+image::/images/qna-chat-amd/chatqna-long-response.png[ChatQnA UI - response for general questions,50%,50%]
+
+=== Wrap Up


Suggested change

=== Wrap Up

=== Conclusion

abhatt-rh · 2025-05-15T15:46:34Z

content/patterns/amd-rag-chat-qna/amd-rag-chat-qna-required-hardware.adoc

@@ -0,0 +1,41 @@
+---
+title: Required Hardware


Global comment: Write all titles and headings, in sentence-style capitalization.

Suggested change

title: Required Hardware

title: Required hardware

abhatt-rh · 2025-05-15T15:48:09Z

content/patterns/amd-rag-chat-qna/amd-rag-chat-qna-troubleshooting.adoc

+include::modules/comm-attributes.adoc[]
+
+[id="troubleshooting-the-pattern-deployment"]
+=== Troubleshooting common Pattern Deployment issues


Suggested change

=== Troubleshooting common Pattern Deployment issues

=== Troubleshooting common pattern deployment issues

jeremyary · 2025-05-15T19:41:13Z

Thanks @abhatt-rh & @day0hero, all recommended changes implemented, incl. global comments and a few similar things I caught.

abhatt-rh

Hi @jeremyary,
Thank you for addressing the comments. Please squash all the commits to one. I have added a comment for AMD to show up under our Partners filter like shown here:

abhatt-rh · 2025-05-16T09:57:41Z

content/patterns/amd-rag-chat-qna/_index.adoc

+- Red Hat OpenShift Data Foundation
+- Red Hat OpenShift AI
+- Red Hat OpenShift Serverless
+- Red Hat OpenShift Service Mesh


Add the following lines to add AMD as Partner. This will bring up your pattern should anyone filter on AMD:

partners: - AMD

ooh, solid improvement for search, thank you! Added & commits squashed.

abhatt-rh

/lgtm
Proceeding with merge

openshift-ci bot added the do-not-merge/work-in-progress label May 12, 2025

openshift-ci bot added the needs-ok-to-test label May 12, 2025

openshift-ci bot added the size/XL label May 12, 2025

jeremyary marked this pull request as ready for review May 12, 2025 15:47

openshift-ci bot removed the do-not-merge/work-in-progress label May 12, 2025

jeremyary changed the title ~~Add docs to accompany AMD-acceleraed OPEA ChatQnA pattern~~ Add docs to accompany AMD-accelerated OPEA ChatQnA pattern May 12, 2025

openshift-ci bot added ok-to-test and removed needs-ok-to-test labels May 14, 2025

mbaldessari requested a review from abhatt-rh May 14, 2025 14:43

openshift-ci bot assigned day0hero May 14, 2025

openshift-ci bot added the lgtm label May 14, 2025

abhatt-rh reviewed May 15, 2025

View reviewed changes

openshift-ci bot removed the lgtm label May 15, 2025

jeremyary force-pushed the chatqna-amd-rh branch from 233311d to 7aadd8c Compare May 15, 2025 19:36

abhatt-rh reviewed May 16, 2025

View reviewed changes

introduction of AMD OPEA ChatQnA pattern

b68e5bb

jeremyary force-pushed the chatqna-amd-rh branch from 7aadd8c to b68e5bb Compare May 16, 2025 11:24

abhatt-rh reviewed May 16, 2025

View reviewed changes

openshift-ci bot assigned abhatt-rh May 16, 2025

openshift-ci bot added the lgtm label May 16, 2025

abhatt-rh merged commit d808211 into validatedpatterns:main May 16, 2025
4 checks passed

	help: https://groups.google.com/g/hybrid-cloud-patterns
	help: https://groups.google.com/g/validatedpatterns

	This Validated Pattern implements an enterprise-ready question-and-answer chatbot utilizing retrieval-augmented generation (RAG) & capability reasoning via large language model (LLM). The application is based on the publicly-available
	This Validated Pattern implements an enterprise-ready question-and-answer chatbot utilizing retrieval-augmented generation (RAG) and capability reasoning using large language model (LLM). The application is based on the publicly-available

		The following solution integrates the https://github.com/opea-project/GenAIExamples/tree/main/ChatQnA[OPEA ChatQnA example app] with the http://localhost:1313/patterns/multicloud-gitops/[Multicloud GitOps] Validated Pattern to encapsulate every defined component as an
		easily trackable resource via OpenShift GitOps dashboard:

	git clone https://github.com/validatedpatterns-sandbox/qna-chat-amd.git
	[source,terminal]
	git clone https://github.com/validatedpatterns-sandbox/qna-chat-amd.git

	=== Troubleshooting common Pattern Deployment issues
	=== Troubleshooting common pattern deployment issues

Add docs to accompany AMD-accelerated OPEA ChatQnA pattern #567

Add docs to accompany AMD-accelerated OPEA ChatQnA pattern #567

Uh oh!

Conversation

jeremyary commented May 12, 2025

Uh oh!

mbaldessari commented May 12, 2025

Uh oh!

openshift-ci bot commented May 12, 2025

Uh oh!

mbaldessari commented May 14, 2025

Uh oh!

day0hero commented May 14, 2025

Uh oh!

abhatt-rh left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jeremyary commented May 15, 2025

Uh oh!

abhatt-rh left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

abhatt-rh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants