docs: document multiple custom sandbox images with warm runtime pools - #776
Conversation
…oach - Replaces single-image legacy approach with multi-image warm runtime pool documentation - Key benefits: no restarts/redeployments, dynamic updates, multiple images - Complete guide to authentication, configuration, and usage - Includes working shell scripts for managing warm runtime configs - Documents three methods for starting conversations (API, SDK, Web UI) - Adds image lifecycle management strategies for handling updates and resume - Covers troubleshooting for common issues (auth, image pulls, resume failures) Co-authored-by: openhands <openhands@all-hands.dev>
…tom-images # Conflicts: # enterprise/custom-sandbox-image.mdx
…tom-images # Conflicts: # enterprise/custom-sandbox-image.mdx
ak684
changed the title
ak684
changed the title
| inside the runtime-api pod with `kubectl exec`. It reads the admin password and API key from their | ||
| Kubernetes secrets. Save it as `warm-runtime-configs.sh`: | ||
|
|
||
| ```bash |
There was a problem hiding this comment.
I think inline code snippets and bash are great, but for longer scripts, especially if they're meant to be real helpers, what do you think about:
- Formalizing this as a standalone file
- Checking it in, maybe here?
- Linking to this script from there
There was a problem hiding this comment.
Great suggestion — done. I put the standalone helper in the runtime-api repository, since that project owns these endpoints and already contains the related admin-auth/configuration scripts: https://github.com/OpenHands/runtime-api/pull/743. It includes automated list/save/delete/authentication tests and passed a live OHE 0.64.0 smoke test. This docs PR now links to the maintained helper instead of embedding the 100+ line implementation; runtime-api #743 should merge first.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
3 participants
Summary
Provenance
This standalone PR supersedes #609. It retains and builds on the original documentation work by @jpshackelford, then incorporates the release-specific corrections and end-to-end validation completed in #776.
Dependency
Merge https://github.com/OpenHands/runtime-api/pull/743 before this PR so the linked standalone helper is available from the runtime-api main branch.
Related implementation
Release
OpenHands Enterprise 0.64.0 is available in the Stable channel as Replicated sequence 1597. It pins enterprise-server 1.59.1, runtime-api 0.10.0, and agent-server 1.46.0.
Validation