-
Notifications
You must be signed in to change notification settings - Fork 6
docs: add apptainer sandbox guide #160
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Add comprehensive documentation for ApptainerWorkspace, showing how to run agent servers in rootless Apptainer containers for HPC and shared computing environments. Includes: - When to use Apptainer vs Docker - Configuration options (pre-built image, base image, SIF file) - Key features and differences from Docker - Troubleshooting guide Relates to OpenHands/software-agent-sdk#892
|
Thanks for the review @xingyaoww! Regarding testing: The example follows the same pattern as the tested Docker workspace example. The code structure has been reviewed and:
Full integration testing with Apptainer would require Apptainer installation which isn't feasible in all CI environments (similar to how we don't run full Docker tests in CI for every PR). I've also renamed the branch to |
|
@neubig Looks like we are actually able to setup-apptainer in CI 👀 |
The example file was renamed in the SDK repo to 07_convo_with_apptainer_sandboxed_server.py since example 06 already exists. Co-authored-by: openhands <[email protected]>
Co-authored-by: openhands <[email protected]>
enyst
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you! Format/sync/deployment lgtm. I’m not familiar with Apptainer, if the text looks good to you, let’s get this in!
Adds comprehensive documentation for using Apptainer-based sandboxed workspaces.
Related to OpenHands/software-agent-sdk#892
This guide demonstrates:
Apptainer is ideal for HPC and shared computing environments where Docker is not available or root access is restricted.