Skip to content

Add ChatQnA docker-compose example on AIPC using MariaDB Vector #1902

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

RazvanLiviuVarzaru
Copy link

Description

Add ChatQnA docker-compose example on AIPC using MariaDB Vector.
Depends on: opea-project/GenAIComps#1645

Issues

n/a

Type of change

  • New feature (non-breaking change which adds new functionality)

Dependencies

n/a

Tests

Set the HF API token environment variable and:

cd ChatQnA/tests
bash test_compose_mariadb_on_aipc.sh

Example on how to deploy the ChatBot on AIPC by using MariaDB Server as a vectorstore.
- use MariaDB Server as the backend database. Minimum required version is 11.7
- use the OPEA_DATAPREP_MARIADBVECTOR component for dataprep microservice
- use the OPEA_RETRIEVER_MARIADBVECTOR component for retriever microservice

How to test
Set the HF API token environment variable and:
```
cd ChatQnA/tests
bash test_compose_mariadb_on_aipc.sh
```

Signed-off-by: Razvan-Liviu Varzaru <[email protected]>
@Copilot Copilot AI review requested due to automatic review settings May 5, 2025 08:09
Copy link

github-actions bot commented May 5, 2025

Dependency Review

✅ No vulnerabilities or license issues found.

Scanned Files

None

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR introduces a docker-compose example for deploying the ChatQnA service on AIPC using MariaDB Vector.

  • Adds a new compose file (compose_mariadb.yaml) configuring multiple services including MariaDB, dataprep, embedding, retriever, UI, nginx, and ollama.
  • Provides a README (README_mariadb.md) with detailed instructions and quick-start steps to deploy the service.

Reviewed Changes

Copilot reviewed 2 out of 4 changed files in this pull request and generated 1 comment.

File Description
ChatQnA/docker_compose/intel/cpu/aipc/compose_mariadb.yaml New docker-compose configuration that orchestrates several dependent services including the MariaDB container.
ChatQnA/docker_compose/intel/cpu/aipc/README_mariadb.md Documentation for setting up and deploying the ChatQnA service with MariaDB Vector using docker-compose.
Files not reviewed (2)
  • ChatQnA/docker_compose/intel/cpu/aipc/set_env_mariadb.sh: Language not supported
  • ChatQnA/tests/test_compose_mariadb_on_aipc.sh: Language not supported
Comments suppressed due to low confidence (1)

ChatQnA/docker_compose/intel/cpu/aipc/README_mariadb.md:1

  • [nitpick] Consider updating the README title to reflect that this example uses MariaDB Vector, aligning it with the PR title.
# Build Mega Service of ChatQnA on AIPC

@lvliang-intel
Copy link
Collaborator

@chensuyue,
Is there any AIPC ready for using in CI system?

@lvliang-intel lvliang-intel requested a review from chensuyue May 7, 2025 01:15
@chensuyue
Copy link
Collaborator

@chensuyue, Is there any AIPC ready for using in CI system?

No, we don't have AIPC for CI.

@chensuyue
Copy link
Collaborator

We have few test on AIPC, so we don't have specific resource for those test. Unless we plan to implement AIPC test for all the examples, I will try to apply for an AIPC for test.
If this test able to run on Xeon as well, I suggest to change the test scripts name into ChatQnA/tests/test_compose_mariadb_on_xeon.sh and the test will be deploy on a xeon machine. And you can add some comments in the beginning of the scripts, reminder us to run this test on AIPC during release test (quarterly).

@RazvanLiviuVarzaru
Copy link
Author

We have few test on AIPC, so we don't have specific resource for those test. Unless we plan to implement AIPC test for all the examples, I will try to apply for an AIPC for test. If this test able to run on Xeon as well, I suggest to change the test scripts name into ChatQnA/tests/test_compose_mariadb_on_xeon.sh and the test will be deploy on a xeon machine. And you can add some comments in the beginning of the scripts, reminder us to run this test on AIPC during release test (quarterly).

@chensuyue

I've added a Xeon example here: #1916.
For testing, I had to build the dataprep and retriever Docker images myself. I'm not sure if merging opea-project/GenAIComps#1645 should have triggered a push to DockerHub.

As for this PR, feel free to close it, or if you find it valuable, you can merge it once an AIPC runner is available in CI.

Thanks!

@ashahba ashahba added the WIP label May 7, 2025
@ashahba
Copy link
Collaborator

ashahba commented May 7, 2025

Labeling this as WIP until we are ready for invest resources into AIPC testing.

@chensuyue
Copy link
Collaborator

We have few test on AIPC, so we don't have specific resource for those test. Unless we plan to implement AIPC test for all the examples, I will try to apply for an AIPC for test. If this test able to run on Xeon as well, I suggest to change the test scripts name into ChatQnA/tests/test_compose_mariadb_on_xeon.sh and the test will be deploy on a xeon machine. And you can add some comments in the beginning of the scripts, reminder us to run this test on AIPC during release test (quarterly).

@chensuyue

I've added a Xeon example here: #1916. For testing, I had to build the dataprep and retriever Docker images myself. I'm not sure if merging opea-project/GenAIComps#1645 should have triggered a push to DockerHub.

As for this PR, feel free to close it, or if you find it valuable, you can merge it once an AIPC runner is available in CI.

Thanks!

Once the PR1654 merged, the related images in the dockerhub will be refreshed in one day or two. But in CI test, we always use images build from latest GenAIComps main branch.
Regarding to this PR, you can mark the test with _ as _test_compose_mariadb_on_aipc.sh, so it will not be triggered by CI. And leave a message if you pass the local test and we can merge it first.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants