Skip to content

Refresh custom sandbox image base tag and document version compatibility - #755

Merged
ak684 merged 1 commit into
mainfrom
alona/custom-sandbox-image-refresh
Aug 24, 2026
Merged

Refresh custom sandbox image base tag and document version compatibility#755
ak684 merged 1 commit into
mainfrom
alona/custom-sandbox-image-refresh

Conversation

@ak684

@ak684 ak684 commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

Updates the Enterprise custom sandbox image doc (enterprise/custom-sandbox-image.mdx).

  • Bump the example base image from agent-server:1.23.0-python to 1.41.0-python, which is what current Stable (0.45.0) and Beta (0.50.0) OHE releases pin. Customers copying the old example got an outdated SDK.
  • Add a Version Compatibility section. Since feat: surface a clear error when a custom sandbox image's agent-server SDK mismatches OpenHands#14883, conversation start on a custom sandbox image checks the sandbox agent-server SDK version against the release and fails with a clear error on a major.minor mismatch. The doc now explains this, how to find the expected tag (the Admin Console Sandbox Image Tag default), and that the image must be rebuilt for each upgrade.

Live page: https://docs.openhands.dev/enterprise/custom-sandbox-image

@mintlify

mintlify Bot commented Aug 24, 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 Aug 24, 2026, 5:12 PM

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

```

Pin a specific version tag to ensure reproducible builds. Check
[ghcr.io/openhands/agent-server](https://github.com/OpenHands/OpenHands/pkgs/container/agent-server)

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 think we may be able to refer customers to the release notes page to find the correct version of the agent-server for their release. If the release notes don't have that today it should be a simple fix to @mamoodi's automation to be sure it gets there.

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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Agreed. The release notes don't list component versions today, but the ohe-release-notes skill already derives the agent-server tag in step 1b/1c and just doesn't write it to the page, so emitting a per-release component table should be a small template change. I'll keep the Admin Console Sandbox Image Tag pointer (it's what customers see while configuring) and add a link to the release notes once the table is there. @mamoodi one note: the skill reads the agent-server tag from runtime-api/values.yaml; on main the pin now lives at charts/openhands/values.yamlglobal.agentServerImage.tag, and the notes should print the full X.Y.Z-python tag.

@ak684

ak684 commented Aug 24, 2026

Copy link
Copy Markdown
Contributor Author

Merging this but leaving @jpshackelford 's comment unresolved since it's a great follow-up once we have the version information available and posted on our release notes page.

@ak684
ak684 merged commit 4ddec69 into main Aug 24, 2026
5 checks passed
@ak684
ak684 deleted the alona/custom-sandbox-image-refresh branch August 24, 2026 17:48
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