Add redis for websocket #137

jyje · 2025-01-11T08:00:18Z

Opinion

Important

I tested this feature in local k8s and personal on-premise k8s. To verify clearly, I hope you guys test and improve with me

Hello folks.

To resolve #135, I added redis deployments for websocket supports without PV+PVC or HA settings. This is small installation scenario in here. After merging this, I will propose the installation of HA redis cluster from bitnami chart step-by-step. Please give me any advise.

Thank you

Copilot Summary

This pull request introduces websocket support to the Open WebUI Helm chart, along with several related enhancements and configurations. The most important changes include adding websocket configuration options, defining Redis deployment and service templates, and updating the chart version.

Websocket support and configuration:

charts/open-webui/README.md: Added websocket configuration options, including enabling websocket support, specifying the websocket manager, and configuring Redis settings.
charts/open-webui/values.yaml: Introduced websocket configuration parameters such as enabling websocket support, specifying the websocket manager, and defining Redis settings.

Redis deployment and service templates:

charts/open-webui/templates/websocket-redis.yaml: Added a new template for Redis deployment and service, which includes labels, annotations, and container specifications.
charts/open-webui/templates/_helpers.tpl: Defined helper functions for creating labels and selector labels for websocket resources.

Chart version update:

charts/open-webui/Chart.yaml: Updated the chart version from 5.1.1 to 5.2.0.

…r readme and values

jyje · 2025-01-11T15:29:33Z

By this doc(redis verification), maybe, I can verify redis configuration for 3 scenarios in #135 (Small, Full, External). I will soon be able to ready this draft for review 🥹.

- add values and corresponding readme - add subchart **redis-20.6.2**

jyje · 2025-01-11T17:37:51Z

Note

If there is something wrong. Please comment and improve it together.

Hello folks. I tired add Redis. Please review these commands for reproducing together.

0. Default (+Prerequirement)

kind create cluster -n owui-websocket
git clone -b feat/websocket-with-redis https://github.com/jyje/owui-helm-charts.git
cd owui-helm-charts

helm template owui-default ./charts/open-webui \
  --namespace owui-default --create-namespace \
  --set 'extraEnvVars[0].name=SOCKET_LOG_LEVEL' \
  --set 'extraEnvVars[0].value=DEBUG' \
  > owui-default.yaml

kubectl create namespace owui-default
kubectl apply -f owui-default.yaml

kubectl wait -n owui-default --for=condition=Ready pod/open-webui-0
kubectl get -n owui-default all
kubectl logs -n owui-default pod/open-webui-0 -c open-webui | grep "open_webui.socket"

## You may see:
# DEBUG [open_webui.socket.main] Running periodic_usage_pool_cleanup

kubectl delete namespace owui-default

1. Small Installation

a single redis pod from deployment

helm template owui-small ./charts/open-webui \
  --namespace owui-small --create-namespace \
  --set websocket.enabled=true \
  --set 'extraEnvVars[0].name=SOCKET_LOG_LEVEL' \
  --set 'extraEnvVars[0].value=DEBUG' \
  > owui-small.yaml

kubectl create namespace owui-small
kubectl apply -f owui-small.yaml

kubectl wait -n owui-small --for=condition=Ready pod/open-webui-0
kubectl get -n owui-small all
kubectl logs -n owui-small pod/open-webui-0 -c open-webui | grep "open_webui.socket"

## You may see:
# DEBUG:open_webui.socket.main:Using Redis to manage websockets.
# DEBUG [open_webui.socket.main] Running periodic_usage_pool_cleanup

kubectl delete namespace owui-small

2. Full Installation

deploy and connect redis chart

helm template owui-full ./charts/open-webui \
  --namespace owui-full --create-namespace \
  --set websocket.enabled=true \
  --set websocket.redis.enabled=false \
  --set websocket.url=redis://open-webui-redis-master:6379/0 \
  --set redis-cluster.enabled=true \
  --set 'extraEnvVars[0].name=SOCKET_LOG_LEVEL' \
  --set 'extraEnvVars[0].value=DEBUG' \
  > owui-full.yaml

kubectl create namespace owui-full
kubectl apply -f owui-full.yaml

kubectl wait -n owui-full --for=condition=Ready pod/open-webui-0
kubectl get -n owui-full all
kubectl logs -n owui-full pod/open-webui-0 -c open-webui | grep "open_webui.socket"

