Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add helm notes (Helper Message) #139

Merged
merged 2 commits into from
Jan 14, 2025
Merged

Conversation

jyje
Copy link
Contributor

@jyje jyje commented Jan 14, 2025

Opinion

To resolve #66, I made pilot helm NOTES.txt for open-webui chart (as Helper Message).

Example: open-webui notes with ingress+tls

This is an example command

helm upgrade --install --cleanup-on-fail \
    -n owui-ingress --create-namespace \
    --set ingress.enabled=true \
    --set ingress.class=nginx \
    --set ingress.host=owui.example.com \
    --set ingress.tls=true \
    --set ingress.existingSecret=owui-tls \
    owui-ingress .

And this is corresponding note (helper message)

🎉 Welcome to Open WebUI!!
  ___                    __        __   _     _   _ ___ 
 / _ \ _ __   ___ _ __  \ \      / /__| |__ | | | |_ _|
| | | | '_ \ / _ \ '_ \  \ \ /\ / / _ \ '_ \| | | || | 
| |_| | |_) |  __/ | | |  \ V  V /  __/ |_) | |_| || | 
 \___/| .__/ \___|_| |_|   \_/\_/ \___|_.__/ \___/|___|
      |_|                                               

v0.5.4 - building the best open-source AI user interface.
 - Chart Version: v5.2.0
 - Project URL 1: https://www.openwebui.com/
 - Project URL 2: https://github.com/open-webui/open-webui
 - Documentation: https://docs.openwebui.com/
 - Chart URL: https://github.com/open-webui/helm-charts

Open WebUI is a web-based user interface that works with Ollama, OpenAI, Claude 3, Gemini and more.
This interface allows you to easily interact with local AI models.

1. Deployment Information:
  - Chart Name: open-webui
  - Release Name: owui-ingress
  - Namespace: owui-ingress

2. Access the Application:
  Access via ClusterIP service:

    export LOCAL_PORT=8080
    export POD_NAME=$(kubectl get pods -n owui-ingress -l "app.kubernetes.io/component=open-webui" -o jsonpath="{.items[0].metadata.name}")
    export CONTAINER_PORT=$(kubectl get pod -n owui-ingress $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}")
    kubectl -n owui-ingress port-forward $POD_NAME $LOCAL_PORT:$CONTAINER_PORT
    echo "Visit http://127.0.0.1:$LOCAL_PORT to use your application"

  Then, access the application at: http://127.0.0.1:$LOCAL_PORT or http://localhost:8080

  Ingress is enabled. Access the application at: https://owui.example.com

3. Useful Commands:
  - Check deployment status:
      helm status owui-ingress -n owui-ingress
  
  - Get detailed information:
      helm get all owui-ingress -n owui-ingress

  - View logs:
      kubectl logs -f statefulset/open-webui -n owui-ingress

4. Cleanup:
  - Uninstall the deployment:
      helm uninstall owui-ingress -n owui-ingress

image

Demo: open-webui notes with various settings

I recorded for 4 scenarios with following codes:

git clone -b feat/owui-notes https://github.com/jyje/owui-helm-charts
cd owui-helm-charts/charts/open-webui

kind create cluster --name owui-notes
kubectl config use-context kind-owui-notes

# 1. Install the default chart
helm upgrade --install --cleanup-on-fail \
    -n owui-default --create-namespace \
    owui-default .

# 2. Install the deploy chart
helm upgrade --install --cleanup-on-fail \
    -n owui-deploy --create-namespace \
    --set persistence.enabled=false \
    owui-deploy .

# 3. Install the nodeport chart
helm upgrade --install --cleanup-on-fail \
    -n owui-nodeport --create-namespace \
    --set service.type=NodePort \
    owui-nodeport .

# 4. Install the loadbalancer chart
helm upgrade --install --cleanup-on-fail \
    -n owui-loadbalancer --create-namespace \
    --set service.type=LoadBalancer \
    owui-loadbalancer .

Please check Demo in asciicast:
asciicast

If there are typo or good suggestion, please let me know.


Copilot Summary

This pull request includes updates to the Open WebUI Helm chart, specifically enhancing the user experience with the NOTES.txt file and updating the chart version.

Chart version update:

Enhanced user experience:

  • charts/open-webui/templates/NOTES.txt: Added a detailed welcome message and instructions for accessing and managing the Open WebUI application, including deployment information, access methods, useful commands, and cleanup instructions.

jyje added 2 commits January 15, 2025 00:14
- case-by-case helm notes per service type, per persistence
- note sections
    1. Deployment Information
    2. Access the Application
    3. Useful Commands
    4. Cleanup
@0xThresh 0xThresh merged commit 1c9327e into open-webui:main Jan 14, 2025
2 checks passed
@jyje jyje deleted the feat/owui-notes branch January 14, 2025 17:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enhancement: Add Helper Message
2 participants