Skip to content
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

Migration Suggestion #959

Closed
wants to merge 1 commit into from
Closed

Conversation

yongfengdu
Copy link
Collaborator

The directory layout suggest for helm charts in GenAIComps

Description

The summary of the proposed changes as long as the relevant motivation and context.

Issues

List the issue or RFC link this PR is working on. If there is no such link, please mark it as n/a.

Type of change

List the type of change like below. Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds new functionality)
  • Breaking change (fix or feature that would break existing design and interface)
  • Others (enhancement, documentation, validation, etc.)

Dependencies

List the newly introduced 3rd party dependency if exists.

Tests

Describe the tests that you ran to verify your changes.

@yongfengdu yongfengdu marked this pull request as draft December 2, 2024 04:42
The directory layout suggest for helm charts in GenAIComps

Signed-off-by: Dolpher Du <[email protected]>
@eero-t
Copy link
Contributor

eero-t commented Dec 2, 2024

The directory layout suggest for helm charts in GenAIComps

Corresponding "GenAIExamples" repo PR: opea-project/GenAIExamples#1218

Uses Helm repo deps like: oci://ghcr.io/opea-project/charts/tgi.

How often charts from this repo would be synced there (on every merge, daily, weekly?) i.e. how much this would complicate (testing of) features that need changes to both repos?

| image.repository | string | `"opea/llm-tgi"` | |
| service.port | string | `"9000"` | |
| TGI_LLM_ENDPOINT | string | `""` | LLM endpoint |
| global.monitoring | bool | `false` | Service usage metrics |
Copy link
Contributor

@eero-t eero-t Dec 2, 2024

Choose a reason for hiding this comment

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

Helm install fails if user enables this without reading the docs first => Just removing link to doc is not a solution!

Neither is duplicating the docs in multiple repos.

=> IMHO best would be to move common Helm chart docs (on HPA, monitoring etc) to helm-charts dir here, and link those from all relevant docs (including Helm chart READMEs going to Examples repo).

@eero-t
Copy link
Contributor

eero-t commented Dec 2, 2024

As to other CI failures... Clearly pre-CI check-yaml checks in this repo will need to be updated to handle Helm charts.

@yongfengdu
Copy link
Collaborator Author

@eero-t Thanks. This is just a PR draft created to show possible dir layout, doesn't mean the final decision. So, many issues are not resolved yet.

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

Successfully merging this pull request may close these issues.

2 participants