Skip to content

Commit

Permalink
README pointing to ghcr.io package (#572)
Browse files Browse the repository at this point in the history
Also fix audioqna version to keep consistent with others.
The version number will be upgraded on release branch first.

Signed-off-by: Dolpher Du <[email protected]>
  • Loading branch information
yongfengdu authored Nov 18, 2024
1 parent 3910e3b commit b5d54a9
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 28 deletions.
18 changes: 3 additions & 15 deletions helm-charts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,25 +56,13 @@ Depending on your environment, you may want to customize some of the options, se

### 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:
The Helm charts are released to https://github.com/orgs/opea-project/packages. You can check the list there and deploy with

```
helm repo update
helm search repo opea
export chartname=chatqna
helm install myrelease oci://ghcr.io/opea-project/charts/${chartname}
```

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 is a list of a few important options that user may want to change.
Expand Down
4 changes: 1 addition & 3 deletions helm-charts/agentqna/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@ Helm chart for deploying AgentQnA service.

## Deploy

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

helm install agentqna opea/agentqna --set global.HUGGINGFACEHUB_API_TOKEN=${HUGGINGFACEHUB_API_TOKEN} --set tgi.enabled=True
helm install agentqna oci://ghcr.io/opea-project/charts/agentqna --set global.HUGGINGFACEHUB_API_TOKEN=${HUGGINGFACEHUB_API_TOKEN} --set tgi.enabled=True

## Verify

Expand Down
2 changes: 1 addition & 1 deletion helm-charts/audioqna/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,5 @@ dependencies:
# version: 1.0.0
# repository: "file://../common/ui"
# alias: audioqna-ui
version: 1.1.0
version: 1.0.0
appVersion: "1.1"
8 changes: 3 additions & 5 deletions helm-charts/common/agent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,17 @@ agent depends on LLM service, you should set llm_endpoint_url as LLM endpoint.

## Deploy

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

### Use external LLM endpoint

helm install agent opea/agent --set llm_endpoint_url=${YOUR_LLM_ENDPOINT}
helm install agent oci://ghcr.io/opea-project/charts/agent --set llm_endpoint_url=${YOUR_LLM_ENDPOINT}

### Deploy with tgi

helm install agent opea/agent --set tgi.enabled=True
helm install agent oci://ghcr.io/opea-project/charts/agent --set tgi.enabled=True

### Deploy with vllm

helm install agent opea/agent --set vllm.enabled=True
helm install agent oci://ghcr.io/opea-project/charts/agent --set vllm.enabled=True

## Verify

Expand Down
2 changes: 1 addition & 1 deletion helm-charts/common/gpt-sovits/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ apiVersion: v2
name: gpt-sovits
description: The Helm chart for deploying gpt-sovits as microservice
type: application
version: 1.1.0
version: 1.0.0
# The gpt-sovits microservice server version
appVersion: "1.0"
6 changes: 3 additions & 3 deletions microservices-connector/config/manifests/gpt-sovits.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ kind: ConfigMap
metadata:
name: gpt-sovits-config
labels:
helm.sh/chart: gpt-sovits-1.1.0
helm.sh/chart: gpt-sovits-1.0.0
app.kubernetes.io/name: gpt-sovits
app.kubernetes.io/instance: gpt-sovits
app.kubernetes.io/version: "1.0"
Expand All @@ -30,7 +30,7 @@ kind: Service
metadata:
name: gpt-sovits
labels:
helm.sh/chart: gpt-sovits-1.1.0
helm.sh/chart: gpt-sovits-1.0.0
app.kubernetes.io/name: gpt-sovits
app.kubernetes.io/instance: gpt-sovits
app.kubernetes.io/version: "1.0"
Expand All @@ -55,7 +55,7 @@ kind: Deployment
metadata:
name: gpt-sovits
labels:
helm.sh/chart: gpt-sovits-1.1.0
helm.sh/chart: gpt-sovits-1.0.0
app.kubernetes.io/name: gpt-sovits
app.kubernetes.io/instance: gpt-sovits
app.kubernetes.io/version: "1.0"
Expand Down

0 comments on commit b5d54a9

Please sign in to comment.