Skip to content

Commit 0de5535

Browse files
authored
Enhance helm chart repo usage in README (#446)
Signed-off-by: Dolpher Du <[email protected]>
1 parent d8cd3a1 commit 0de5535

File tree

1 file changed

+27
-7
lines changed

1 file changed

+27
-7
lines changed

helm-charts/README.md

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,12 @@ This directory contains helm charts for [GenAIComps](https://github.com/opea-pro
77
- [Helm Charts](#helm-charts)
88
- [Examples](#examples)
99
- [Components](#components)
10-
- [How to deploy with helm charts](#deploy-with-helm-charts)
10+
- [Deploy with helm charts](#deploy-with-helm-charts)
11+
- [From Source Code](#from-source-code)
12+
- [Using Helm Charts repository](#using-helm-charts-repository)
1113
- [Helm Charts Options](#helm-charts-options)
1214
- [Using Persistent Volume](#using-persistent-volume)
1315
- [Using Private Docker Hub](#using-private-docker-hub)
14-
- [Helm Charts repository](#helm-chart-repository)
1516
- [Generate manifests from Helm Charts](#generate-manifests-from-helm-charts)
1617

1718
## Helm Charts
@@ -35,7 +36,9 @@ Components which are building blocks for AI application.
3536
All components helm charts are put in the ./common directory, and the support list is growing.
3637
Refer to [GenAIComps](https://github.com/opea-project/GenAIComps) for details of each component.
3738

38-
## How to deploy with helm charts
39+
## Deploy with helm charts
40+
41+
### From Source Code
3942

4043
These helm charts are designed to be easy to start, which means you can deploy a workload easily without further options.
4144
However, `HUGGINGFACEHUB_API_TOKEN` should be set in most cases for a workload to start up correctly.
@@ -50,6 +53,27 @@ helm install $myrelease $chartname --set global.HUGGINGFACEHUB_API_TOKEN="insert
5053

5154
Depends on your environment, you might want to customize some of the options, see [Helm Charts Options](#helm-charts-options) for further information.
5255

56+
### Using Helm Charts repository
57+
58+
The helm charts are released in this [helm chart repository](https://opea-project.github.io/GenAIInfra), you can use it directly.
59+
60+
Add the repo:
61+
62+
`helm repo add opea https://opea-project.github.io/GenAIInfra`
63+
64+
Show all helm charts available in the repo:
65+
66+
```
67+
helm repo update
68+
helm search repo opea
69+
```
70+
71+
Install the chart:
72+
73+
`helm install tgi opea/tgi`
74+
75+
Use `helm --help` to see all commands for helm, and check [Helm Charts Options](#helm-charts-options) for more installation options.
76+
5377
## Helm Charts Options
5478

5579
Here we list a few important options that user might want to change, for more options, you can read each helm chart's README file and check the values.yaml and gaudi-values.yaml(If applicable).
@@ -143,10 +167,6 @@ export OPEA_IMAGE_REPO=192.168.0.100:5000/
143167
find . -name '*values.yaml' -type f -exec sed -i "s#repository: opea/*#repository: ${OPEA_IMAGE_REPO}opea/#g" {} \;
144168
```
145169

146-
## Helm Charts repository (Experimental)
147-
148-
https://opea-project.github.io/GenAIInfra
149-
150170
## Generate manifests from Helm Charts
151171

152172
Some users may want to use kubernetes manifests(yaml files) for workload deployment, we do not maintain manifests itself, and will generate them using `helm template`.

0 commit comments

Comments
 (0)