Merge pull request #198 from jyje/issue-184/add-milvus

- The new signature is from open-webui image

.github/workflows/helm-release.yml

@@ -65,6 +65,7 @@ jobs:
           helm repo add open-webui https://helm.openwebui.com/
           helm repo add tika https://apache.jfrog.io/artifactory/tika/
           helm repo add redis https://charts.bitnami.com/bitnami
+          helm repo add milvus https://zilliztech.github.io/milvus-helm
 
       - name: Run chart-releaser
         uses: helm/chart-releaser-action@v1.7.0

.github/workflows/helm-test-open-webui.yml

@@ -24,6 +24,17 @@ jobs:
         run: |
           helm lint ./charts/open-webui
 
+      - name: Add Dependency Repos
+        run: |
+          helm repo add ollama https://otwld.github.io/ollama-helm/
+          helm repo add open-webui https://helm.openwebui.com/
+          helm repo add tika https://apache.jfrog.io/artifactory/tika/
+          helm repo add redis https://charts.bitnami.com/bitnami
+          helm repo add milvus https://zilliztech.github.io/milvus-helm
+      - name: Build open-webui Helm dependencies
+        run: |
+          helm dependency build ./charts/open-webui
+
   test-deploy:
     name: Test Chart Deployment
     runs-on: ubuntu-latest

CONTRIBUTING.md

@@ -8,7 +8,7 @@
 1. **Fork the repository** and create your branch from `main`.
 2. **Make your changes** and ensure they follow the guidelines below.
 3. **Test your changes** locally to ensure everything works as expected. This should include deploying your updates to a live Kubernetes cluster (whether local or remote).
-4. **Run helm-docs** to ensure that the README is updated with the latest changes. 
+4. **Run [helm-docs]** to ensure that the README is updated with the latest changes. 
 5. **Commit your changes** using a descriptive commit message that follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
 6. **Push your changes** to your forked repository.
 7. **Create a Pull Request** and provide a detailed description of your changes. Please consider dropping us your redacted `values.yaml` file used during your testing in the PR so we can make sure we see consistent results. 
@@ -37,3 +37,5 @@
 If you need any help or have questions about contributing, feel free to reach out to the maintainers of the repository.
 
 Thank you for your contributions!
+
+[helm-docs]: https://github.com/norwoodj/helm-docs

charts/open-webui/Chart.lock

@@ -1,15 +1,18 @@
 dependencies:
 - name: ollama
   repository: https://otwld.github.io/ollama-helm/
-  version: 1.6.0
+  version: 1.7.0
 - name: pipelines
   repository: https://helm.openwebui.com
-  version: 0.2.0
+  version: 0.4.0
 - name: tika
   repository: https://apache.jfrog.io/artifactory/tika
   version: 2.9.0
 - name: redis
   repository: https://charts.bitnami.com/bitnami
-  version: 20.7.1
-digest: sha256:d897822b6463d9427f97fa81221b3bafad13ab39c205836105c3d93b9016db9f
-generated: "2025-02-19T09:20:34.829162+09:00"
+  version: 20.10.0
+- name: milvus
+  repository: https://zilliztech.github.io/milvus-helm
+  version: 4.2.40
+digest: sha256:b9597e9cf5f89874a3c345562085ac3ba972b98ccf1b5e64425de0c17ec359f5
+generated: "2025-02-28T22:43:15.040921+09:00"

charts/open-webui/Chart.yaml

@@ -1,7 +1,7 @@
 apiVersion: v2
 name: open-webui
-version: 5.16.1
-appVersion: 0.5.14
+version: 5.21.0
+appVersion: 0.5.16
 home: https://www.openwebui.com/
 icon: >-
   https://raw.githubusercontent.com/open-webui/open-webui/main/static/favicon.png
@@ -43,3 +43,7 @@ dependencies:
     version: '>=20.6.2'
     alias: redis-cluster
     condition: redis-cluster.enabled
+  - name: milvus
+    repository: https://zilliztech.github.io/milvus-helm
+    version: '>=4.2.40'
+    condition: milvus.enabled

charts/open-webui/README.md

