search

opea-project / GenAIInfra

Containerization and cloud native suite for OPEA
Apache License 2.0
30 stars 59 forks source link

[helm-charts]Release helm charts #342

Open yongfengdu opened 3 months ago

yongfengdu commented 3 months ago

When the helm charts are stable enough, we can release them using chart repository. So user don't have to git clone the source code before using.

mkbhanda commented 2 months ago

@ashahba @chensuyue @daisy-ycguo has the time come to publish charts .. would be nice if we do this for OPEA v 1.0

poussa commented 1 month ago

Can we use this project's ghcr.io repository to store and publish the charts? That is what many projects do.

The helm install then becomes like:

helm install chatqna oci://ghcr.io/opea-project/gen-ai-infra/charts/chatqna

NOTE: this requires repo name change since uri names can only contain lowercase letters.

mkbhanda commented 1 month ago

@yongfengdu . @chickenrae will help us with any naming/setup issues.

mkbhanda commented 1 month ago

I followed @yongfengdu steps 1) installing helm in my Ubuntu environment 2) helm repo add opea https://opea-project.github.io/GenAIInfra 3) helm search repo opea

with everything named "opea/chatana", "opea/dataprep" etc. We got to get this to a more visible state ...

opea_helm_charts
mkbhanda commented 1 month ago

Thank you @poussa for the suggestion. I do like the idea of everything being collocated in GitHub, code, images and Helm charts. I noticed Milvus does so too.

Also note your point of need to change repo name to a dashed name versus camel case. There are not too many references at this point to GenAIInfra, 1) https://github.com/search?q=repo%3Aopea-project%2FGenAIExamples%20genaiinfra&type=code 2) https://github.com/search?q=repo%3Aopea-project%2Fdocs+genaiinfra&type=code

These can be replaced with tools. The sooner we do better. The majority being in docs and I did not see any in GenAIComps or GenAIEval.

@yongfengdu would you kindly remove the experimental OPEA-TEI chart you published a while back in Artefactory. @yongfengdu and @poussa would you both kindly work together to publish the Helm charts in GitHub. @chickenrae has created an account for us called cicd@opea.

Do we want to publish our images to both Docker and Git Hub repos or just GitHub? GitHub in a couple or references list after Docker Hub which typically is coming in at #3. If we decide to publish in one place alone and opt for the unified publish approach, need to remove the OPEA images on Docker Hub or at the very least "archive" them to cause no confusion from old images.

yongfengdu commented 1 month ago

https://github.com/opea-project/GenAIExamples/issues/813

yongfengdu commented 1 month ago

@mkbhanda The OPEA-TGI chart was not published by me, I was only maintaining the https://opea-project.github.io/GenAIInfra/, and it should be easy to publish them elsewhere once decided.(ArtifactHUB or ghcr.io)

@poussa has a good summary at this link for helm charts.

  1. ArtifactHUB is straightforward, and it can be done easily.
  2. Github pages are already there (https://opea-project.github.io/GenAIInfra/)
  3. Ghcr.io requires repo name change, I think this one should be aligned before taking any action. Some issues in my mind: 1). Naming convention. The gen-ai-infra is different from other repos(GenAIExample), shall we change them all, or just the GenAIInfra? 2). Like the docker images, shall we publish them to multiple places(ArtifactHUB, ghcr and github pages), or we maintain only in one place? If single place is preferred, we’ll need to wait for the decision of which place to go, otherwise, we can go ahead with ArtifactHUB publish soon.
yongfengdu commented 4 weeks ago

The current README for each helm package includes installation guide from source code, this will not be accurate after we published them through ArtifactHub. This will need be fixed later.

mkbhanda commented 3 weeks ago

@yongfengdu and @poussa -- please publish OPEA images and helm charts on ghcr.io repository. It was discussed in OPEA TSC and an advantage of doing so is no rate limits for image pulls, and keeping charts, images, source code all together.

1) publish images and charts as per above. Both of you are part of CIC@OPEA too. 2) confirm images are present, change all GenAI Examples to use new repository for images. 3) change all readmes to reflect new home for images and helm charts 4) delete images and charts from old homes.

Copying @chensuyue and @ashahba on this issue. I would like this as part of our V1.1 OPEA release.

poussa commented 3 weeks ago

Actually, we don't need to change any of the repo names in order to use ghcr.io. We can push images and Helm charts to opea-project namespace (docker push ghcr.io/NAMESPACE/IMAGE_NAME:2.5) as documented here

docker push ghcr.io/opea-project/chatqna:1.0) helm push chatqna-1.0.tgz oci://ghcr.io/opea-project/charts