Add custom sandbox image docs for Enterprise VM (Replicated)#562
Add custom sandbox image docs for Enterprise VM (Replicated)#562rajshah4 wants to merge 3 commits into
Conversation
Adds enterprise/custom-sandbox-image.mdx covering: - Why to use custom sandbox images (speed, reliability, monorepo support) - Benchmark results from Enterprise Replicated VM (up to 43x speedup) - How to build and push a custom image from the agent-server base - What to bake in and what to keep out - How to configure the custom image in the Replicated Admin Console Content sourced from https://github.com/rajshah4/openhands-custom-image Co-authored-by: openhands <openhands@all-hands.dev>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
|
||
| ## Reference | ||
|
|
||
| - [OpenHands custom image example repo](https://github.com/rajshah4/openhands-custom-image): Dockerfile, benchmark scripts, and analysis tooling for the VS Code custom image example. |
There was a problem hiding this comment.
Can you please move this to the OpenHands organization, so that we're not pointing our public docs to a personal repo?
| ```dockerfile | ||
| FROM ghcr.io/openhands/agent-server:1.23.0-python | ||
| ``` | ||
|
|
||
| Pin a specific version tag to ensure reproducible builds. Check | ||
| [ghcr.io/openhands/agent-server](https://github.com/OpenHands/OpenHands/pkgs/container/agent-server) | ||
| for the latest available tags. |
There was a problem hiding this comment.
Can you add a note here that agent server is updated on every release of OHE, so users should rebuild their images before upgrading?
Would phrase as "To get the latest features of OpenHands..." rather than focusing on the compatibility problems we've experienced in the past.
| 5. Publish the image to a registry and point the Replicated installer at it. | ||
|
|
||
| <Warning> | ||
| Do not override the entrypoint or replace the runtime contract of the base image. The installer |
There was a problem hiding this comment.
No action in the docs for this, but there's nothing stopping us from allowing custom entrypoints as long as we're clear that they must start up the agent server.
That would enable running scripts or backgrounding additional processes on startup.
Would need changes to the installer to support this, though.
3 participants
Summary
Adds a new doc page
enterprise/custom-sandbox-image.mdxcovering how to build and use custom sandbox images in the Enterprise Replicated VM deployment. The page is placed in the Enterprise tab navigation, right after "Quick Start".Content is sourced from https://github.com/rajshah4/openhands-custom-image and adapted to match the style and structure of the existing Enterprise docs.
What's covered
Files changed
enterprise/custom-sandbox-image.mdx— new pagedocs.json— addedenterprise/custom-sandbox-imageto the Enterprise tab navigation (afterenterprise/quick-start)This PR was created by an AI agent (OpenHands) on behalf of the user.
@rajshah4 can click here to continue refining the PR