Merge pull request #26 from 0xThresh/feat-pipelines

Add Pipelines chart

CONTRIBUTING.md

@@ -0,0 +1,33 @@
+# Contributing to the Open WebUI Helm Charts
+
+## How to Contribute
+
+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. **Commit your changes** using a descriptive commit message that follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
+5. **Push your changes** to your forked repository.
+6. **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. 
+
+## Guidelines
+
+- **Semantic Versioning**: This repository follows [Semantic Versioning](https://semver.org/) for versioning the Helm Charts. When making changes, please ensure that you update the version in the `Chart.yaml` file according to the following rules:
+  - `MAJOR` version increment for incompatible chart changes
+  - `MINOR` version increment for backwards-compatible functionality additions
+  - `PATCH` version increment for backwards-compatible bug fixes
+
+- **Chart.yaml Updates**: When submitting a Pull Request, ensure that you have updated the `Chart.yaml` file with the appropriate version increment and a brief description of the changes in the `appVersion` field.
+
+- **Code Style**: Follow the existing code style and conventions used in the repository.
+
+- **Documentation**: If your changes require documentation updates, please include them in your Pull Request.
+
+- **Testing**: Before submitting your Pull Request, ensure that your changes work as expected by testing them locally. This should include deploying your updates to a live Kubernetes cluster (whether local or remote).
+
+- **Issues**: If you find any issues or have suggestions for improvements, please create a new issue in the repository before working on a Pull Request.
+
+## Getting Help
+
+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!

charts/open-webui/Chart.yaml

@@ -1,6 +1,6 @@
 apiVersion: v2
 name: open-webui
-version: 2.0.1
+version: 2.1.0
 appVersion: "latest"
 
 home: https://www.openwebui.com/
@@ -8,15 +8,15 @@ icon: https://raw.githubusercontent.com/open-webui/open-webui/main/static/favico
 
 description: "Open WebUI: A User-Friendly Web Interface for Chat Interactions 👋"
 keywords:
-- llm
-- chat
-- web-ui
+  - llm
+  - chat
+  - web-ui
 
 sources:
-- https://github.com/open-webui/helm-charts
-- https://github.com/open-webui/open-webui/pkgs/container/open-webui
-- https://github.com/otwld/ollama-helm/
-- https://hub.docker.com/r/ollama/ollama
+  - https://github.com/open-webui/helm-charts
+  - https://github.com/open-webui/open-webui/pkgs/container/open-webui
+  - https://github.com/otwld/ollama-helm/
+  - https://hub.docker.com/r/ollama/ollama
 
 annotations:
   licenses: MIT
@@ -26,7 +26,6 @@ dependencies:
     repository: https://otwld.github.io/ollama-helm/
     version: ">=0.24.0"
     import-values:
-      
       - child: service
         parent: ollama.service
     condition: ollama.enabled

charts/open-webui/README.md

@@ -1,6 +1,6 @@
 # open-webui
 
-![Version: 2.0.0](https://img.shields.io/badge/Version-2.0.0-informational?style=flat-square) ![AppVersion: latest](https://img.shields.io/badge/AppVersion-latest-informational?style=flat-square)
+![Version: 2.0.2](https://img.shields.io/badge/Version-2.0.2-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 👋
 
@@ -38,8 +38,10 @@ helm upgrade --install open-webui open-webui/open-webui
 
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
+| affinity | object | `{}` | Affinity for pod assignment |
 | annotations | object | `{}` |  |
 | clusterDomain | string | `"cluster.local"` | Value of cluster domain |
+| extraEnvVars | list | `[]` | Additional environments variables on the output Deployment definition. |
 | image.pullPolicy | string | `"Always"` |  |
 | image.repository | string | `"ghcr.io/open-webui/open-webui"` |  |
 | image.tag | string | `""` |  |
@@ -50,7 +52,7 @@ helm upgrade --install open-webui open-webui/open-webui
 | ingress.host | string | `""` |  |
 | ingress.tls | bool | `false` |  |
 | nameOverride | string | `""` |  |
-| nodeSelector | object | `{}` |  |
+| nodeSelector | object | `{}` | Node labels for pod assignment. |
 | ollama.enabled | bool | `true` | Automatically install Ollama Helm chart from https://otwld.github.io/ollama-helm/. Use [Helm Values](https://github.com/otwld/ollama-helm/#helm-values) to configure |
 | 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. |
 | persistence.accessModes | list | `["ReadWriteOnce"]` | If using multiple replicas, you must update accessModes to ReadWriteMany |
@@ -70,7 +72,7 @@ helm upgrade --install open-webui open-webui/open-webui
 | service.nodePort | string | `""` |  |
 | service.port | int | `80` |  |
 | service.type | string | `"ClusterIP"` |  |
-| tolerations | list | `[]` |  |
+| tolerations | list | `[]` | Tolerations for pod assignment |
 
 ----------------------------------------------
 

charts/open-webui/templates/deployment.yaml

@@ -42,11 +42,22 @@ spec:
         env:
         - name: OLLAMA_BASE_URLS
           value: {{ include "ollamaBaseUrls" . | quote }}
+        {{- if .Values.extraEnvVars }}
+          {{- toYaml .Values.extraEnvVars | nindent 8 }}
+        {{- end }}
         tty: true
       {{- with .Values.nodeSelector }}
       nodeSelector:
         {{- toYaml . | nindent 8 }}
       {{- end }}
+      {{- with .Values.tolerations }}
+      tolerations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.affinity }}
+      affinity:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
       volumes:
       {{- if and .Values.persistence.enabled .Values.persistence.existingClaim }}
       - name: data
@@ -59,4 +70,4 @@ spec:
       - name: data
         persistentVolumeClaim:
           claimName: {{ include "open-webui.name" . }}
-      {{- end }}
+      {{- end }}

charts/open-webui/values.yaml

@@ -9,13 +9,12 @@ ollama:
   #     enabled: true
   #     type: 'nvidia'
   #     number: 1
-  #   models: 
+  #   models:
   #     - llama3
   # runtimeClassName: nvidia
   # persistentVolume:
   #   enabled: true
 
-
 # -- A list of Ollama API endpoints. These can be added in lieu of automatically installing the Ollama Helm chart, or in addition to it.
 ollamaUrls: []
 
@@ -45,12 +44,20 @@ persistence:
   existingClaim: ""
   # -- If using multiple replicas, you must update accessModes to ReadWriteMany
   accessModes:
-  - ReadWriteOnce
+    - ReadWriteOnce
   storageClass: ""
   selector: {}
   annotations: {}
+
+# -- Node labels for pod assignment.
 nodeSelector: {}
+
+# -- Tolerations for pod assignment
 tolerations: []
+
+# -- Affinity for pod assignment
+affinity: {}
+
 service:
   type: ClusterIP
   annotations: {}
@@ -58,4 +65,14 @@ service:
   containerPort: 8080
   nodePort: ""
   labels: {}
-  loadBalancerClass: "" 
+  loadBalancerClass: ""
+
+# -- Additional environments variables on the output Deployment definition.
+extraEnvVars:
+  # - name: OPENAI_API_KEY
+  #   valueFrom:
+  #     secretKeyRef:
+  #       name: openai-api-key
+  #       key: api-key
+  # - name: OLLAMA_DEBUG
+  #   value: "1"

charts/pipelines/Chart.yaml

@@ -0,0 +1,20 @@
+apiVersion: v2
+name: pipelines
+version: 0.0.1
+appVersion: "alpha"
+
+home: https://github.com/open-webui/pipelines
+icon: https://github.com/open-webui/pipelines/raw/main/header.png
+
+description: "Pipelines: UI-Agnostic OpenAI API Plugin Framework"
+keywords:
+  - llm
+  - chat
+  - web-ui
+
+sources:
+  - https://github.com/open-webui/helm-charts
+  - https://github.com/open-webui/pipelines/pkgs/container/pipelines
+
+annotations:
+  licenses: MIT

charts/pipelines/README.md

@@ -0,0 +1,70 @@
+# pipelines
+
+![Version: 0.0.1](https://img.shields.io/badge/Version-0.0.1-informational?style=flat-square) ![AppVersion: alpha](https://img.shields.io/badge/AppVersion-alpha-informational?style=flat-square)
+
+Pipelines: UI-Agnostic OpenAI API Plugin Framework
+
+**Homepage:** <https://github.com/open-webui/pipelines>
+
+## Source Code
+
+* <https://github.com/open-webui/helm-charts>
+* <https://github.com/open-webui/pipelines/pkgs/container/pipelines>
+
+## 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/pipelines
+```
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| affinity | object | `{}` | Affinity for pod assignment |
+| annotations | object | `{}` |  |
+| clusterDomain | string | `"cluster.local"` | Value of cluster domain |
+| extraEnvVars | list | `[{"name":"PIPELINES_URLS","value":"https://github.com/open-webui/pipelines/blob/main/examples/filters/detoxify_filter_pipeline.py"}]` | Additional environments variables on the output Deployment definition. These are used to pull initial Pipeline files, and help configure Pipelines with required values (e.g. Langfuse API keys) |
+| extraEnvVars[0] | object | `{"name":"PIPELINES_URLS","value":"https://github.com/open-webui/pipelines/blob/main/examples/filters/detoxify_filter_pipeline.py"}` | Example pipeline to pull and load on deployment startup, see current pipelines here: https://github.com/open-webui/pipelines/blob/main/examples |
+| image.pullPolicy | string | `"Always"` |  |
+| image.repository | string | `"ghcr.io/open-webui/pipelines"` |  |
+| image.tag | string | `"main"` |  |
+| ingress.annotations | object | `{}` | Use appropriate annotations for your Ingress controller, e.g., for NGINX: nginx.ingress.kubernetes.io/rewrite-target: / |
+| ingress.class | string | `""` |  |
+| ingress.enabled | bool | `true` |  |
+| ingress.existingSecret | string | `""` |  |
+| ingress.host | string | `""` |  |
+| ingress.tls | bool | `false` |  |
+| nameOverride | string | `""` |  |
+| nodeSelector | object | `{}` | Node labels for pod assignment. |
+| persistence.accessModes | list | `["ReadWriteOnce"]` | If using multiple replicas, you must update accessModes to ReadWriteMany |
+| persistence.annotations | object | `{}` |  |
+| persistence.enabled | bool | `true` |  |
+| persistence.existingClaim | string | `""` |  |
+| persistence.selector | object | `{}` |  |
+| persistence.size | string | `"2Gi"` |  |
+| persistence.storageClass | string | `""` |  |
+| podAnnotations | object | `{}` |  |
+| replicaCount | int | `1` |  |
+| resources | object | `{}` |  |
+| service.annotations | object | `{}` |  |
+| service.containerPort | int | `9099` |  |
+| service.labels | object | `{}` |  |
+| service.loadBalancerClass | string | `""` |  |
+| service.nodePort | string | `""` |  |
+| service.port | int | `9099` |  |
+| service.type | string | `"ClusterIP"` |  |
+| tolerations | list | `[]` | Tolerations for pod assignment |
+
+----------------------------------------------
+
+Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs/).

charts/pipelines/README.md.gotmpl

@@ -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/pipelines
+```
+
+{{ template "chart.requirementsSection" . }}
+
+{{ template "chart.valuesSection" . }}
+
+----------------------------------------------
+
+Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs/).

charts/pipelines/templates/_helpers.tpl

@@ -0,0 +1,29 @@
+{{- define "pipelines.name" -}}
+{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
+{{- end -}}
+
+{{- define "chart.name" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{- define "base.labels" -}}
+helm.sh/chart: {{ include "chart.name" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end }}
+
+{{- define "base.selectorLabels" -}}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end -}}
+
+{{- define "pipelines.selectorLabels" -}}
+{{ include "base.selectorLabels" . }}
+app.kubernetes.io/component: {{ .Chart.Name }}
+{{- end }}
+
+{{- define "pipelines.labels" -}}
+{{ include "base.labels" . }}
+{{ include "pipelines.selectorLabels" . }}
+{{- end }}

charts/pipelines/templates/deployment.yaml

@@ -0,0 +1,71 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ include "pipelines.name" . }}
+  labels:
+    {{- include "pipelines.labels" . | nindent 4 }}
+  {{- with .Values.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+spec:
+  replicas: {{ .Values.replicaCount }}
+  selector:
+    matchLabels:
+      {{- include "pipelines.selectorLabels" . | nindent 6 }}
+  template:
+    metadata:
+      labels:
+        {{- include "pipelines.labels" . | nindent 8 }}
+      {{- with .Values.podAnnotations }}
+      annotations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+    spec:
+      enableServiceLinks: false
+      automountServiceAccountToken: false
+      containers:
+      - name: {{ .Chart.Name }}
+        {{- with .Values.image }}
+        image: {{ .repository }}:{{ .tag | default $.Chart.AppVersion }}
+        imagePullPolicy: {{ .pullPolicy }}
+        {{- end }}
+        ports:
+        - name: http
+          containerPort: {{ .Values.service.containerPort }}
+        {{- with .Values.resources }}
+        resources: {{- toYaml . | nindent 10 }}
+        {{- end }}
+        volumeMounts:
+        - name: data
+          mountPath: /app/backend/data
+        env:
+        {{- if .Values.extraEnvVars }}
+          {{- toYaml .Values.extraEnvVars | nindent 8 }}
+        {{- end }}
+        tty: true
+      {{- with .Values.nodeSelector }}
+      nodeSelector:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.tolerations }}
+      tolerations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.affinity }}
+      affinity:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      volumes:
+      {{- if and .Values.persistence.enabled .Values.persistence.existingClaim }}
+      - name: data
+        persistentVolumeClaim:
+          claimName: {{ .Values.persistence.existingClaim }}
+      {{- else if not .Values.persistence.enabled }}
+      - name: data
+        emptyDir: {}
+      {{- else if and .Values.persistence.enabled (not .Values.persistence.existingClaim) }}
+      - name: data
+        persistentVolumeClaim:
+          claimName: {{ include "pipelines.name" . }}
+      {{- end }}

