Skip to content

docs(enterprise): add Architecture overview page - #745

Merged
jpelletier1 merged 6 commits into
mainfrom
docs/enterprise-architecture-overview
Oct 8, 2026
Merged

jpelletier1 merged 6 commits into
mainfrom
docs/enterprise-architecture-overview

Conversation

@jpelletier1

@jpelletier1 jpelletier1 commented Aug 22, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Adds a new Architecture page under the Enterprise tab (enterprise/architecture.mdx) that explains how OpenHands Enterprise / OpenHands Cloud works as a whole system, aimed at customers and prospects evaluating a self-hosted deployment.

The page covers:

  • How it works — end-to-end request flow (browser/webhook → OpenHands app → Keycloak/Runtime API/LiteLLM → sandbox → LLM/Git provider), illustrated with a Mermaid system diagram.
  • Components / services — core components (OpenHands server, Keycloak, PostgreSQL, Redis, LiteLLM proxy, Runtime API, sandboxes, image loader, conversation bucket), enterprise supporting services (auth/token manager, billing, maintenance jobs, sharing, telemetry/license enforcement), and optional platform services (Automation service, Integrations Hub, Plugin Directory, Agent Canvas, device plugin).
  • Integration adapter flow — a second small diagram showing the common webhook → router → manager → sandbox → callback pattern shared by all Git/chat/ticketing integrations.
  • Required vs. optional external systems — two tables distinguishing what every deployment needs (Kubernetes, an LLM provider, PostgreSQL, Redis, Keycloak, object storage, at least one login IdP/Git provider, DNS/TLS) from feature-gated integrations (GitHub/GitLab/Bitbucket/Azure DevOps apps, Slack, Jira, Linear, email, Datadog, Tavily, Laminar, cert-manager, etc.).
  • Deployment topology notes and a "Next steps" card group linking to related existing pages (Enterprise vs. OSS, Sizing Guide, Kubernetes Installation, Conversations and Sandboxes).

The page is registered in docs.json under the existing OpenHands Enterprise group in the Enterprise tab, right after enterprise/enterprise-vs-oss.

Sourcing

Content was derived from analysis of the enterprise/ repository (server, integrations, storage/migrations) and the OpenHands/OpenHands-Cloud repository (Helm chart structure, values.yaml, ARCHITECTURE.md), cross-checked against existing docs pages (enterprise/index.mdx, enterprise/k8s-install/index.mdx, enterprise/conversations-and-sandboxes.mdx, enterprise/enterprise-vs-oss.mdx, sdk/arch/overview.mdx) for consistency of terminology, formatting, and diagram style.

Validation

  • docs.json parses as valid JSON; diff is a single-line insertion (no reformatting).
  • All internal links (/enterprise/..., /openhands/usage/automations/overview, /openhands/usage/cloud/cloud-api, /openhands/usage/agent-canvas/architecture) point to existing pages.
  • Both Mermaid diagrams were validated and rendered locally with @mermaid-js/mermaid-cli to confirm valid syntax.
  • Followed openhands/DOC_STYLE_GUIDE.md conventions (Title Case headers, absolute internal links, <Info>/<Note> components, <Card>/<CardGroup> for next steps).
  • Did not regenerate llms.txt/llms-full.txt — a clean clone of main already shows drift in those generated files unrelated to this change, so regenerating here would have produced an unrelated, oversized diff. Recommend leaving that to the scheduled check-llms-files sync workflow.

This PR was created by an AI agent (OpenHands) on behalf of the user, based on an analysis of the enterprise and OpenHands/OpenHands-Cloud repositories.

@jpelletier1 can click here to continue refining the PR

Adds a new Architecture page under the Enterprise tab that explains:
- How OpenHands Enterprise / Cloud works end-to-end, with a Mermaid
  system diagram
- Core components/services (OpenHands server, Keycloak, LiteLLM,
  Runtime API, sandboxes, object storage, image loader)
- Enterprise supporting services and optional platform services
  (Automation service, Integrations Hub, Plugin Directory, Agent
  Canvas, device plugin)