## You may see:
# DEBUG:open_webui.socket.main:Using Redis to manage websockets.
# DEBUG [open_webui.socket.main] Running periodic_usage_pool_cleanup

kubectl delete namespace owui-full

3. External Installation

connect external redis url (no redis in k8s)

# please set url to `localhost:6379` or `redis.example.com`
helm template owui-external ./charts/open-webui \
  --namespace owui-external --create-namespace \
  --set websocket.enabled=true \
  --set websocket.redis.enabled=false \
  --set websocket.url=redis://redis.example.com/0 \
  --set 'extraEnvVars[0].name=SOCKET_LOG_LEVEL' \
  --set 'extraEnvVars[0].value=DEBUG' \
  > owui-external.yaml

kubectl create namespace owui-external
kubectl apply -f owui-external.yaml

kubectl wait -n owui-external --for=condition=Ready pod/open-webui-0
kubectl get -n owui-external all
kubectl logs -n owui-external pod/open-webui-0 -c open-webui | grep "open_webui.socket"

## You may see:
# DEBUG:open_webui.socket.main:Using Redis to manage websockets.
# DEBUG [open_webui.socket.main] Running periodic_usage_pool_cleanup

kubectl delete namespace owui-external

Copilot Summary

This pull request introduces several significant updates to the open-webui Helm chart. The main changes include version upgrades, the addition of Redis and WebSocket support, and the corresponding updates to configuration files and templates.

Version Upgrade:

charts/open-webui/Chart.yaml: Updated the chart version from 5.1.1 to 5.2.0.

Note

Proposed version needs to be checked

Redis Support:

charts/open-webui/Chart.yaml: Added Redis as a new dependency.
charts/open-webui/README.md: Added new configuration options for enabling Redis installation and setting up Redis cluster parameters.
charts/open-webui/templates/_helpers.tpl: Added helper templates to create selector labels and labels for WebSocket resources.
charts/open-webui/templates/websocket-redis.yaml: Added a new template for deploying Redis when WebSocket support is enabled.

WebSocket Support:

charts/open-webui/README.md: Added new configuration options for enabling WebSocket support and specifying WebSocket manager and Redis settings.
charts/open-webui/templates/workload-manager.yaml: Updated the workload manager template to include environment variables for WebSocket support.
charts/open-webui/values.yaml: Added new configuration values for WebSocket and Redis settings.

jyje · 2025-01-11T17:53:45Z

I tested using above 3 set of commands

Here is test kind cluster:

And here is log of an owui websocket mode with a bitnami redis chart

0xThresh · 2025-01-13T15:42:43Z

Hi @jyje, thank you for another amazing PR. I haven't had the chance to test this one out yet but should hopefully be able to do so in the next few days so we can get this merged if it all works. I'll let you know if I run into any issues when I get a chance to try this out!

tkg61 · 2025-01-16T16:20:31Z

i just tested this and everything deployed correctly with a full deployment. Since this doesn't have the ingress object (which is fine since the main chart does), i will see about testing it with ingress to see if i can get multiple replicas of OWUI working

tkg61 · 2025-01-16T16:24:14Z

i see this in the debug logs to tell me that websockets are being used after the "redis is being used for websockets" log has already been seen:

INFO: 127.0.0.1:58712 - "GET /_app/immutable/nodes/33._Z7U-bfm.js HTTP/1.1" 200 OK INFO: ('127.0.0.1', 58790) - "WebSocket /ws/socket.io/?EIO=4&transport=websocket" [accepted] INFO: connection open INFO: 127.0.0.1:58756 - "GET /_app/immutable/assets/33.ew8BNFsq.css HTTP/1.1" 200 OK

jyje · 2025-01-17T00:37:55Z

@tkg61 Glad to hear the installation works well! I'll test multiple replicas with Ingress or LoadBalancer soon.
@0xThresh I just checked the contributing guide and realized I missed some dependencies. Next time, I'll make sure to review the chart lock, pipeline YAML, and other details to complete the new subchart properly!

Thanks!

tkg61 · 2025-01-17T02:07:49Z

Websockets are definitely causing a hiccup for the normal nginx ingress. open-webui/open-webui#5109

I think might need a service mesh like Istio that can handle it more easily which is what I am testing

could easily add it in the helm repo if HA is needed

jyje · 2025-01-17T11:55:46Z

@tkg61 Thank you. I realized that I already applied your ingress solution on my home cluster.

Here is my demo.
I'm trying test the full redis installation with HA & ingress. The test codes are written as Argo CD Application CRD.

