Skip to content

Open WebUI

In this example, we will create an "App SKU" for Open WebUI distributed as a Docker Container via DockerHub. The app itself is available via a public registry at "ghcr.io/open-webui/open-webui:main"

Prerequisites

As a service provider, you already have completed the following:

  1. Provisioned a Kubernetes cluster (e.g. Rafay MKS)
  2. Deployed a cluster blueprint with critical addons
  3. Ingress Controller
  4. Have access to a domain (e.g. paas.demo.gorafay.net) with TLS certificates to support https based access
  5. Your Kubernetes cluster has connectivity to the Internet to download container images from the container registry where the image is hosted.

Create App SKU

  • Login into the "Default Org" and navigate to the PaaS Studio
  • Click on Service Profiles and click on "New Service Profile"

This will launch a wizard to create a new service profile.

  • Provide a unique name (e.g. openwebui)
  • Provide an optional Display Name
  • Provide an optional description (This will be presented to the end user when they select and launch the card for the SKU)
  • For Environment Template, select "system-serverless-pods"
  • For version, select the latest version (e.g. v6)
  • For Service Type, select from the dropdown list (this list is managed by the super admin)
  • Enable the toggle for auto creation of compute
  • Save & Continue

Profile Configuration

General

Update the fields in the "general" section

General Section

Card Design

  • Provide the URL for an image which will be presented to the user as an Icon when they select the SKU
  • Update the readme field with a description which will be presented to the end user when they select the SKU (e.g. Open WebUI App)

Card Design

Info

Click on "Preview" to view what the readme will look like for the end user.

Input Settings

In this section, you get to specify

  • Default values for required inputs
  • Which inputs can be overriden by end users
  • How the inputs can be selected by end users (e.g. dropdown list, text box etc)

The docker command to run Open WebUI container from the container registry is 

docker run -d -p 3000:8080 -v open-webui:/app/backend/data --name open-webui ghcr.io/open-webui/open-webui:main

What it does: - -d runs the container in detached mode - -p 3000:8080 maps container ports - --name open-webui names the container - nginx is the image pulled from Docker Hub

Important

Due to security considerations, service providers will want to have web app be accessed on "port 443" (https). We will make this change in our configuration.

User Overrides

Disable "Allow Overrides for All" This disables all overrides for end users when they use it. We will selectively enable some fields in the subsequent steps.

Default Inputs

In this step, you will customize the standard profile with "default" values that are relevant for your deployment.

Name Value Override
Container Port 8080 NO
CPU 1000 NO
Enable Web Access true NO
Hostname Suffix paas.demo.gorafay.net NO
Ingress Class Name nginx NO
Kubeconfig Copy/Paste NO
Memory 2000 NO
Pod Image ghcr.io/open-webui/open-webui:main NO

Hostname Suffix

Specify the DNS hostname that you intend to use to serve the web applications. In our example, we are using "paas.demo.gorafay.net". Every instance of the web app can be acccessed on a dynamically generated URL pattern that will look like "https://random prefix.paas.demo.gorafay.net"

Kubeconfig

  • In the Infrastructure portal, click on the "gear" symbol on the far right of the target Kubernetes cluster
  • Select "Download ZTKA Kubeconfig"
  • Open the downloaded file with an IDE
  • Copy the content and paste it into the Kubeconfig field in the above step.

Download Kubeconfig

Output Settings

Once the web application has been successfully deployed, we need to help user quickly find the URL for the app.

  • Click on "Add Output"
  • Under name, enter "Host Name"
  • Under label, enter "URL for Open WebUI"

Info

The name "Host Name" will dynamically retrieve the https URL for the deployed web app.

Click on "Save" to save the profile. Now, we have a ready to use Open WebUI SKU. It should look like the following

Output

Test SKU

Now, we are ready to test our newly created SKU.

  • In the SKU Studio, click on "Service Instances"
  • Ensure the "system-catalog" project is selected
  • Click on New Service Instance

You should now see your newly created "Open WebUI" app. Now, enter a name for the instance and click on Deploy. In ~50-60 seconds, you should see a successfully deployed instance. See example below.

Successful Instance

Now, click on the URL and you should be taken to your Nginx App. You should see something like the image below.

  • Create a new admin user for your Open WebUI deployment
  • Login and use Open WebUI

Successful Access

Share SKU with Customer Orgs

At this point, although the SKU works, it is not available to Customer Orgs automatically. Service Providers need to perform the following to make the SKU available to customer orgs

  • Login into the Rafay Ops Console
  • Click on System Resources
  • Click on Service Profiles

You should now see the newly created SKU (e.g. openwebui-app).

  • Click on Actions to initiate SKU sharing
  • You will be presented with the option to share the SKU with "Select Orgs" or "All Orgs"
  • Select one of these options and the SKU will now be immediately available and usable by the selected customer orgs.

Share SKU