- Integration adapter flow (webhook -> sandbox -> callback)
- Required vs. optional external systems (Kubernetes, LLM provider,
  Postgres, Redis, Keycloak, object storage, DNS/TLS vs. Git app
  integrations, Stripe, email, Datadog, Tavily, Laminar, etc.)

Registers the page in docs.json under the existing
'OpenHands Enterprise' group in the Enterprise tab.

Co-authored-by: openhands <openhands@all-hands.dev>
@mintlify

mintlify Bot commented Aug 22, 2026 •

Copy link
Copy Markdown

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

Project Status Preview Updated
all-hands-ai 🟢 Ready View Preview Oct 8, 2026, 12:35 PM

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

@jpelletier1

Copy link
Copy Markdown
Contributor Author

@OpenHands remove references to stripe in the architecture doc

@openhands-ai

openhands-ai Bot commented Aug 24, 2026

Copy link
Copy Markdown

I'm on it! jpelletier1 can track my progress at all-hands.dev

Co-authored-by: openhands <openhands@all-hands.dev>

Copy link
Copy Markdown
Contributor Author

Addressed in f34a1eb: removed both Stripe references from enterprise/architecture.mdx and updated the PR description accordingly.

This comment was posted by an AI agent (OpenHands) on behalf of the user.

@openhands-ai

openhands-ai Bot commented Aug 24, 2026

Copy link
Copy Markdown

Addressed the PR comment on #745.

  • Removed both Stripe references from enterprise/architecture.mdx.
  • Updated the PR description to remove its Stripe mention.
  • Committed and pushed as f34a1eb.
  • Replied to the reviewer with the commit reference.
  • Verified the workspace is clean and the PR head matches the local commit.

No test suite was run because this was a two-line documentation-only deletion; git diff --check passed.

enyst
enyst previously requested changes Oct 4, 2026

@enyst enyst left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm an AI agent based on Opus 5.5, helping Engel Nyst (@enyst) with project work.

Links and nav check out. Two claims don't match the source:

  • Kubernetes 1.19+ (L173): the chart declares no kubeVersion. 1.19.7 is the version of the replicated subchart (Chart.yaml#L35-L38). The install docs tie the version to Sysbox support instead. Suggestion inline.
  • Linear is listed as a webhook integration in the diagram, the core loop, the adapter list, and the optional table. Enterprise main mounts routers for GitHub, GitLab, Bitbucket, Azure DevOps, Slack, Jira, Jira DC, and Bitbucket DC, but not Linear (saas_server.py#L132-L239). Only an ENABLE_LINEAR flag and storage remain. Please drop Linear, or point to where it's served.

Smaller: the "—" rows can now link to /enterprise/integrations/github, /enterprise/integrations/gitlab, and /enterprise/integrations/jira-cloud. For OHE, /enterprise/automations is a closer link than the Cloud automations overview.

Comment thread enterprise/architecture.mdx Outdated
@rajshah4

rajshah4 commented Oct 8, 2026

Copy link
Copy Markdown
Member

I think this look good, at some point a nicer architeture diagram would be great, but I think its useful to get htis out there

openhands-agent and others added 2 commits October 8, 2026 08:34
Co-authored-by: Engel Nyst <engel.nyst@gmail.com>
@rajshah4

rajshah4 commented Oct 8, 2026

Copy link
Copy Markdown
Member

I like it

@rajshah4 rajshah4 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good

@jpelletier1
jpelletier1 dismissed enyst’s stale review October 8, 2026 12:42

I've applied Engel's suggestions around Sysbox usage in the K8s cluster.

@jpelletier1
jpelletier1 merged commit 558ac41 into main Oct 8, 2026
5 checks passed
@jpelletier1
jpelletier1 deleted the docs/enterprise-architecture-overview branch October 8, 2026 12:42

This branch was successfully deployed

1 active deployment
staging — c2f35312 Deployed Oct 8, 2026 by mintlify[bot]
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.

4 participants