Remarkable values are followings:

  replicaCount: 3
        ingress:
          enabled: true
          class: nginx
          annotations:
            cert-manager.io/cluster-issuer: letsencrypt-prod
            nginx.ingress.kubernetes.io/configuration-snippet: |
              more_set_headers "Access-Control-Allow-Origin: $http_origin";
            nginx.ingress.kubernetes.io/cors-allow-credentials: "true"
            nginx.ingress.kubernetes.io/cors-allow-headers: X-Api-Key
            nginx.ingress.kubernetes.io/cors-allow-methods: HEAD
            nginx.ingress.kubernetes.io/enable-cors: "true"
            nginx.ingress.kubernetes.io/affinity: "cookie"
            nginx.ingress.kubernetes.io/session-cookie-name: "route"
            nginx.ingress.kubernetes.io/session-cookie-expires: "172800"
            nginx.ingress.kubernetes.io/session-cookie-max-age: "172800"
            nginx.ingress.kubernetes.io/proxy-body-size: "4096m"
          host: llm.app.jyje.live
          tls: true
          existingSecret: llm-letsencrypt-tls
        persistence:
          enabled: true
          size: 10Gi
          accessModes:
            - ReadWriteMany
        extraEnvVars:
          - name: SOCKET_LOG_LEVEL
            value: debug
        websocket:
          enabled: true
          url: redis://open-webui-redis-master:6379/0
          redis:
            enabled: false
        redis-cluster:
          enabled: true

And here is results of implementation

top: full installation with 3 replicas of open-webui pods
bottom: log of the pods open-webui-*

The log is following capture:

Can we say redis websocket is working with this experiment?

jyje added 8 commits January 7, 2025 19:58

ci(test): enable chart release for test

72a3242

feat(websocket): add envs and pilot of redis

1c072ce

feat(websocket): fix type of '_helpers.tpl'

added76

feat(websocket): fix labels and port and remove security contexts

9b13a7e

feat(websocket): change redis name and set container resources

f06ddd9

feat(websocket): fix labels and annotations

5359859

chore(websocket): revert test lines for release workflows and refacto…

51aab38

…r readme and values

chore(websocket): fix enabled flag

3b1bfc2

jyje force-pushed the feat/websocket-with-redis branch from f1a6c78 to 3b1bfc2 Compare January 11, 2025 14:17

jyje added 2 commits January 12, 2025 01:34

feat(websocket): add redis-cluster from bitnami chart

0ccce3c

- add values and corresponding readme - add subchart **redis-20.6.2**

chore(websocket): fix chart dependency

1e17c56

jyje marked this pull request as ready for review January 11, 2025 17:37

chore(websocket): fix full redis url

b894afc

jyje added 4 commits January 15, 2025 02:29

chore(websocket): bump a target chart version to 5.3.0

64160c1

Merge branch 'main' into feat/websocket-with-redis

972a245

Merge branch 'main' into feat/websocket-with-redis

9c9aae9

chore(ci): bump a target chart version of open-webui to 5.4.0

4421135

0xThresh merged commit b3c486f into open-webui:main Jan 16, 2025
2 checks passed

jyje deleted the feat/websocket-with-redis branch January 17, 2025 00:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add redis for websocket #137

Add redis for websocket #137

jyje commented Jan 11, 2025

jyje commented Jan 11, 2025

jyje commented Jan 11, 2025 •

edited

Loading

jyje commented Jan 11, 2025

0xThresh commented Jan 13, 2025

tkg61 commented Jan 16, 2025

tkg61 commented Jan 16, 2025

jyje commented Jan 17, 2025

tkg61 commented Jan 17, 2025

jyje commented Jan 17, 2025 •

edited

Loading

Add redis for websocket #137

Add redis for websocket #137

Conversation

jyje commented Jan 11, 2025

Opinion

Copilot Summary

jyje commented Jan 11, 2025

jyje commented Jan 11, 2025 • edited Loading

0. Default (+Prerequirement)

1. Small Installation

2. Full Installation

3. External Installation

Copilot Summary

jyje commented Jan 11, 2025

0xThresh commented Jan 13, 2025

tkg61 commented Jan 16, 2025

tkg61 commented Jan 16, 2025

jyje commented Jan 17, 2025

tkg61 commented Jan 17, 2025

jyje commented Jan 17, 2025 • edited Loading

jyje commented Jan 11, 2025 •

edited

Loading

jyje commented Jan 17, 2025 •

edited

Loading