Skip to content

docs: PLTF-388 add Helm-based installer instructions for OpenHands Enterprise#628

Draft
aivong-openhands wants to merge 9 commits into
mainfrom
aivong/pltf-388-update-docsopenhandsdev-with-helm-based-installer
Draft

docs: PLTF-388 add Helm-based installer instructions for OpenHands Enterprise#628
aivong-openhands wants to merge 9 commits into
mainfrom
aivong/pltf-388-update-docsopenhandsdev-with-helm-based-installer

Conversation

@aivong-openhands

@aivong-openhands aivong-openhands commented Jul 15, 2026

Copy link
Copy Markdown
Contributor
  • I have read and reviewed the documentation changes to the best of my ability.
  • If the change is significant, I have run the documentation site locally and confirmed it renders as expected.

Summary of changes

New page: enterprise/k8s-install/installation.mdx ("Install with Helm") — end-to-end install instructions for OpenHands Enterprise via the Replicated Helm workflow, wired into the K8s Install nav group and linked from the K8s Install overview page (which previously had no install instructions). Its sections:

  • Prerequisites — cluster, Helm version, license credentials, DNS (app + runtime API + wildcard for sandboxes), and an authentication method; GitHub is the example used throughout, with a link to the existing GitHub App creation script.
  • Steps 1–4 (login → secrets → values → install) — registry login with license credentials, the secrets the chart expects (including the GitHub App secret), and a minimal usable values file: ingress/TLS (Traefik example), GitHub auth, runtime/sandbox endpoints, embedded PostgreSQL/Redis, and bundled MinIO for conversation storage. A warning marks the sections without which login or agent runs don't work.
  • Step 5 (validate) — preflight checks from the in-cluster spec.
  • Next Steps — establishes the pattern that features and sizing are helm upgrade values overrides documented on their own pages (Resource Limits, External PostgreSQL, Analytics, Plugin Marketplace), rather than duplicating those snippets here.
  • Troubleshooting — generating a support bundle with the troubleshoot CLI, uploading it to us, and a common-issues table.

Related touch-ups: the helm upgrade examples in analytics.mdx and plugin-marketplace.mdx now use the Replicated registry chart URL so upgrades reference the same chart source as the install. llms.txt/llms-full.txt regenerated via make llms.

The install, preflight, and support-bundle flows follow the commands validated live against a licensed registry install (see OpenHands-Cloud#895), and the starter values render cleanly against the chart. Remaining before undraft: a live usability pass (login + conversation) of the starter values on a real cluster.

This PR was drafted by an AI agent on behalf of the user.

@mintlify

mintlify Bot commented Jul 15, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
all-hands-ai 🟢 Ready View Preview Jul 15, 2026, 3:19 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

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.

1 participant