Merge pull request #4 from robrakaric/feature-helm-docs

feature: adding helm-docs
This commit is contained in:
Timothy Jaeryang Baek 2024-05-06 20:34:42 -07:00 committed by GitHub
commit 42f5dc709a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 128 additions and 0 deletions

View File

@ -0,0 +1,92 @@
# open-webui
![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: latest](https://img.shields.io/badge/AppVersion-latest-informational?style=flat-square)
Open WebUI: A User-Friendly Web Interface for Chat Interactions 👋
**Homepage:** <https://www.openwebui.com/>
## Source Code
* <https://github.com/open-webui/open-webui/tree/main/kubernetes/helm>
* <https://hub.docker.com/r/ollama/ollama>
* <https://github.com/open-webui/open-webui/pkgs/container/open-webui>
## Installing
Before you can install, you need to add the `open-webui` repo to [Helm](https://helm.sh)
```shell
helm repo add open-webui https://helm.openwebui.com/
helm repo update
```
Now you can install the chart:
```shell
helm upgrade --install open-webui open-webui/open-webui
```
## Values
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| nameOverride | string | `""` | |
| ollama.annotations | object | `{}` | |
| ollama.externalHost | string | `""` | |
| ollama.gpu.enabled | bool | `false` | Enable additional ENV values to help Ollama discover GPU usage |
| ollama.image.pullPolicy | string | `"Always"` | |
| ollama.image.repository | string | `"ollama/ollama"` | |
| ollama.image.tag | string | `"latest"` | |
| ollama.nodeSelector | object | `{}` | |
| ollama.persistence.accessModes[0] | string | `"ReadWriteOnce"` | |
| ollama.persistence.annotations | object | `{}` | |
| ollama.persistence.enabled | bool | `true` | |
| ollama.persistence.existingClaim | string | `""` | |
| ollama.persistence.selector | object | `{}` | |
| ollama.persistence.size | string | `"30Gi"` | |
| ollama.persistence.storageClass | string | `""` | |
| ollama.podAnnotations | object | `{}` | |
| ollama.replicaCount | int | `1` | |
| ollama.resources | object | `{}` | |
| ollama.runtimeClassName | string | `""` | If using a special runtime container such as nvidia, set it here. |
| ollama.service.annotations | object | `{}` | |
| ollama.service.containerPort | int | `11434` | |
| ollama.service.port | int | `80` | |
| ollama.service.type | string | `"ClusterIP"` | |
| ollama.tolerations[0].effect | string | `"NoSchedule"` | |
| ollama.tolerations[0].key | string | `"nvidia.com/gpu"` | |
| ollama.tolerations[0].operator | string | `"Exists"` | |
| webui.annotations | object | `{}` | |
| webui.image.pullPolicy | string | `"Always"` | |
| webui.image.repository | string | `"ghcr.io/open-webui/open-webui"` | |
| webui.image.tag | string | `""` | |
| webui.ingress.annotations | object | `{}` | Use appropriate annotations for your Ingress controller, e.g., for NGINX: nginx.ingress.kubernetes.io/rewrite-target: / |
| webui.ingress.class | string | `""` | |
| webui.ingress.enabled | bool | `false` | |
| webui.ingress.existingSecret | string | `""` | |
| webui.ingress.host | string | `""` | |
| webui.ingress.tls | bool | `false` | |
| webui.nodeSelector | object | `{}` | |
| webui.persistence.accessModes | list | `["ReadWriteOnce"]` | If using multiple replicas, you must update accessModes to ReadWriteMany |
| webui.persistence.annotations | object | `{}` | |
| webui.persistence.enabled | bool | `true` | |
| webui.persistence.existingClaim | string | `""` | |
| webui.persistence.selector | object | `{}` | |
| webui.persistence.size | string | `"2Gi"` | |
| webui.persistence.storageClass | string | `""` | |
| webui.podAnnotations | object | `{}` | |
| webui.replicaCount | int | `1` | |
| webui.resources | object | `{}` | |
| webui.service.annotations | object | `{}` | |
| webui.service.containerPort | int | `8080` | |
| webui.service.labels | object | `{}` | |
| webui.service.loadBalancerClass | string | `""` | |
| webui.service.nodePort | string | `""` | |
| webui.service.port | int | `80` | |
| webui.service.type | string | `"ClusterIP"` | |
| webui.tolerations | list | `[]` | |
----------------------------------------------
Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs/).

View File

@ -0,0 +1,36 @@
{{ template "chart.header" . }}
{{ template "chart.deprecationWarning" . }}
{{ template "chart.badgesSection" . }}
{{ template "chart.description" . }}
{{ template "chart.homepageLine" . }}
{{ template "chart.maintainersSection" . }}
{{ template "chart.sourcesSection" . }}
## Installing
Before you can install, you need to add the `open-webui` repo to [Helm](https://helm.sh)
```shell
helm repo add open-webui https://helm.openwebui.com/
helm repo update
```
Now you can install the chart:
```shell
helm upgrade --install open-webui open-webui/open-webui
```
{{ template "chart.requirementsSection" . }}
{{ template "chart.valuesSection" . }}
----------------------------------------------
Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs/).