Add Amazon EKS installation guide#638
Draft
jlav wants to merge 47 commits into
Draft
Conversation
…undle notes - Note that the no-channel install URL targets the Stable channel; non-Stable licenses must include the channel slug (else 'Channel not found for license') - Add a bring-your-own-certificate values variant alongside the cert-manager one - Document installing the preflight/support-bundle CLIs - Note support-bundle upload prints no link; find the bundle in the portal - Add optional STORAGE_CLASS to the runtime-api values example - Add a troubleshooting row for bundles missing instance metadata
…bleshooting - Drop the claim that self-signed certs break login/agent comms (chart support for self-signed is being explored separately) - Remove the publicly-trusted absolute from the BYO-cert note - Drop the Pending/no-default-storage-class row (a default storage class is already a stated prerequisite)
The prior example used tls.enabled: true + an ACME email, but the chart has no tls.email key and tls.enabled: true only references a pre-existing secret — it does not invoke cert-manager. Switch the minimal example to the validated bring-your-own-certificate config (tls.enabled: false, tls: false on the keycloak/runtime-api ingresses, cert terminated at the ingress controller) and leave a slot noting a cert-manager variant will be documented separately.
Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
…-helm-based-installer
Add postgresql.auth.database, databaseMigrations.createDatabases (app + runtime-api), and litellm-helm.enabled — without these the bundled-DB path hangs at wait-for-db and no LiteLLM deploys. Correct the 'no configuration needed' prose.
keycloak.enabled defaults false in the chart; the example configured only the Keycloak ingress, so no Keycloak was deployed and login dead-ended with a 404 on auth.app.<domain>. Verified on a fresh KinD install: without this flag no keycloak pod renders; with it the auth endpoints come up and the GitHub login redirect returns 303.
Address PR #628 review comment: link the Replicated trial signup page (https://install.r9.all-hands.dev/openhands/signup) in the license Note on the Helm-based installation page. Co-authored-by: openhands <openhands@all-hands.dev>
Update the Helm-based installer prerequisites to require Helm v4 or later (prerequisite list and troubleshooting table), aligning with the embedded cluster's Helm version and Helm v3's upcoming EOL. Co-authored-by: openhands <openhands@all-hands.dev>
… path Address review feedback: add a Warning to the K8s install page clarifying that the embedded PostgreSQL is for proof-of-concept/evaluation only (not production), that we recommend an external database, and that there is no officially supported migration path from the embedded instance to an external one. Co-authored-by: openhands <openhands@all-hands.dev>
…-helm-based-installer
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
aivong-openhands
approved these changes
Jul 20, 2026
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
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.
Adds Kubernetes install docs for OpenHands Enterprise: two general (any-distro) guides plus an Amazon EKS page.
Pages (Enterprise → K8s Install)
sysbox.mdx) — general: node requirements, thesysbox-deploy-k8sDaemonSet, and pointing OpenHands at it (RUNTIME_CLASS+SET_HOST_USERS). EKS-specific bits are callouts.dns-and-tls.mdx) — general: external-dns + cert-manager (Let's Encrypt DNS-01), provider-agnostic, with a manual-setup fallback. Route 53 details are callouts.eks.mdx) — EKS-specific: node groups, EBS/gp3 storage, S3, RDS, and NLB ingress; links to the two general guides.docs.jsonand cards on the K8s Install overview.Heads-up on the diff
Stacked on #628 (the Helm-installer docs) and targeting
mainfor the Mintlify preview, so the diff currently includes #628's commits. It collapses to just the ~5 new/changed files once #628 merges. Not for merge until then.Validated
mint broken-links: no issues from these pages (2 pre-existing SDK findings are unrelated).docs.jsonis valid JSON.