@@ -1,6 +1,6 @@
 # open-webui
 
-![Version: 5.16.1](https://img.shields.io/badge/Version-5.16.1-informational?style=flat-square) ![AppVersion: 0.5.14](https://img.shields.io/badge/AppVersion-0.5.14-informational?style=flat-square)
+![Version: 5.21.0](https://img.shields.io/badge/Version-5.21.0-informational?style=flat-square) ![AppVersion: 0.5.16](https://img.shields.io/badge/AppVersion-0.5.16-informational?style=flat-square)
 
 Open WebUI: A User-Friendly Web Interface for Chat Interactions 👋
 
@@ -37,6 +37,7 @@ helm upgrade --install open-webui open-webui/open-webui
 | https://charts.bitnami.com/bitnami | redis-cluster(redis) | >=20.6.2 |
 | https://helm.openwebui.com | pipelines | >=0.0.1 |
 | https://otwld.github.io/ollama-helm/ | ollama | >=0.24.0 |
+| https://zilliztech.github.io/milvus-helm | milvus | >=4.2.40 |
 
 ## Values
 
@@ -50,6 +51,7 @@ helm upgrade --install open-webui open-webui/open-webui
 | extraEnvVars | list | `[{"name":"OPENAI_API_KEY","value":"0p3n-w3bu!"}]` | Env vars added to the Open WebUI deployment. Most up-to-date environment variables can be found here: https://docs.openwebui.com/getting-started/env-configuration/ |
 | extraEnvVars[0] | object | `{"name":"OPENAI_API_KEY","value":"0p3n-w3bu!"}` | Default API key value for Pipelines. Should be updated in a production deployment, or be changed to the required API key if not using Pipelines |
 | extraResources | list | `[]` | Extra resources to deploy with Open WebUI |
+| hostAliases | list | `[]` | HostAliases to be added to hosts-file of each container |
 | image | object | `{"pullPolicy":"IfNotPresent","repository":"ghcr.io/open-webui/open-webui","tag":""}` | Open WebUI image tags can be found here: https://github.com/open-webui/open-webui |
 | imagePullSecrets | list | `[]` | Configure imagePullSecrets to use private registry ref: <https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry> |
 | ingress.additionalHosts | list | `[]` |  |
@@ -63,6 +65,11 @@ helm upgrade --install open-webui open-webui/open-webui
 | managedCertificate.domains[0] | string | `"chat.example.com"` |  |
 | managedCertificate.enabled | bool | `false` |  |
 | managedCertificate.name | string | `"mydomain-chat-cert"` |  |
+| milvus.db | string | `"default"` | Active Milvus database for RAG with env `MILVUS_DB` ref: https://docs.openwebui.com/getting-started/env-configuration#milvus_db |
+| milvus.enabled | bool | `false` | Enable Milvus installation. Deploys a Milvus cluster/standalone with subchart 'milvus' from zilliztech ref: https://github.com/zilliztech/milvus-helm/tree/master/charts/milvus |
+| milvus.fullnameOverride | string | `"open-webui-milvus"` | Milvus fullname override (recommended to be 'open-webui-milvus') - In this case, the Milvus uri will be 'http://[username:password@]open-webui-milvus:19530' |
+| milvus.token | object | `{}` | Active Milvus token for RAG with env `MILVUS_TOKEN` ref: https://docs.openwebui.com/getting-started/env-configuration#milvus_token |
+| milvus.uri | string | `"http://open-webui-milvus:19530"` | Active Milvus URI for RAG with env `MILVUS_URI`. If there is credentials in the uri, it will be used to connect to the Milvus server. ref: https://docs.openwebui.com/getting-started/env-configuration#milvus_uri |
 | nameOverride | string | `""` |  |
 | namespaceOverride | string | `""` |  |
 | nodeSelector | object | `{}` | Node labels for pod assignment. |
@@ -70,6 +77,7 @@ helm upgrade --install open-webui open-webui/open-webui
 | ollama.fullnameOverride | string | `"open-webui-ollama"` | If enabling embedded Ollama, update fullnameOverride to your desired Ollama name value, or else it will use the default ollama.name value from the Ollama chart |
 | ollamaUrls | list | `[]` | A list of Ollama API endpoints. These can be added in lieu of automatically installing the Ollama Helm chart, or in addition to it. |
 | ollamaUrlsFromExtraEnv | bool | `false` | Disables taking Ollama Urls from `ollamaUrls`  list |
+| enableOpenaiApi | bool | `true` | Enables the use of OpenAI APIs
 | openaiBaseApiUrl | string | `"https://api.openai.com/v1"` | OpenAI base API URL to use. Defaults to the Pipelines service endpoint when Pipelines are enabled, and "https://api.openai.com/v1" if Pipelines are not enabled and this value is blank |
 | openaiBaseApiUrls | list | `[]` | OpenAI base API URLs to use. Overwrites the value in openaiBaseApiUrl if set |
 | persistence.accessModes | list | `["ReadWriteOnce"]` | If using multiple replicas, you must update accessModes to ReadWriteMany |
@@ -85,6 +93,10 @@ helm upgrade --install open-webui open-webui/open-webui
 | podAnnotations | object | `{}` |  |
 | podLabels | object | `{}` |  |
 | podSecurityContext | object | `{}` | Configure pod security context ref: <https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-containe> |
+| rag.embeddingEngine | string | `""` | Embedding engine to use for RAG with env `RAG_EMBEDDING_ENGINE`: ""(empty), "ollama", "openai" ref: https://docs.openwebui.com/getting-started/env-configuration#rag_embedding_engine |
+| rag.embeddingModel | string | `""` | Embedding model to use for RAG with env `RAG_EMBEDDING_MODEL` ref: https://docs.openwebui.com/getting-started/env-configuration#rag_embedding_model |
+| rag.enabled | bool | `false` | Enable RAG ref: https://docs.openwebui.com/getting-started/env-configuration#retrieval-augmented-generation-rag |
+| rag.vectorDB | string | `""` | Vector database configuration ref: https://docs.openwebui.com/getting-started/env-configuration#vector_db |
 | readinessProbe | object | `{}` | Probe for readiness of the Open WebUI container ref: <https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes> |
 | redis-cluster | object | `{"auth":{"enabled":false},"enabled":false,"fullnameOverride":"open-webui-redis","replica":{"replicaCount":3}}` | Deploys a Redis cluster with subchart 'redis' from bitnami |
 | redis-cluster.auth | object | `{"enabled":false}` | Redis Authentication |

charts/open-webui/templates/NOTES.txt

@@ -1,11 +1,11 @@
 {{- `
 🎉 Welcome to Open WebUI!!
-  ___                    __        __   _     _   _ ___ 
- / _ \ _ __   ___ _ __  \ \      / /__| |__ | | | |_ _|
-| | | | '_ \ / _ \ '_ \  \ \ /\ / / _ \ '_ \| | | || | 
-| |_| | |_) |  __/ | | |  \ V  V /  __/ |_) | |_| || | 
- \___/| .__/ \___|_| |_|   \_/\_/ \___|_.__/ \___/|___|
-      |_|                                               
+ ██████╗ ██████╗ ███████╗███╗   ██╗    ██╗    ██╗███████╗██████╗ ██╗   ██╗██╗
+██╔═══██╗██╔══██╗██╔════╝████╗  ██║    ██║    ██║██╔════╝██╔══██╗██║   ██║██║
+██║   ██║██████╔╝█████╗  ██╔██╗ ██║    ██║ █╗ ██║█████╗  ██████╔╝██║   ██║██║
+██║   ██║██╔═══╝ ██╔══╝  ██║╚██╗██║    ██║███╗██║██╔══╝  ██╔══██╗██║   ██║██║
+╚██████╔╝██║     ███████╗██║ ╚████║    ╚███╔███╔╝███████╗██████╔╝╚██████╔╝██║
+ ╚═════╝ ╚═╝     ╚══════╝╚═╝  ╚═══╝     ╚══╝╚══╝ ╚══════╝╚═════╝  ╚═════╝ ╚═╝
 ` }}
 v{{ .Chart.AppVersion }} - building the best open-source AI user interface.
  - Chart Version: v{{ .Chart.Version }}
@@ -61,7 +61,7 @@ This interface allows you to easily interact with local AI models.
 3. Useful Commands:
   - Check deployment status:
       helm status {{ .Release.Name }} -n {{ .Release.Namespace }}
-  
+
   - Get detailed information:
       helm get all {{ .Release.Name }} -n {{ .Release.Namespace }}
 

charts/open-webui/templates/websocket-redis.yaml

@@ -26,6 +26,10 @@ spec:
         {{- toYaml . | nindent 4 }}
         {{- end }}
     spec:
+      {{- if .Values.websocket.redis.image.pullSecretName }}
+      imagePullSecrets:
+        - name: {{ .Values.websocket.redis.image.pullSecretName }}
+      {{- end }}
       containers:
       - name: {{ .Values.websocket.redis.name }}
         image: "{{ .Values.websocket.redis.image.repository }}:{{ .Values.websocket.redis.image.tag }}"

charts/open-webui/templates/workload-manager.yaml

@@ -121,22 +121,47 @@ spec:
         - name: "ENABLE_OLLAMA_API"
           value: "False"
         {{- end }}
-        {{- if and .Values.openaiBaseApiUrl (not .Values.openaiBaseApiUrls) (not .Values.pipelines.enabled) }}
+        {{- if and .Values.enableOpenaiApi .Values.openaiBaseApiUrl (not .Values.openaiBaseApiUrls) (not .Values.pipelines.enabled) }}
         # If only an OpenAI API value is set, set it to OPENAI_API_BASE_URL
         - name: "OPENAI_API_BASE_URL"
           value: {{ .Values.openaiBaseApiUrl | quote }}
-        {{- else if and .Values.openaiBaseApiUrl .Values.pipelines.enabled (not .Values.openaiBaseApiUrls) }}
+        {{- else if and .Values.enableOpenaiApi .Values.openaiBaseApiUrl .Values.pipelines.enabled (not .Values.openaiBaseApiUrls) }}
         # If Pipelines is enabled and OpenAI API value is set, use OPENAI_API_BASE_URLS with combined values
         - name: "OPENAI_API_BASE_URLS"
           value: "{{ include "pipelines.serviceEndpoint" . }};{{ .Values.openaiBaseApiUrl }}"
-        {{- else if and .Values.pipelines.enabled (not .Values.openaiBaseApiUrl) (not .Values.openaiBaseApiUrls) }}
+        {{- else if and .Values.enableOpenaiApi .Values.pipelines.enabled (not .Values.openaiBaseApiUrl) (not .Values.openaiBaseApiUrls) }}
         # If Pipelines is enabled and no OpenAI API values are set, set OPENAI_API_BASE_URL to the Pipelines server endpoint 
         - name: "OPENAI_API_BASE_URL"
           value: {{ include "pipelines.serviceEndpoint" . | quote }}
-        {{- else if and .Values.openaiBaseApiUrls .Values.pipelines.enabled }}
+        {{- else if and .Values.enableOpenaiApi .Values.openaiBaseApiUrls .Values.pipelines.enabled }}
         # If OpenAI API value(s) set and Pipelines is enabled, use OPENAI_API_BASE_URLS to support all the endpoints in the chart
         - name: "OPENAI_API_BASE_URLS"
           value: "{{ include "pipelines.serviceEndpoint" . }};{{ join ";" .Values.openaiBaseApiUrls }}"
+        {{- else if not .Values.enableOpenaiApi }}
+        - name: "ENABLE_OPENAI_API"
+          value: "False"
+        {{- end }}
+        {{- if .Values.rag.enabled }}
+        - name: "VECTOR_DB"
+          value: {{ .Values.rag.vectorDB | default "croma" | quote }}
+        {{- if and .Values.rag.enabled .Values.rag.embeddingEngine }}
+        - name: "RAG_EMBEDDING_ENGINE"
+          value: {{ .Values.rag.embeddingEngine | quote }}
+        {{- end }}
+        {{- if and .Values.rag.enabled .Values.rag.embeddingModel }}
+        - name: "RAG_EMBEDDING_MODEL"
+          value: {{ .Values.rag.embeddingModel | quote }}
+        {{- end }}
+        {{- end }}
+        {{- if .Values.milvus.enabled }}
+        - name: "MILVUS_URI"
+          value: {{ .Values.milvus.uri | default "${DATA_DIR}/vector_db/milvus.db" | quote }}
+        - name: "MILVUS_DB"
+          value: {{ .Values.milvus.db | default "default" | quote }}
+        {{- if and .Values.milvus.enabled .Values.milvus.token }}
+        - name: "MILVUS_TOKEN"
+          value: {{ .Values.milvus.token | quote }}
+        {{- end }}
         {{- end }}
         {{- if .Values.extraEnvVars }}
           {{- toYaml .Values.extraEnvVars | nindent 8 }}
@@ -172,6 +197,10 @@ spec:
       topologySpreadConstraints:
         {{- toYaml . | nindent 8 }}
       {{- end }}
+      {{- with .Values.hostAliases }}
+      hostAliases:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
       volumes:
       {{- if and .Values.persistence.enabled .Values.persistence.existingClaim }}
       - name: data

charts/open-webui/values-rag-milvus.yaml

@@ -0,0 +1,53 @@
+rag:
+  # -- Enable RAG
+  # ref: https://docs.openwebui.com/getting-started/env-configuration#retrieval-augmented-generation-rag
+  enabled: true
+  vectorDB: milvus
+  embeddingEngine: ""
+  embeddingModel: ""
+
+milvus:
+  # -- Enable Milvus installation. Deploys a Milvus cluster/standalone with subchart 'milvus' from zilliztech
+  # ref: https://github.com/zilliztech/milvus-helm/tree/master/charts/milvus
+  enabled: true
+  uri: "http://open-webui-milvus:19530"
+  db: default
+  token: {}
+  cluster:
+    enabled: false # This means that the Milvus runs with standalone mode
+  minio:
+    enabled: true
+    resources:
+      requests:
+        memory: 50Mi
+    persistence:
+      enabled: true
+      size: 1Gi
+  etcd:
+    enabled: true
+  pulsar:
+    enabled: false
+  pulsarv3:
+    enabled: false
+  kafka:
+    enabled: false
+  externalS3:
+    enabled: false
+  externalEtcd:
+    enabled: false
+
+livenessProbe:
+  httpGet:
+    path: /health
+    port: http
+readinessProbe:
+  httpGet:
+    path: /health/db
+    port: http
+startupProbe:
+  httpGet:
+    path: /health
+    port: http
+  initialDelaySeconds: 30 # Adjust this value according to the startup time of the application
+  periodSeconds: 10 # Adjust this value according to the startup time of the application
+  failureThreshold: 20 # Adjust this value according to the startup time of the application

charts/open-webui/values.yaml

@@ -106,6 +106,39 @@ redis-cluster:
     # -- Number of Redis replica instances
     replicaCount: 3
 
+rag:
+  # -- Enable RAG
+  # ref: https://docs.openwebui.com/getting-started/env-configuration#retrieval-augmented-generation-rag
+  enabled: false
+  # -- Vector database configuration
+  # ref: https://docs.openwebui.com/getting-started/env-configuration#vector_db
+  vectorDB: ""
+  # -- Embedding engine to use for RAG with env `RAG_EMBEDDING_ENGINE`: ""(empty), "ollama", "openai"
+  # ref: https://docs.openwebui.com/getting-started/env-configuration#rag_embedding_engine
+  embeddingEngine: ""
+  # -- Embedding model to use for RAG with env `RAG_EMBEDDING_MODEL`
+  # ref: https://docs.openwebui.com/getting-started/env-configuration#rag_embedding_model
+  embeddingModel: ""
+
+milvus:
+  # -- Enable Milvus installation. Deploys a Milvus cluster/standalone with subchart 'milvus' from zilliztech
+  # ref: https://github.com/zilliztech/milvus-helm/tree/master/charts/milvus
+  enabled: false
+  # -- Milvus fullname override (recommended to be 'open-webui-milvus')
+  # - In this case, the Milvus uri will be 'http://[username:password@]open-webui-milvus:19530'
+  fullnameOverride: open-webui-milvus
+  # -- Active Milvus URI for RAG with env `MILVUS_URI`. If there is credentials in the uri, it will be used to connect to the Milvus server.
+  # ref: https://docs.openwebui.com/getting-started/env-configuration#milvus_uri
+  uri: "http://open-webui-milvus:19530"
+  # -- Example `milvus.uri` with credentials (Not recommended for production. Use `env` with `secretKeyRef` instead)
+  # uri: "http://username:password@open-webui-milvus:19530"
+  # -- Active Milvus database for RAG with env `MILVUS_DB`
+  # ref: https://docs.openwebui.com/getting-started/env-configuration#milvus_db
+  db: default
+  # -- Active Milvus token for RAG with env `MILVUS_TOKEN`
+  # ref: https://docs.openwebui.com/getting-started/env-configuration#milvus_token
+  token: {}
+
 # -- Value of cluster domain
 clusterDomain: cluster.local
 
@@ -219,6 +252,9 @@ affinity: {}
 # -- Topology Spread Constraints for pod assignment
 topologySpreadConstraints: []
 
+# -- HostAliases to be added to hosts-file of each container
+hostAliases: []
+
 # -- Service values to expose Open WebUI pods to cluster
 service:
   type: ClusterIP
@@ -229,6 +265,9 @@ service:
   labels: {}
   loadBalancerClass: ""
 
+# Enables the use of OpenAI APIs
+enableOpenaiApi: true
+
 # -- OpenAI base API URL to use. Defaults to the Pipelines service endpoint when Pipelines are enabled, and "https://api.openai.com/v1" if Pipelines are not enabled and this value is blank
 openaiBaseApiUrl: "https://api.openai.com/v1"
 

charts/pipelines/Chart.yaml

@@ -1,6 +1,6 @@
 apiVersion: v2
 name: pipelines
-version: 0.2.0
+version: 0.4.0
 appVersion: "alpha"
 
 home: https://github.com/open-webui/pipelines

charts/pipelines/README.md

@@ -69,7 +69,9 @@ helm upgrade --install open-webui open-webui/pipelines
 | service.type | string | `"ClusterIP"` |  |
 | serviceAccount.automountServiceAccountToken | bool | `false` |  |
 | serviceAccount.enable | bool | `true` |  |
+| strategy | object | `{}` | Strategy for updating the deployment |
 | tolerations | list | `[]` | Tolerations for pod assignment |
+| hostAliases | list | `[]` | HostAliases to be added to hosts-file of each container |
 | volumeMounts | list | `[]` | Configure container volume mounts ref: <https://kubernetes.io/docs/tasks/configure-pod-container/configure-volume-storage/> |
 | volumes | list | `[]` | Configure pod volumes ref: <https://kubernetes.io/docs/tasks/configure-pod-container/configure-volume-storage/> |
 

charts/pipelines/templates/deployment.yaml

@@ -14,6 +14,10 @@ spec:
   selector:
     matchLabels:
       {{- include "pipelines.selectorLabels" . | nindent 6 }}
+  {{- with .Values.strategy }}
+  strategy:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
   template:
     metadata:
       labels:
@@ -70,6 +74,10 @@ spec:
       affinity:
         {{- toYaml . | nindent 8 }}
       {{- end }}
+      {{- with .Values.hostAliases }}
+      hostAliases:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
       volumes:
       {{- if and .Values.persistence.enabled .Values.persistence.existingClaim }}
       - name: data

charts/pipelines/values.yaml

@@ -8,6 +8,8 @@ annotations: {}
 podAnnotations: {}
 podLabels: {}
 replicaCount: 1
+# -- Strategy for updating the deployment
+strategy: {}
 image:
   repository: ghcr.io/open-webui/pipelines
   tag: main
@@ -53,6 +55,9 @@ tolerations: []
 # -- Affinity for pod assignment
 affinity: {}
 
+# -- HostAliases to be added to hosts-file of each container
+hostAliases: []
+
 service:
   type: ClusterIP
   annotations: {}