[Feature] Helm charts should mention HW specific values that need to be provided

[mkbhanda]

Priority

Undecided

OS type

Ubuntu

Hardware type

Xeon-SPR, Gaudi etc

Running nodes

Single Node

Description

As a cloud user I want to use a helm chart but need guidance on values.yaml that needs to be provided based on available infrastructure.

For example the AgentQnA chart is generic across Gaudi and CPU
Thinking how the user can trip up, how to get them to refer to a README for help first.
https://github.com/orgs/opea-project/packages/container/package/charts%2Fagentqna

[eero-t]

Btw. I just noticed that GH workflow is not updating the charts when only their documentation is updated. Updates happen only when other files are (also) updated => filed PR to fix it: #817.

[eero-t]

Thinking how the user can trip up, how to get them to refer to a README for help first.

As they are Helm charts, user can use helm show readme to view README.md included with the chart.

[yongfengdu]

The github package https://github.com/orgs/opea-project/packages doesn't provide a way to show each helm charts README.
We shall point the user to https://github.com/opea-project/GenAIInfra/tree/main/helm-charts#readme and improve it continuously.