From 4a86cec49d22e01fa8e884701d4820edf4ce498b Mon Sep 17 00:00:00 2001 From: axel7083 <42176370+axel7083@users.noreply.github.com> Date: Thu, 10 Jul 2025 14:30:30 +0200 Subject: [PATCH] docs(quick-start): adding instructions for Podman Kube Play Signed-off-by: axel7083 <42176370+axel7083@users.noreply.github.com> --- docs/getting-started/quick-start/index.mdx | 7 ++ .../quick-start/tab-docker/PodmanKubePlay.md | 69 +++++++++++++++++++ 2 files changed, 76 insertions(+) create mode 100644 docs/getting-started/quick-start/tab-docker/PodmanKubePlay.md diff --git a/docs/getting-started/quick-start/index.mdx b/docs/getting-started/quick-start/index.mdx index 82c5ec31..f5a05a8d 100644 --- a/docs/getting-started/quick-start/index.mdx +++ b/docs/getting-started/quick-start/index.mdx @@ -9,6 +9,7 @@ import { TopBanners } from "@site/src/components/TopBanners"; import DockerCompose from './tab-docker/DockerCompose.md'; import Podman from './tab-docker/Podman.md'; +import PodmanKubePlay from './tab-docker/PodmanKubePlay.md'; import ManualDocker from './tab-docker/ManualDocker.md'; import DockerSwarm from './tab-docker/DockerSwarm.md'; import DockerUpdating from './tab-docker/DockerUpdating.md'; @@ -59,6 +60,12 @@ Choose your preferred installation method below: + +
+ +
+
+
diff --git a/docs/getting-started/quick-start/tab-docker/PodmanKubePlay.md b/docs/getting-started/quick-start/tab-docker/PodmanKubePlay.md new file mode 100644 index 00000000..10e3a8ac --- /dev/null +++ b/docs/getting-started/quick-start/tab-docker/PodmanKubePlay.md @@ -0,0 +1,69 @@ +# Podman Kube Play Setup + +Podman supports Kubernetes like-syntax for deploying resources such as pods, volumes without having the overhead of a full Kubernetes cluster. [More about Kube Play](https://docs.podman.io/en/latest/markdown/podman-kube-play.1.html). + +If you don't have Podman installed, check out [Podman's official website](https://podman.io/docs/installation). + +## Example `play.yaml` + +Here is an example of a Podman Kube Play file to deploy: + +```yaml +apiVersion: v1 +kind: Pod +metadata: + name: open-webui +spec: + containers: + - name: container + image: ghcr.io/open-webui/open-webui:main + ports: + - name: http + containerPort: 8080 + hostPort: 3000 + volumeMounts: + - mountPath: /app/backend/data + name: data + volumes: + - name: data + persistentVolumeClaim: + claimName: open-webui-pvc +--- +apiVersion: v1 +kind: PersistentVolumeClaim +metadata: + name: open-webui-pvc +spec: + accessModes: + - ReadWriteOnce + resources: + requests: + storage: 5Gi +``` + +## Starting + +To start your pod, run the following command: + +```bash +podman kube play ./play.yaml +``` + +## Using GPU Support + +For Nvidia GPU support, you need to replace the container image with `ghcr.io/open-webui/open-webui:cuda` and need to specify the device (GPU) required in the pod resources limits as followed: + +```yaml + [...] + resources: + limits: + nvidia.com/gpu=all: 1 + [...] +``` + +:::important + +To successfully have the open-webui container access the GPU(s), +you will need to have the Container Device Interface (CDI) for the GPU you wish to access installed in your Podman Machine. You can check [Podman GPU container access](https://podman-desktop.io/docs/podman/gpu). + +::: \ No newline at end of file