Skip to content

Commit

Permalink
Enhance helm chart repo usage in README (#446)
Browse files Browse the repository at this point in the history
Signed-off-by: Dolpher Du <[email protected]>
(cherry picked from commit 0de5535)
  • Loading branch information
yongfengdu authored and chensuyue committed Sep 20, 2024
1 parent 183ad0f commit 21dd644
Showing 1 changed file with 27 additions and 7 deletions.
34 changes: 27 additions & 7 deletions helm-charts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,12 @@ This directory contains helm charts for [GenAIComps](https://github.com/opea-pro
- [Helm Charts](#helm-charts)
- [Examples](#examples)
- [Components](#components)
- [How to deploy with helm charts](#deploy-with-helm-charts)
- [Deploy with helm charts](#deploy-with-helm-charts)
- [From Source Code](#from-source-code)
- [Using Helm Charts repository](#using-helm-charts-repository)
- [Helm Charts Options](#helm-charts-options)
- [Using Persistent Volume](#using-persistent-volume)
- [Using Private Docker Hub](#using-private-docker-hub)
- [Helm Charts repository](#helm-chart-repository)
- [Generate manifests from Helm Charts](#generate-manifests-from-helm-charts)

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

## How to deploy with helm charts
## Deploy with helm charts

### From Source Code

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

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

### Using Helm Charts repository

The helm charts are released in this [helm chart repository](https://opea-project.github.io/GenAIInfra), you can use it directly.

Add the repo:

`helm repo add opea https://opea-project.github.io/GenAIInfra`

Show all helm charts available in the repo:

```
helm repo update
helm search repo opea
```

Install the chart:

`helm install tgi opea/tgi`

Use `helm --help` to see all commands for helm, and check [Helm Charts Options](#helm-charts-options) for more installation options.

## Helm Charts Options

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).
Expand Down Expand Up @@ -143,10 +167,6 @@ export OPEA_IMAGE_REPO=192.168.0.100:5000/
find . -name '*values.yaml' -type f -exec sed -i "s#repository: opea/*#repository: ${OPEA_IMAGE_REPO}opea/#g" {} \;
```

## Helm Charts repository (Experimental)

https://opea-project.github.io/GenAIInfra

## Generate manifests from Helm Charts

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`.
Expand Down

0 comments on commit 21dd644

Please sign in to comment.