charts/pipelines/templates/pvc.yaml

@@ -0,0 +1,27 @@
+{{- if and .Values.persistence.enabled (not .Values.persistence.existingClaim) }}
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: {{ include "pipelines.name" . }}
+  labels:
+    {{- include "pipelines.selectorLabels" . | nindent 4 }}
+  {{- with .Values.persistence.annotations }}
+  annotations:
+    {{- toYaml . | nindent 8 }}
+  {{- end }}
+spec:
+  accessModes:
+    {{- range .Values.persistence.accessModes }}
+    - {{ . | quote }}
+    {{- end }}
+  resources:
+    requests:
+      storage: {{ .Values.persistence.size }}
+  {{- if .Values.persistence.storageClass }}
+  storageClassName: {{ .Values.persistence.storageClass }}
+  {{- end }}
+  {{- with .Values.persistence.selector }}
+  selector:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+{{- end }}

charts/pipelines/templates/service.yaml

@@ -0,0 +1,29 @@
+apiVersion: v1
+kind: Service
+metadata:
+  name: {{ include "pipelines.name" . }}
+  labels:
+    {{- include "pipelines.labels" . | nindent 4 }}
+    {{- with .Values.service.labels }}
+    {{- toYaml . | nindent 4 }}
+    {{- end }}
+  {{- with .Values.service.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+spec:
+  selector:
+    {{- include "pipelines.selectorLabels" . | nindent 4 }}
+  type: {{ .Values.service.type | default "ClusterIP" }}
+  ports:
+  - protocol: TCP
+    name: http
+    port: {{ .Values.service.port }}
+    targetPort: http
+    {{- if .Values.service.nodePort }}
+    nodePort: {{ .Values.service.nodePort | int }}
+    {{- end }}
+  {{- if .Values.service.loadBalancerClass }}
+  loadBalancerClass: {{ .Values.service.loadBalancerClass | quote }}
+  {{- end }}
+  

charts/pipelines/values.yaml

@@ -0,0 +1,71 @@
+nameOverride: ""
+
+# -- Value of cluster domain
+clusterDomain: cluster.local
+
+annotations: {}
+podAnnotations: {}
+replicaCount: 1
+image:
+  repository: ghcr.io/open-webui/pipelines
+  tag: main
+  pullPolicy: Always
+resources: {}
+ingress:
+  enabled: true
+  class: ""
+  # -- Use appropriate annotations for your Ingress controller, e.g., for NGINX:
+  # nginx.ingress.kubernetes.io/rewrite-target: /
+  annotations: {}
+  host: ""
+  tls: false
+  existingSecret: ""
+persistence:
+  enabled: true
+  size: 2Gi
+  existingClaim: ""
+  # -- If using multiple replicas, you must update accessModes to ReadWriteMany
+  accessModes:
+    - ReadWriteOnce
+  storageClass: ""
+  selector: {}
+  annotations: {}
+
+# -- Node labels for pod assignment.
+nodeSelector: {}
+
+# -- Tolerations for pod assignment
+tolerations: []
+
+# -- Affinity for pod assignment
+affinity: {}
+
+service:
+  type: ClusterIP
+  annotations: {}
+  port: 9099
+  containerPort: 9099
+  nodePort: ""
+  labels: {}
+  loadBalancerClass: ""
+
+# -- Additional environments variables on the output Deployment definition. These are used to pull initial Pipeline files, and help configure Pipelines with required values (e.g. Langfuse API keys)
+extraEnvVars:
+  # -- Example pipeline to pull and load on deployment startup, see current pipelines here: https://github.com/open-webui/pipelines/blob/main/examples
+  - name: PIPELINES_URLS
+    value: "https://github.com/open-webui/pipelines/blob/main/examples/filters/detoxify_filter_pipeline.py"
+  # -- Langfuse example, including values used in Langfuse filter to connect
+  # - name: PIPELINES_URLS
+  #   value: "https://github.com/open-webui/pipelines/blob/main/examples/filters/langfuse_filter_pipeline.py"  
+  # - name: LANGFUSE_PUBLIC_KEY
+  #   valueFrom:
+  #     secretKeyRef: 
+  #       name: langfuse-keys
+  #       key: public-key
+  # - name: LANGFUSE_SECRET_KEY
+  #   valueFrom:
+  #     secretKeyRef: 
+  #       name: langfuse-keys
+  #       key: secret-key
+  # - name: LANGFUSE_HOST
+  #   value: https://us.cloud.langfuse.com