Skip to content

Add Amazon EKS installation guide#638

Draft
jlav wants to merge 47 commits into
mainfrom
jl/eks-docs
Draft

Add Amazon EKS installation guide#638
jlav wants to merge 47 commits into
mainfrom
jl/eks-docs

Conversation

@jlav

@jlav jlav commented Jul 20, 2026

Copy link
Copy Markdown
Member

Adds Kubernetes install docs for OpenHands Enterprise: two general (any-distro) guides plus an Amazon EKS page.

Pages (Enterprise → K8s Install)

  • Installing Sysbox (sysbox.mdx) — general: node requirements, the sysbox-deploy-k8s DaemonSet, and pointing OpenHands at it (RUNTIME_CLASS + SET_HOST_USERS). EKS-specific bits are callouts.
  • DNS and TLS (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.
  • Amazon EKS (eks.mdx) — EKS-specific: node groups, EBS/gp3 storage, S3, RDS, and NLB ingress; links to the two general guides.
  • Nav wiring in docs.json and cards on the K8s Install overview.

Heads-up on the diff

Stacked on #628 (the Helm-installer docs) and targeting main for 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).
  • All internal links resolve; docs.json is valid JSON.
  • Node-packing figures checked in code.

aivong-openhands and others added 30 commits July 15, 2026 10:10
…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>
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.
openhands-agent and others added 6 commits July 17, 2026 17:57
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>
@mintlify

mintlify Bot commented Jul 20, 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 20, 2026, 12:49 PM

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

@mintlify

mintlify Bot commented Jul 20, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated (UTC)
all-hands-ai 🟡 Building Jul 20, 2026, 12:48 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.

3 participants