docs(agent-canvas): add Kubernetes (Helm) backend guide#614
Draft
rbren wants to merge 4 commits into
Draft
Conversation
Add a new backend-setup page documenting the official Helm chart for running Agent Canvas on Kubernetes. Covers prerequisites, what the chart deploys, persistence (including the GKE c4/n4 hyperdisk gotcha), ingress with WebSocket-friendly timeouts, RBAC toggles (namespaced + cluster-admin), common values.yaml recipes (LLM key from a Secret, sandbox-namespace RBAC, external Postgres), install/upgrade commands, three ways to reach the UI, uninstall + PVC cleanup, and a troubleshooting section for the most common install failures. Wires the page into docs.json under Agent Canvas > Backend Setup and adds reciprocal Related-Guides links from the Docker and VM pages.
Mirror the chart update that moves persistence.mountPath from /home/openhands/.openhands up to /home/openhands so ~/workspace and other agent-generated state also survives pod restarts.
The chart now runs as UID 10001 (upstream image's `openhands` user; UID 1000 was a leftover `pn` account in the base layer) and mounts a single PVC at ~/.openhands and ~/workspace via subPath instead of shadowing the whole HOME (which would hide the image's .bashrc et al.).
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
…app-deploy skill Explain that the Kubernetes backend can be used as an internal vibecoding platform where anyone with Agent Canvas UI access can build, ship, and push code to GitHub from a prompt (GitHub MCP required for the push half). Include a generic, cluster-agnostic version of the internal app-deployment skill as a copy-pasteable code block. Co-authored-by: openhands <openhands@all-hands.dev>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a new backend-setup page documenting the official Helm chart for running Agent Canvas on Kubernetes: Kubernetes (Helm).
The chart itself is in
OpenHands/agent-canvasunderhelm/agent-canvas/and there was no user-facing docs entry for it. This page slots in next to Docker / VM / Cloud / Modal in the Backend Setup group.Why
helm/agent-canvas/README.mdin the source repo. That works for a Helm-fluent audience but not for people finding the docs first.c4/n4node pools needinghyperdisk-balanced, and ingress controllers closing WebSocket streams because default timeouts are ~60s. Both are called out explicitly in the new page's Persistence and Ingress / Troubleshooting sections.Scope
openhands/usage/agent-canvas/backend-setup/kubernetes.mdx(~270 lines).c4/n4hyperdisk note,existingClaimpathclusterAdmin, with a warning against the lattervalues.yamlrecipes: minimal, LLM key from a Secret, sandbox-namespace RBAC, external PostgresFailedAttachVolume,ErrImagePull, WebSocket disconnects,Pendingon no PVdocs.json— adds the page toAgent Canvas > Backend Setup, inserted betweendockerandcloud(roughly in ascending complexity order).docker.mdxandvm.mdxso people already reading a sibling page can find it.Not in this PR
llms.txt/llms-full.txtregeneration. I ranmake llmsand confirmed it does pick up the new page, but the regen also pulled in ~1500 lines of pre-existing drift onmain(unrelated title/description changes to Custom Sandbox, and the new Mobile Access page). TheSync llms context filesworkflow runs weekly on cron and will open its own PR to catch up — merging that separately keeps this diff readable. If reviewers prefer, I can push the regen into this PR instead.How to preview
npm install -g mintlify@latest # if not already installed mint devOpen http://localhost:3000/openhands/usage/agent-canvas/backend-setup/kubernetes and click around; also check the sidebar nav under Agent Canvas → Backend Setup.
This PR was created by an AI agent (OpenHands) on behalf of the repo owner.