feat: add Docker named volume support with subPath for PVC backend - #233

Merged
jwx0925 merged 15 commits into
opensandbox-group:mainfrom
hittyt:feat/docker-named-volume
Feb 24, 2026
Merged

feat: add Docker named volume support with subPath for PVC backend#233
jwx0925 merged 15 commits into
opensandbox-group:mainfrom
hittyt:feat/docker-named-volume

Conversation

@hittyt

Copy link
Copy Markdown
Collaborator

Summary

Closes#221

This commit implements Docker named volume support for the PVC backend, with full subPath support to enable fine-grained path isolation within named volumes, consistent with Kubernetes PVC subPath behavior.

Testing

  • Not run (explain why)
  • Unit tests
  • Integration tests
  • e2e / manual verification

Breaking Changes

  • None
  • Yes (describe impact and migration path)

Checklist

  • Linked Issue or clearly described motivation Named volume for docker backend #221
  • Added/updated docs (if needed)
  • Added/updated tests (if needed)
  • Security impact considered
  • Backward compatibility considered

@jwx0925

Copy link
Copy Markdown
Collaborator

@codex review

@chatgpt-codex-connectorchatgpt-codex-connectorBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit:580d370b7b

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment threadserver/src/services/docker.py Outdated
Comment threadserver/src/services/docker.py Outdated
@PangjipingPangjiping added feature New feature or request component/server labels Feb 12, 2026
Comment threadexamples/docker-pvc-volume-mount/README.md Outdated
Comment threadexamples/docker-pvc-volume-mount/README.md Outdated
Comment threadexamples/docker-pvc-volume-mount/README_zh.md
Comment threadserver/src/services/docker.py Outdated
hittytand others added 9 commits February 13, 2026 14:18
This commit implements Docker named volume support for the PVC backend,
with full subPath support to enable fine-grained path isolation within
named volumes, consistent with Kubernetes PVC subPath behavior.
- `server/src/services/docker.py`:
- `_validate_pvc_volume`: Now validates named volume existence via
`docker volume inspect`, validates driver is "local" when subPath
is used, checks Mountpoint exists, validates resolved subPath
exists, and adds path traversal protection
- `_build_volume_binds`: Generates appropriate bind strings:
- Without subPath: `volume-name:/container/path:ro|rw`
- With subPath: `/var/lib/docker/volumes/.../subdir:/container/path:ro|rw`
- `server/src/services/constants.py`: Add error codes:
- `PVC_VOLUME_NOT_FOUND`: Named volume does not exist
- `PVC_VOLUME_INSPECT_FAILED`: Docker API call failed
- `PVC_SUBPATH_UNSUPPORTED_DRIVER`: subPath requires "local" driver
- `PVC_SUBPATH_NOT_FOUND`: subPath directory does not exist
- `server/src/api/schema.py`: Update PVC documentation to reflect
runtime-neutral behavior (Docker named volumes + Kubernetes PVCs)
- `server/tests/test_docker_service.py`:
- Convert `_build_volume_binds` tests to instance methods
- Add 5 new tests for PVC volume handling:
- `test_single_pvc_volume_rw/ro`
- `test_pvc_volume_with_subpath`
- `test_pvc_volume_with_subpath_readonly`
- `test_mixed_host_and_pvc_volumes`
- Add 5 new validation tests:
- `test_pvc_volume_not_found_rejected`
- `test_pvc_volume_inspect_failure_returns_500`
- `test_pvc_volume_binds_passed_to_docker`
- `test_pvc_subpath_non_local_driver_rejected`
- `test_pvc_subpath_not_found_rejected`
- `test_pvc_subpath_binds_resolved_to_mountpoint`
- All language SDKs now test:
- Read-write named volume mount
- Read-only named volume mount
- SubPath mount with isolation verification
- Test scripts (`scripts/*-e2e.sh`) now seed named volume with
subPath test data (`datasets/train/marker.txt`)
- `oseps/0003-volume-and-volumebinding-support.md`: Update to reflect
cross-runtime PVC behavior and subPath support in Docker
- `specs/sandbox-lifecycle.yml`: Update PVC component documentation
- `examples/docker-pvc-volume-mount/`: New example demonstrating:
- Read-write/read-only named volume mounts
- Cross-sandbox data sharing
- SubPath isolation
The `pvc` backend is now a runtime-neutral abstraction:
- **Docker**: Maps to named volumes created via `docker volume create`
- **Kubernetes**: Maps to PersistentVolumeClaims
When `subPath` is specified:
- Volume must use `local` driver (for accessible Mountpoint)
- Resolved path is `Mountpoint + subPath` (bind mount)
- Path traversal protection ensures subPath stays within volume
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- server/src/services/docker.py:
- Cache `docker volume inspect` results in `_validate_volumes` and pass to `_build_volume_binds` to avoid redundant API calls.
- Add symlink-aware path traversal protection in `_validate_pvc_volume` using `os.path.realpath`.
- Use `posixpath` for Docker-internal path operations to ensure cross-platform consistency.
- server/tests/test_docker_service.py:
- Update tests to support the new `pvc_inspect_cache` parameter.
- Add `test_pvc_subpath_symlink_escape_rejected` to verify security protection.
- examples/docker-pvc-volume-mount/:
- Update README and README_zh to use `uv pip install opensandbox-server` for simpler installation.
- Use os.sep instead of hardcoded '/' in realpath-based security checks.
- Use os.path.normpath in tests to ensure cross-platform path matching.
- Clean up redundant imports in test_docker_service.py.
- Introduce run_with_retry_sync to handle flaky kernel/network states.
- Add delays between consecutive runs to mitigate 'session is busy' errors.
- Relax concurrency test requirements to allow 2/3 success in resource-constrained environments.
- Add recovery delay after execution interrupt.
- .github/workflows/real-e2e.yml:
- Switch python-e2e to self-hosted runner.
- Add pre and post execution cleanup for Docker containers and logs.
- tests/python/tests/test_code_interpreter_e2e.py:
- Add per-call timeout and TimeoutError handling to run_with_retry.
- Include 'session is busy' as a retryable error.
- Apply run_with_retry to initial execution calls for all languages to handle flaky kernel initialization.
Pangjiping
Pangjiping previously approved these changes Feb 14, 2026
@jwx0925

Copy link
Copy Markdown
Collaborator

@codex review

@chatgpt-codex-connectorchatgpt-codex-connectorBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit:d2059063df

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment threadserver/src/services/docker.py Outdated
Comment threadserver/src/services/docker.py
@jwx0925

Copy link
Copy Markdown
Collaborator

@codex review

@chatgpt-codex-connectorchatgpt-codex-connectorBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit:b52d62bb55

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment threadserver/src/services/docker.py

@jwx0925jwx0925 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM

@jwx0925
jwx0925 merged commit 58ef919 into opensandbox-group:mainFeb 24, 2026
11 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component/serverfeatureNew feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Named volume for docker backend

3 participants

@hittyt@jwx0925@Pangjiping
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all \u003cpre\u003e\u003ccode\u003e blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks"); } } catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); } })(); (function(){ try { var __m = "github.com"; var __re = new RegExp('^' + "github\\.com" + '
Skip to content

feat: add Docker named volume support with subPath for PVC backend - #233

Merged
jwx0925 merged 15 commits into
opensandbox-group:mainfrom
hittyt:feat/docker-named-volume
Feb 24, 2026
Merged

feat: add Docker named volume support with subPath for PVC backend#233
jwx0925 merged 15 commits into
opensandbox-group:mainfrom
hittyt:feat/docker-named-volume

Conversation

@hittyt

Copy link
Copy Markdown
Collaborator

Summary

Closes#221

This commit implements Docker named volume support for the PVC backend, with full subPath support to enable fine-grained path isolation within named volumes, consistent with Kubernetes PVC subPath behavior.

Testing

  • Not run (explain why)
  • Unit tests
  • Integration tests
  • e2e / manual verification

Breaking Changes

  • None
  • Yes (describe impact and migration path)

Checklist

  • Linked Issue or clearly described motivation Named volume for docker backend #221
  • Added/updated docs (if needed)
  • Added/updated tests (if needed)
  • Security impact considered
  • Backward compatibility considered

@jwx0925

Copy link
Copy Markdown
Collaborator

@codex review

@chatgpt-codex-connectorchatgpt-codex-connectorBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit:580d370b7b

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment threadserver/src/services/docker.py Outdated
Comment threadserver/src/services/docker.py Outdated
@PangjipingPangjiping added feature New feature or request component/server labels Feb 12, 2026
Comment threadexamples/docker-pvc-volume-mount/README.md Outdated
Comment threadexamples/docker-pvc-volume-mount/README.md Outdated
Comment threadexamples/docker-pvc-volume-mount/README_zh.md
Comment threadserver/src/services/docker.py Outdated
hittytand others added 9 commits February 13, 2026 14:18
This commit implements Docker named volume support for the PVC backend,
with full subPath support to enable fine-grained path isolation within
named volumes, consistent with Kubernetes PVC subPath behavior.
- `server/src/services/docker.py`:
- `_validate_pvc_volume`: Now validates named volume existence via
`docker volume inspect`, validates driver is "local" when subPath
is used, checks Mountpoint exists, validates resolved subPath
exists, and adds path traversal protection
- `_build_volume_binds`: Generates appropriate bind strings:
- Without subPath: `volume-name:/container/path:ro|rw`
- With subPath: `/var/lib/docker/volumes/.../subdir:/container/path:ro|rw`
- `server/src/services/constants.py`: Add error codes:
- `PVC_VOLUME_NOT_FOUND`: Named volume does not exist
- `PVC_VOLUME_INSPECT_FAILED`: Docker API call failed
- `PVC_SUBPATH_UNSUPPORTED_DRIVER`: subPath requires "local" driver
- `PVC_SUBPATH_NOT_FOUND`: subPath directory does not exist
- `server/src/api/schema.py`: Update PVC documentation to reflect
runtime-neutral behavior (Docker named volumes + Kubernetes PVCs)
- `server/tests/test_docker_service.py`:
- Convert `_build_volume_binds` tests to instance methods
- Add 5 new tests for PVC volume handling:
- `test_single_pvc_volume_rw/ro`
- `test_pvc_volume_with_subpath`
- `test_pvc_volume_with_subpath_readonly`
- `test_mixed_host_and_pvc_volumes`
- Add 5 new validation tests:
- `test_pvc_volume_not_found_rejected`
- `test_pvc_volume_inspect_failure_returns_500`
- `test_pvc_volume_binds_passed_to_docker`
- `test_pvc_subpath_non_local_driver_rejected`
- `test_pvc_subpath_not_found_rejected`
- `test_pvc_subpath_binds_resolved_to_mountpoint`
- All language SDKs now test:
- Read-write named volume mount
- Read-only named volume mount
- SubPath mount with isolation verification
- Test scripts (`scripts/*-e2e.sh`) now seed named volume with
subPath test data (`datasets/train/marker.txt`)
- `oseps/0003-volume-and-volumebinding-support.md`: Update to reflect
cross-runtime PVC behavior and subPath support in Docker
- `specs/sandbox-lifecycle.yml`: Update PVC component documentation
- `examples/docker-pvc-volume-mount/`: New example demonstrating:
- Read-write/read-only named volume mounts
- Cross-sandbox data sharing
- SubPath isolation
The `pvc` backend is now a runtime-neutral abstraction:
- **Docker**: Maps to named volumes created via `docker volume create`
- **Kubernetes**: Maps to PersistentVolumeClaims
When `subPath` is specified:
- Volume must use `local` driver (for accessible Mountpoint)
- Resolved path is `Mountpoint + subPath` (bind mount)
- Path traversal protection ensures subPath stays within volume
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- server/src/services/docker.py:
- Cache `docker volume inspect` results in `_validate_volumes` and pass to `_build_volume_binds` to avoid redundant API calls.
- Add symlink-aware path traversal protection in `_validate_pvc_volume` using `os.path.realpath`.
- Use `posixpath` for Docker-internal path operations to ensure cross-platform consistency.
- server/tests/test_docker_service.py:
- Update tests to support the new `pvc_inspect_cache` parameter.
- Add `test_pvc_subpath_symlink_escape_rejected` to verify security protection.
- examples/docker-pvc-volume-mount/:
- Update README and README_zh to use `uv pip install opensandbox-server` for simpler installation.
- Use os.sep instead of hardcoded '/' in realpath-based security checks.
- Use os.path.normpath in tests to ensure cross-platform path matching.
- Clean up redundant imports in test_docker_service.py.
- Introduce run_with_retry_sync to handle flaky kernel/network states.
- Add delays between consecutive runs to mitigate 'session is busy' errors.
- Relax concurrency test requirements to allow 2/3 success in resource-constrained environments.
- Add recovery delay after execution interrupt.
- .github/workflows/real-e2e.yml:
- Switch python-e2e to self-hosted runner.
- Add pre and post execution cleanup for Docker containers and logs.
- tests/python/tests/test_code_interpreter_e2e.py:
- Add per-call timeout and TimeoutError handling to run_with_retry.
- Include 'session is busy' as a retryable error.
- Apply run_with_retry to initial execution calls for all languages to handle flaky kernel initialization.
Pangjiping
Pangjiping previously approved these changes Feb 14, 2026
@jwx0925

Copy link
Copy Markdown
Collaborator

@codex review

@chatgpt-codex-connectorchatgpt-codex-connectorBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit:d2059063df

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment threadserver/src/services/docker.py Outdated
Comment threadserver/src/services/docker.py
@jwx0925

Copy link
Copy Markdown
Collaborator

@codex review

@chatgpt-codex-connectorchatgpt-codex-connectorBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit:b52d62bb55

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment threadserver/src/services/docker.py

@jwx0925jwx0925 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM

@jwx0925
jwx0925 merged commit 58ef919 into opensandbox-group:mainFeb 24, 2026
11 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component/serverfeatureNew feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Named volume for docker backend

3 participants

@hittyt@jwx0925@Pangjiping
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat: add Docker named volume support with subPath for PVC backend - #233

Merged
jwx0925 merged 15 commits into
opensandbox-group:mainfrom
hittyt:feat/docker-named-volume
Feb 24, 2026
Merged

feat: add Docker named volume support with subPath for PVC backend#233
jwx0925 merged 15 commits into
opensandbox-group:mainfrom
hittyt:feat/docker-named-volume

Conversation

@hittyt

Copy link
Copy Markdown
Collaborator

Summary

Closes#221

This commit implements Docker named volume support for the PVC backend, with full subPath support to enable fine-grained path isolation within named volumes, consistent with Kubernetes PVC subPath behavior.

Testing

  • Not run (explain why)
  • Unit tests
  • Integration tests
  • e2e / manual verification

Breaking Changes

  • None
  • Yes (describe impact and migration path)

Checklist

  • Linked Issue or clearly described motivation Named volume for docker backend #221
  • Added/updated docs (if needed)
  • Added/updated tests (if needed)
  • Security impact considered
  • Backward compatibility considered

@jwx0925

Copy link
Copy Markdown
Collaborator

@codex review

@chatgpt-codex-connectorchatgpt-codex-connectorBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit:580d370b7b

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment threadserver/src/services/docker.py Outdated
Comment threadserver/src/services/docker.py Outdated
@PangjipingPangjiping added feature New feature or request component/server labels Feb 12, 2026
Comment threadexamples/docker-pvc-volume-mount/README.md Outdated
Comment threadexamples/docker-pvc-volume-mount/README.md Outdated
Comment threadexamples/docker-pvc-volume-mount/README_zh.md
Comment threadserver/src/services/docker.py Outdated
hittytand others added 9 commits February 13, 2026 14:18
This commit implements Docker named volume support for the PVC backend,
with full subPath support to enable fine-grained path isolation within
named volumes, consistent with Kubernetes PVC subPath behavior.
- `server/src/services/docker.py`:
- `_validate_pvc_volume`: Now validates named volume existence via
`docker volume inspect`, validates driver is "local" when subPath
is used, checks Mountpoint exists, validates resolved subPath
exists, and adds path traversal protection
- `_build_volume_binds`: Generates appropriate bind strings:
- Without subPath: `volume-name:/container/path:ro|rw`
- With subPath: `/var/lib/docker/volumes/.../subdir:/container/path:ro|rw`
- `server/src/services/constants.py`: Add error codes:
- `PVC_VOLUME_NOT_FOUND`: Named volume does not exist
- `PVC_VOLUME_INSPECT_FAILED`: Docker API call failed
- `PVC_SUBPATH_UNSUPPORTED_DRIVER`: subPath requires "local" driver
- `PVC_SUBPATH_NOT_FOUND`: subPath directory does not exist
- `server/src/api/schema.py`: Update PVC documentation to reflect
runtime-neutral behavior (Docker named volumes + Kubernetes PVCs)
- `server/tests/test_docker_service.py`:
- Convert `_build_volume_binds` tests to instance methods
- Add 5 new tests for PVC volume handling:
- `test_single_pvc_volume_rw/ro`
- `test_pvc_volume_with_subpath`
- `test_pvc_volume_with_subpath_readonly`
- `test_mixed_host_and_pvc_volumes`
- Add 5 new validation tests:
- `test_pvc_volume_not_found_rejected`
- `test_pvc_volume_inspect_failure_returns_500`
- `test_pvc_volume_binds_passed_to_docker`
- `test_pvc_subpath_non_local_driver_rejected`
- `test_pvc_subpath_not_found_rejected`
- `test_pvc_subpath_binds_resolved_to_mountpoint`
- All language SDKs now test:
- Read-write named volume mount
- Read-only named volume mount
- SubPath mount with isolation verification
- Test scripts (`scripts/*-e2e.sh`) now seed named volume with
subPath test data (`datasets/train/marker.txt`)
- `oseps/0003-volume-and-volumebinding-support.md`: Update to reflect
cross-runtime PVC behavior and subPath support in Docker
- `specs/sandbox-lifecycle.yml`: Update PVC component documentation
- `examples/docker-pvc-volume-mount/`: New example demonstrating:
- Read-write/read-only named volume mounts
- Cross-sandbox data sharing
- SubPath isolation
The `pvc` backend is now a runtime-neutral abstraction:
- **Docker**: Maps to named volumes created via `docker volume create`
- **Kubernetes**: Maps to PersistentVolumeClaims
When `subPath` is specified:
- Volume must use `local` driver (for accessible Mountpoint)
- Resolved path is `Mountpoint + subPath` (bind mount)
- Path traversal protection ensures subPath stays within volume
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- server/src/services/docker.py:
- Cache `docker volume inspect` results in `_validate_volumes` and pass to `_build_volume_binds` to avoid redundant API calls.
- Add symlink-aware path traversal protection in `_validate_pvc_volume` using `os.path.realpath`.
- Use `posixpath` for Docker-internal path operations to ensure cross-platform consistency.
- server/tests/test_docker_service.py:
- Update tests to support the new `pvc_inspect_cache` parameter.
- Add `test_pvc_subpath_symlink_escape_rejected` to verify security protection.
- examples/docker-pvc-volume-mount/:
- Update README and README_zh to use `uv pip install opensandbox-server` for simpler installation.
- Use os.sep instead of hardcoded '/' in realpath-based security checks.
- Use os.path.normpath in tests to ensure cross-platform path matching.
- Clean up redundant imports in test_docker_service.py.
- Introduce run_with_retry_sync to handle flaky kernel/network states.
- Add delays between consecutive runs to mitigate 'session is busy' errors.
- Relax concurrency test requirements to allow 2/3 success in resource-constrained environments.
- Add recovery delay after execution interrupt.
- .github/workflows/real-e2e.yml:
- Switch python-e2e to self-hosted runner.
- Add pre and post execution cleanup for Docker containers and logs.
- tests/python/tests/test_code_interpreter_e2e.py:
- Add per-call timeout and TimeoutError handling to run_with_retry.
- Include 'session is busy' as a retryable error.
- Apply run_with_retry to initial execution calls for all languages to handle flaky kernel initialization.
Pangjiping
Pangjiping previously approved these changes Feb 14, 2026
@jwx0925

Copy link
Copy Markdown
Collaborator

@codex review

@chatgpt-codex-connectorchatgpt-codex-connectorBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit:d2059063df

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment threadserver/src/services/docker.py Outdated
Comment threadserver/src/services/docker.py
@jwx0925

Copy link
Copy Markdown
Collaborator

@codex review

@chatgpt-codex-connectorchatgpt-codex-connectorBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit:b52d62bb55

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment threadserver/src/services/docker.py

@jwx0925jwx0925 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM

@jwx0925
jwx0925 merged commit 58ef919 into opensandbox-group:mainFeb 24, 2026
11 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component/serverfeatureNew feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Named volume for docker backend

3 participants

@hittyt@jwx0925@Pangjiping
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length \u003e 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat: add Docker named volume support with subPath for PVC backend - #233

Merged
jwx0925 merged 15 commits into
opensandbox-group:mainfrom
hittyt:feat/docker-named-volume
Feb 24, 2026
Merged

feat: add Docker named volume support with subPath for PVC backend#233
jwx0925 merged 15 commits into
opensandbox-group:mainfrom
hittyt:feat/docker-named-volume

Conversation

@hittyt

Copy link
Copy Markdown
Collaborator

Summary

Closes#221

This commit implements Docker named volume support for the PVC backend, with full subPath support to enable fine-grained path isolation within named volumes, consistent with Kubernetes PVC subPath behavior.

Testing

  • Not run (explain why)
  • Unit tests
  • Integration tests
  • e2e / manual verification

Breaking Changes

  • None
  • Yes (describe impact and migration path)

Checklist

  • Linked Issue or clearly described motivation Named volume for docker backend #221
  • Added/updated docs (if needed)
  • Added/updated tests (if needed)
  • Security impact considered
  • Backward compatibility considered

@jwx0925

Copy link
Copy Markdown
Collaborator

@codex review

@chatgpt-codex-connectorchatgpt-codex-connectorBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit:580d370b7b

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment threadserver/src/services/docker.py Outdated
Comment threadserver/src/services/docker.py Outdated
@PangjipingPangjiping added feature New feature or request component/server labels Feb 12, 2026
Comment threadexamples/docker-pvc-volume-mount/README.md Outdated
Comment threadexamples/docker-pvc-volume-mount/README.md Outdated
Comment threadexamples/docker-pvc-volume-mount/README_zh.md
Comment threadserver/src/services/docker.py Outdated
hittytand others added 9 commits February 13, 2026 14:18
This commit implements Docker named volume support for the PVC backend,
with full subPath support to enable fine-grained path isolation within
named volumes, consistent with Kubernetes PVC subPath behavior.
- `server/src/services/docker.py`:
- `_validate_pvc_volume`: Now validates named volume existence via
`docker volume inspect`, validates driver is "local" when subPath
is used, checks Mountpoint exists, validates resolved subPath
exists, and adds path traversal protection
- `_build_volume_binds`: Generates appropriate bind strings:
- Without subPath: `volume-name:/container/path:ro|rw`
- With subPath: `/var/lib/docker/volumes/.../subdir:/container/path:ro|rw`
- `server/src/services/constants.py`: Add error codes:
- `PVC_VOLUME_NOT_FOUND`: Named volume does not exist
- `PVC_VOLUME_INSPECT_FAILED`: Docker API call failed
- `PVC_SUBPATH_UNSUPPORTED_DRIVER`: subPath requires "local" driver
- `PVC_SUBPATH_NOT_FOUND`: subPath directory does not exist
- `server/src/api/schema.py`: Update PVC documentation to reflect
runtime-neutral behavior (Docker named volumes + Kubernetes PVCs)
- `server/tests/test_docker_service.py`:
- Convert `_build_volume_binds` tests to instance methods
- Add 5 new tests for PVC volume handling:
- `test_single_pvc_volume_rw/ro`
- `test_pvc_volume_with_subpath`
- `test_pvc_volume_with_subpath_readonly`
- `test_mixed_host_and_pvc_volumes`
- Add 5 new validation tests:
- `test_pvc_volume_not_found_rejected`
- `test_pvc_volume_inspect_failure_returns_500`
- `test_pvc_volume_binds_passed_to_docker`
- `test_pvc_subpath_non_local_driver_rejected`
- `test_pvc_subpath_not_found_rejected`
- `test_pvc_subpath_binds_resolved_to_mountpoint`
- All language SDKs now test:
- Read-write named volume mount
- Read-only named volume mount
- SubPath mount with isolation verification
- Test scripts (`scripts/*-e2e.sh`) now seed named volume with
subPath test data (`datasets/train/marker.txt`)
- `oseps/0003-volume-and-volumebinding-support.md`: Update to reflect
cross-runtime PVC behavior and subPath support in Docker
- `specs/sandbox-lifecycle.yml`: Update PVC component documentation
- `examples/docker-pvc-volume-mount/`: New example demonstrating:
- Read-write/read-only named volume mounts
- Cross-sandbox data sharing
- SubPath isolation
The `pvc` backend is now a runtime-neutral abstraction:
- **Docker**: Maps to named volumes created via `docker volume create`
- **Kubernetes**: Maps to PersistentVolumeClaims
When `subPath` is specified:
- Volume must use `local` driver (for accessible Mountpoint)
- Resolved path is `Mountpoint + subPath` (bind mount)
- Path traversal protection ensures subPath stays within volume
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- server/src/services/docker.py:
- Cache `docker volume inspect` results in `_validate_volumes` and pass to `_build_volume_binds` to avoid redundant API calls.
- Add symlink-aware path traversal protection in `_validate_pvc_volume` using `os.path.realpath`.
- Use `posixpath` for Docker-internal path operations to ensure cross-platform consistency.
- server/tests/test_docker_service.py:
- Update tests to support the new `pvc_inspect_cache` parameter.
- Add `test_pvc_subpath_symlink_escape_rejected` to verify security protection.
- examples/docker-pvc-volume-mount/:
- Update README and README_zh to use `uv pip install opensandbox-server` for simpler installation.
- Use os.sep instead of hardcoded '/' in realpath-based security checks.
- Use os.path.normpath in tests to ensure cross-platform path matching.
- Clean up redundant imports in test_docker_service.py.
- Introduce run_with_retry_sync to handle flaky kernel/network states.
- Add delays between consecutive runs to mitigate 'session is busy' errors.
- Relax concurrency test requirements to allow 2/3 success in resource-constrained environments.
- Add recovery delay after execution interrupt.
- .github/workflows/real-e2e.yml:
- Switch python-e2e to self-hosted runner.
- Add pre and post execution cleanup for Docker containers and logs.
- tests/python/tests/test_code_interpreter_e2e.py:
- Add per-call timeout and TimeoutError handling to run_with_retry.
- Include 'session is busy' as a retryable error.
- Apply run_with_retry to initial execution calls for all languages to handle flaky kernel initialization.
Pangjiping
Pangjiping previously approved these changes Feb 14, 2026
@jwx0925

Copy link
Copy Markdown
Collaborator

@codex review

@chatgpt-codex-connectorchatgpt-codex-connectorBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit:d2059063df

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment threadserver/src/services/docker.py Outdated
Comment threadserver/src/services/docker.py
@jwx0925

Copy link
Copy Markdown
Collaborator

@codex review

@chatgpt-codex-connectorchatgpt-codex-connectorBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit:b52d62bb55

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment threadserver/src/services/docker.py

@jwx0925jwx0925 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM

@jwx0925
jwx0925 merged commit 58ef919 into opensandbox-group:mainFeb 24, 2026
11 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component/serverfeatureNew feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Named volume for docker backend

3 participants

@hittyt@jwx0925@Pangjiping
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

feat: add Docker named volume support with subPath for PVC backend - #233

Merged
jwx0925 merged 15 commits into
opensandbox-group:mainfrom
hittyt:feat/docker-named-volume
Feb 24, 2026
Merged

feat: add Docker named volume support with subPath for PVC backend#233
jwx0925 merged 15 commits into
opensandbox-group:mainfrom
hittyt:feat/docker-named-volume

Conversation

@hittyt

Copy link
Copy Markdown
Collaborator

Summary

Closes#221

This commit implements Docker named volume support for the PVC backend, with full subPath support to enable fine-grained path isolation within named volumes, consistent with Kubernetes PVC subPath behavior.

Testing

  • Not run (explain why)
  • Unit tests
  • Integration tests
  • e2e / manual verification

Breaking Changes

  • None
  • Yes (describe impact and migration path)

Checklist

  • Linked Issue or clearly described motivation Named volume for docker backend #221
  • Added/updated docs (if needed)
  • Added/updated tests (if needed)
  • Security impact considered
  • Backward compatibility considered

@jwx0925

Copy link
Copy Markdown
Collaborator

@codex review

@chatgpt-codex-connectorchatgpt-codex-connectorBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit:580d370b7b

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment threadserver/src/services/docker.py Outdated
Comment threadserver/src/services/docker.py Outdated
@PangjipingPangjiping added feature New feature or request component/server labels Feb 12, 2026
Comment threadexamples/docker-pvc-volume-mount/README.md Outdated
Comment threadexamples/docker-pvc-volume-mount/README.md Outdated
Comment threadexamples/docker-pvc-volume-mount/README_zh.md
Comment threadserver/src/services/docker.py Outdated
hittytand others added 9 commits February 13, 2026 14:18
This commit implements Docker named volume support for the PVC backend,
with full subPath support to enable fine-grained path isolation within
named volumes, consistent with Kubernetes PVC subPath behavior.
- `server/src/services/docker.py`:
- `_validate_pvc_volume`: Now validates named volume existence via
`docker volume inspect`, validates driver is "local" when subPath
is used, checks Mountpoint exists, validates resolved subPath
exists, and adds path traversal protection
- `_build_volume_binds`: Generates appropriate bind strings:
- Without subPath: `volume-name:/container/path:ro|rw`
- With subPath: `/var/lib/docker/volumes/.../subdir:/container/path:ro|rw`
- `server/src/services/constants.py`: Add error codes:
- `PVC_VOLUME_NOT_FOUND`: Named volume does not exist
- `PVC_VOLUME_INSPECT_FAILED`: Docker API call failed
- `PVC_SUBPATH_UNSUPPORTED_DRIVER`: subPath requires "local" driver
- `PVC_SUBPATH_NOT_FOUND`: subPath directory does not exist
- `server/src/api/schema.py`: Update PVC documentation to reflect
runtime-neutral behavior (Docker named volumes + Kubernetes PVCs)
- `server/tests/test_docker_service.py`:
- Convert `_build_volume_binds` tests to instance methods
- Add 5 new tests for PVC volume handling:
- `test_single_pvc_volume_rw/ro`
- `test_pvc_volume_with_subpath`
- `test_pvc_volume_with_subpath_readonly`
- `test_mixed_host_and_pvc_volumes`
- Add 5 new validation tests:
- `test_pvc_volume_not_found_rejected`
- `test_pvc_volume_inspect_failure_returns_500`
- `test_pvc_volume_binds_passed_to_docker`
- `test_pvc_subpath_non_local_driver_rejected`
- `test_pvc_subpath_not_found_rejected`
- `test_pvc_subpath_binds_resolved_to_mountpoint`
- All language SDKs now test:
- Read-write named volume mount
- Read-only named volume mount
- SubPath mount with isolation verification
- Test scripts (`scripts/*-e2e.sh`) now seed named volume with
subPath test data (`datasets/train/marker.txt`)
- `oseps/0003-volume-and-volumebinding-support.md`: Update to reflect
cross-runtime PVC behavior and subPath support in Docker
- `specs/sandbox-lifecycle.yml`: Update PVC component documentation
- `examples/docker-pvc-volume-mount/`: New example demonstrating:
- Read-write/read-only named volume mounts
- Cross-sandbox data sharing
- SubPath isolation
The `pvc` backend is now a runtime-neutral abstraction:
- **Docker**: Maps to named volumes created via `docker volume create`
- **Kubernetes**: Maps to PersistentVolumeClaims
When `subPath` is specified:
- Volume must use `local` driver (for accessible Mountpoint)
- Resolved path is `Mountpoint + subPath` (bind mount)
- Path traversal protection ensures subPath stays within volume
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- server/src/services/docker.py:
- Cache `docker volume inspect` results in `_validate_volumes` and pass to `_build_volume_binds` to avoid redundant API calls.
- Add symlink-aware path traversal protection in `_validate_pvc_volume` using `os.path.realpath`.
- Use `posixpath` for Docker-internal path operations to ensure cross-platform consistency.
- server/tests/test_docker_service.py:
- Update tests to support the new `pvc_inspect_cache` parameter.
- Add `test_pvc_subpath_symlink_escape_rejected` to verify security protection.
- examples/docker-pvc-volume-mount/:
- Update README and README_zh to use `uv pip install opensandbox-server` for simpler installation.
- Use os.sep instead of hardcoded '/' in realpath-based security checks.
- Use os.path.normpath in tests to ensure cross-platform path matching.
- Clean up redundant imports in test_docker_service.py.
- Introduce run_with_retry_sync to handle flaky kernel/network states.
- Add delays between consecutive runs to mitigate 'session is busy' errors.
- Relax concurrency test requirements to allow 2/3 success in resource-constrained environments.
- Add recovery delay after execution interrupt.
- .github/workflows/real-e2e.yml:
- Switch python-e2e to self-hosted runner.
- Add pre and post execution cleanup for Docker containers and logs.
- tests/python/tests/test_code_interpreter_e2e.py:
- Add per-call timeout and TimeoutError handling to run_with_retry.
- Include 'session is busy' as a retryable error.
- Apply run_with_retry to initial execution calls for all languages to handle flaky kernel initialization.
Pangjiping
Pangjiping previously approved these changes Feb 14, 2026
@jwx0925

Copy link
Copy Markdown
Collaborator

@codex review

@chatgpt-codex-connectorchatgpt-codex-connectorBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit:d2059063df

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment threadserver/src/services/docker.py Outdated
Comment threadserver/src/services/docker.py
@jwx0925

Copy link
Copy Markdown
Collaborator

@codex review

@chatgpt-codex-connectorchatgpt-codex-connectorBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit:b52d62bb55

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment threadserver/src/services/docker.py

@jwx0925jwx0925 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM

@jwx0925
jwx0925 merged commit 58ef919 into opensandbox-group:mainFeb 24, 2026
11 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component/serverfeatureNew feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Named volume for docker backend

3 participants

@hittyt@jwx0925@Pangjiping
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat: add Docker named volume support with subPath for PVC backend - #233

Merged
jwx0925 merged 15 commits into
opensandbox-group:mainfrom
hittyt:feat/docker-named-volume
Feb 24, 2026
Merged

feat: add Docker named volume support with subPath for PVC backend#233
jwx0925 merged 15 commits into
opensandbox-group:mainfrom
hittyt:feat/docker-named-volume

Conversation

@hittyt

Copy link
Copy Markdown
Collaborator

Summary

Closes#221

This commit implements Docker named volume support for the PVC backend, with full subPath support to enable fine-grained path isolation within named volumes, consistent with Kubernetes PVC subPath behavior.

Testing

  • Not run (explain why)
  • Unit tests
  • Integration tests
  • e2e / manual verification

Breaking Changes

  • None
  • Yes (describe impact and migration path)

Checklist

  • Linked Issue or clearly described motivation Named volume for docker backend #221
  • Added/updated docs (if needed)
  • Added/updated tests (if needed)
  • Security impact considered
  • Backward compatibility considered

@jwx0925

Copy link
Copy Markdown
Collaborator

@codex review

@chatgpt-codex-connectorchatgpt-codex-connectorBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit:580d370b7b

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment threadserver/src/services/docker.py Outdated
Comment threadserver/src/services/docker.py Outdated
@PangjipingPangjiping added feature New feature or request component/server labels Feb 12, 2026
Comment threadexamples/docker-pvc-volume-mount/README.md Outdated
Comment threadexamples/docker-pvc-volume-mount/README.md Outdated
Comment threadexamples/docker-pvc-volume-mount/README_zh.md
Comment threadserver/src/services/docker.py Outdated
hittytand others added 9 commits February 13, 2026 14:18
This commit implements Docker named volume support for the PVC backend,
with full subPath support to enable fine-grained path isolation within
named volumes, consistent with Kubernetes PVC subPath behavior.
- `server/src/services/docker.py`:
- `_validate_pvc_volume`: Now validates named volume existence via
`docker volume inspect`, validates driver is "local" when subPath
is used, checks Mountpoint exists, validates resolved subPath
exists, and adds path traversal protection
- `_build_volume_binds`: Generates appropriate bind strings:
- Without subPath: `volume-name:/container/path:ro|rw`
- With subPath: `/var/lib/docker/volumes/.../subdir:/container/path:ro|rw`
- `server/src/services/constants.py`: Add error codes:
- `PVC_VOLUME_NOT_FOUND`: Named volume does not exist
- `PVC_VOLUME_INSPECT_FAILED`: Docker API call failed
- `PVC_SUBPATH_UNSUPPORTED_DRIVER`: subPath requires "local" driver
- `PVC_SUBPATH_NOT_FOUND`: subPath directory does not exist
- `server/src/api/schema.py`: Update PVC documentation to reflect
runtime-neutral behavior (Docker named volumes + Kubernetes PVCs)
- `server/tests/test_docker_service.py`:
- Convert `_build_volume_binds` tests to instance methods
- Add 5 new tests for PVC volume handling:
- `test_single_pvc_volume_rw/ro`
- `test_pvc_volume_with_subpath`
- `test_pvc_volume_with_subpath_readonly`
- `test_mixed_host_and_pvc_volumes`
- Add 5 new validation tests:
- `test_pvc_volume_not_found_rejected`
- `test_pvc_volume_inspect_failure_returns_500`
- `test_pvc_volume_binds_passed_to_docker`
- `test_pvc_subpath_non_local_driver_rejected`
- `test_pvc_subpath_not_found_rejected`
- `test_pvc_subpath_binds_resolved_to_mountpoint`
- All language SDKs now test:
- Read-write named volume mount
- Read-only named volume mount
- SubPath mount with isolation verification
- Test scripts (`scripts/*-e2e.sh`) now seed named volume with
subPath test data (`datasets/train/marker.txt`)
- `oseps/0003-volume-and-volumebinding-support.md`: Update to reflect
cross-runtime PVC behavior and subPath support in Docker
- `specs/sandbox-lifecycle.yml`: Update PVC component documentation
- `examples/docker-pvc-volume-mount/`: New example demonstrating:
- Read-write/read-only named volume mounts
- Cross-sandbox data sharing
- SubPath isolation
The `pvc` backend is now a runtime-neutral abstraction:
- **Docker**: Maps to named volumes created via `docker volume create`
- **Kubernetes**: Maps to PersistentVolumeClaims
When `subPath` is specified:
- Volume must use `local` driver (for accessible Mountpoint)
- Resolved path is `Mountpoint + subPath` (bind mount)
- Path traversal protection ensures subPath stays within volume
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- server/src/services/docker.py:
- Cache `docker volume inspect` results in `_validate_volumes` and pass to `_build_volume_binds` to avoid redundant API calls.
- Add symlink-aware path traversal protection in `_validate_pvc_volume` using `os.path.realpath`.
- Use `posixpath` for Docker-internal path operations to ensure cross-platform consistency.
- server/tests/test_docker_service.py:
- Update tests to support the new `pvc_inspect_cache` parameter.
- Add `test_pvc_subpath_symlink_escape_rejected` to verify security protection.
- examples/docker-pvc-volume-mount/:
- Update README and README_zh to use `uv pip install opensandbox-server` for simpler installation.
- Use os.sep instead of hardcoded '/' in realpath-based security checks.
- Use os.path.normpath in tests to ensure cross-platform path matching.
- Clean up redundant imports in test_docker_service.py.
- Introduce run_with_retry_sync to handle flaky kernel/network states.
- Add delays between consecutive runs to mitigate 'session is busy' errors.
- Relax concurrency test requirements to allow 2/3 success in resource-constrained environments.
- Add recovery delay after execution interrupt.
- .github/workflows/real-e2e.yml:
- Switch python-e2e to self-hosted runner.
- Add pre and post execution cleanup for Docker containers and logs.
- tests/python/tests/test_code_interpreter_e2e.py:
- Add per-call timeout and TimeoutError handling to run_with_retry.
- Include 'session is busy' as a retryable error.
- Apply run_with_retry to initial execution calls for all languages to handle flaky kernel initialization.
Pangjiping
Pangjiping previously approved these changes Feb 14, 2026
@jwx0925

Copy link
Copy Markdown
Collaborator

@codex review

@chatgpt-codex-connectorchatgpt-codex-connectorBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit:d2059063df

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment threadserver/src/services/docker.py Outdated
Comment threadserver/src/services/docker.py
@jwx0925

Copy link
Copy Markdown
Collaborator

@codex review

@chatgpt-codex-connectorchatgpt-codex-connectorBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit:b52d62bb55

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment threadserver/src/services/docker.py

@jwx0925jwx0925 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM

@jwx0925
jwx0925 merged commit 58ef919 into opensandbox-group:mainFeb 24, 2026
11 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component/serverfeatureNew feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Named volume for docker backend

3 participants

@hittyt@jwx0925@Pangjiping
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat: add Docker named volume support with subPath for PVC backend - #233

Merged
jwx0925 merged 15 commits into
opensandbox-group:mainfrom
hittyt:feat/docker-named-volume
Feb 24, 2026
Merged

feat: add Docker named volume support with subPath for PVC backend#233
jwx0925 merged 15 commits into
opensandbox-group:mainfrom
hittyt:feat/docker-named-volume

Conversation

@hittyt

Copy link
Copy Markdown
Collaborator

Summary

Closes#221

This commit implements Docker named volume support for the PVC backend, with full subPath support to enable fine-grained path isolation within named volumes, consistent with Kubernetes PVC subPath behavior.

Testing

  • Not run (explain why)
  • Unit tests
  • Integration tests
  • e2e / manual verification

Breaking Changes

  • None
  • Yes (describe impact and migration path)

Checklist

  • Linked Issue or clearly described motivation Named volume for docker backend #221
  • Added/updated docs (if needed)
  • Added/updated tests (if needed)
  • Security impact considered
  • Backward compatibility considered

@jwx0925

Copy link
Copy Markdown
Collaborator

@codex review

@chatgpt-codex-connectorchatgpt-codex-connectorBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit:580d370b7b

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment threadserver/src/services/docker.py Outdated
Comment threadserver/src/services/docker.py Outdated
@PangjipingPangjiping added feature New feature or request component/server labels Feb 12, 2026
Comment threadexamples/docker-pvc-volume-mount/README.md Outdated
Comment threadexamples/docker-pvc-volume-mount/README.md Outdated
Comment threadexamples/docker-pvc-volume-mount/README_zh.md
Comment threadserver/src/services/docker.py Outdated
hittytand others added 9 commits February 13, 2026 14:18
This commit implements Docker named volume support for the PVC backend,
with full subPath support to enable fine-grained path isolation within
named volumes, consistent with Kubernetes PVC subPath behavior.
- `server/src/services/docker.py`:
- `_validate_pvc_volume`: Now validates named volume existence via
`docker volume inspect`, validates driver is "local" when subPath
is used, checks Mountpoint exists, validates resolved subPath
exists, and adds path traversal protection
- `_build_volume_binds`: Generates appropriate bind strings:
- Without subPath: `volume-name:/container/path:ro|rw`
- With subPath: `/var/lib/docker/volumes/.../subdir:/container/path:ro|rw`
- `server/src/services/constants.py`: Add error codes:
- `PVC_VOLUME_NOT_FOUND`: Named volume does not exist
- `PVC_VOLUME_INSPECT_FAILED`: Docker API call failed
- `PVC_SUBPATH_UNSUPPORTED_DRIVER`: subPath requires "local" driver
- `PVC_SUBPATH_NOT_FOUND`: subPath directory does not exist
- `server/src/api/schema.py`: Update PVC documentation to reflect
runtime-neutral behavior (Docker named volumes + Kubernetes PVCs)
- `server/tests/test_docker_service.py`:
- Convert `_build_volume_binds` tests to instance methods
- Add 5 new tests for PVC volume handling:
- `test_single_pvc_volume_rw/ro`
- `test_pvc_volume_with_subpath`
- `test_pvc_volume_with_subpath_readonly`
- `test_mixed_host_and_pvc_volumes`
- Add 5 new validation tests:
- `test_pvc_volume_not_found_rejected`
- `test_pvc_volume_inspect_failure_returns_500`
- `test_pvc_volume_binds_passed_to_docker`
- `test_pvc_subpath_non_local_driver_rejected`
- `test_pvc_subpath_not_found_rejected`
- `test_pvc_subpath_binds_resolved_to_mountpoint`
- All language SDKs now test:
- Read-write named volume mount
- Read-only named volume mount
- SubPath mount with isolation verification
- Test scripts (`scripts/*-e2e.sh`) now seed named volume with
subPath test data (`datasets/train/marker.txt`)
- `oseps/0003-volume-and-volumebinding-support.md`: Update to reflect
cross-runtime PVC behavior and subPath support in Docker
- `specs/sandbox-lifecycle.yml`: Update PVC component documentation
- `examples/docker-pvc-volume-mount/`: New example demonstrating:
- Read-write/read-only named volume mounts
- Cross-sandbox data sharing
- SubPath isolation
The `pvc` backend is now a runtime-neutral abstraction:
- **Docker**: Maps to named volumes created via `docker volume create`
- **Kubernetes**: Maps to PersistentVolumeClaims
When `subPath` is specified:
- Volume must use `local` driver (for accessible Mountpoint)
- Resolved path is `Mountpoint + subPath` (bind mount)
- Path traversal protection ensures subPath stays within volume
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- server/src/services/docker.py:
- Cache `docker volume inspect` results in `_validate_volumes` and pass to `_build_volume_binds` to avoid redundant API calls.
- Add symlink-aware path traversal protection in `_validate_pvc_volume` using `os.path.realpath`.
- Use `posixpath` for Docker-internal path operations to ensure cross-platform consistency.
- server/tests/test_docker_service.py:
- Update tests to support the new `pvc_inspect_cache` parameter.
- Add `test_pvc_subpath_symlink_escape_rejected` to verify security protection.
- examples/docker-pvc-volume-mount/:
- Update README and README_zh to use `uv pip install opensandbox-server` for simpler installation.
- Use os.sep instead of hardcoded '/' in realpath-based security checks.
- Use os.path.normpath in tests to ensure cross-platform path matching.
- Clean up redundant imports in test_docker_service.py.
- Introduce run_with_retry_sync to handle flaky kernel/network states.
- Add delays between consecutive runs to mitigate 'session is busy' errors.
- Relax concurrency test requirements to allow 2/3 success in resource-constrained environments.
- Add recovery delay after execution interrupt.
- .github/workflows/real-e2e.yml:
- Switch python-e2e to self-hosted runner.
- Add pre and post execution cleanup for Docker containers and logs.
- tests/python/tests/test_code_interpreter_e2e.py:
- Add per-call timeout and TimeoutError handling to run_with_retry.
- Include 'session is busy' as a retryable error.
- Apply run_with_retry to initial execution calls for all languages to handle flaky kernel initialization.
Pangjiping
Pangjiping previously approved these changes Feb 14, 2026
@jwx0925

Copy link
Copy Markdown
Collaborator

@codex review

@chatgpt-codex-connectorchatgpt-codex-connectorBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit:d2059063df

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment threadserver/src/services/docker.py Outdated
Comment threadserver/src/services/docker.py
@jwx0925

Copy link
Copy Markdown
Collaborator

@codex review

@chatgpt-codex-connectorchatgpt-codex-connectorBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit:b52d62bb55

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment threadserver/src/services/docker.py

@jwx0925jwx0925 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM

@jwx0925
jwx0925 merged commit 58ef919 into opensandbox-group:mainFeb 24, 2026
11 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component/serverfeatureNew feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Named volume for docker backend

3 participants

@hittyt@jwx0925@Pangjiping
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

feat: add Docker named volume support with subPath for PVC backend - #233

Merged
jwx0925 merged 15 commits into
opensandbox-group:mainfrom
hittyt:feat/docker-named-volume
Feb 24, 2026
Merged

feat: add Docker named volume support with subPath for PVC backend#233
jwx0925 merged 15 commits into
opensandbox-group:mainfrom
hittyt:feat/docker-named-volume

Conversation

@hittyt

Copy link
Copy Markdown
Collaborator

Summary

Closes#221

This commit implements Docker named volume support for the PVC backend, with full subPath support to enable fine-grained path isolation within named volumes, consistent with Kubernetes PVC subPath behavior.

Testing

  • Not run (explain why)
  • Unit tests
  • Integration tests
  • e2e / manual verification

Breaking Changes

  • None
  • Yes (describe impact and migration path)

Checklist

  • Linked Issue or clearly described motivation Named volume for docker backend #221
  • Added/updated docs (if needed)
  • Added/updated tests (if needed)
  • Security impact considered
  • Backward compatibility considered

@jwx0925

Copy link
Copy Markdown
Collaborator

@codex review

@chatgpt-codex-connectorchatgpt-codex-connectorBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit:580d370b7b

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment threadserver/src/services/docker.py Outdated
Comment threadserver/src/services/docker.py Outdated
@PangjipingPangjiping added feature New feature or request component/server labels Feb 12, 2026
Comment threadexamples/docker-pvc-volume-mount/README.md Outdated
Comment threadexamples/docker-pvc-volume-mount/README.md Outdated
Comment threadexamples/docker-pvc-volume-mount/README_zh.md
Comment threadserver/src/services/docker.py Outdated
hittytand others added 9 commits February 13, 2026 14:18
This commit implements Docker named volume support for the PVC backend,
with full subPath support to enable fine-grained path isolation within
named volumes, consistent with Kubernetes PVC subPath behavior.
- `server/src/services/docker.py`:
- `_validate_pvc_volume`: Now validates named volume existence via
`docker volume inspect`, validates driver is "local" when subPath
is used, checks Mountpoint exists, validates resolved subPath
exists, and adds path traversal protection
- `_build_volume_binds`: Generates appropriate bind strings:
- Without subPath: `volume-name:/container/path:ro|rw`
- With subPath: `/var/lib/docker/volumes/.../subdir:/container/path:ro|rw`
- `server/src/services/constants.py`: Add error codes:
- `PVC_VOLUME_NOT_FOUND`: Named volume does not exist
- `PVC_VOLUME_INSPECT_FAILED`: Docker API call failed
- `PVC_SUBPATH_UNSUPPORTED_DRIVER`: subPath requires "local" driver
- `PVC_SUBPATH_NOT_FOUND`: subPath directory does not exist
- `server/src/api/schema.py`: Update PVC documentation to reflect
runtime-neutral behavior (Docker named volumes + Kubernetes PVCs)
- `server/tests/test_docker_service.py`:
- Convert `_build_volume_binds` tests to instance methods
- Add 5 new tests for PVC volume handling:
- `test_single_pvc_volume_rw/ro`
- `test_pvc_volume_with_subpath`
- `test_pvc_volume_with_subpath_readonly`
- `test_mixed_host_and_pvc_volumes`
- Add 5 new validation tests:
- `test_pvc_volume_not_found_rejected`
- `test_pvc_volume_inspect_failure_returns_500`
- `test_pvc_volume_binds_passed_to_docker`
- `test_pvc_subpath_non_local_driver_rejected`
- `test_pvc_subpath_not_found_rejected`
- `test_pvc_subpath_binds_resolved_to_mountpoint`
- All language SDKs now test:
- Read-write named volume mount
- Read-only named volume mount
- SubPath mount with isolation verification
- Test scripts (`scripts/*-e2e.sh`) now seed named volume with
subPath test data (`datasets/train/marker.txt`)
- `oseps/0003-volume-and-volumebinding-support.md`: Update to reflect
cross-runtime PVC behavior and subPath support in Docker
- `specs/sandbox-lifecycle.yml`: Update PVC component documentation
- `examples/docker-pvc-volume-mount/`: New example demonstrating:
- Read-write/read-only named volume mounts
- Cross-sandbox data sharing
- SubPath isolation
The `pvc` backend is now a runtime-neutral abstraction:
- **Docker**: Maps to named volumes created via `docker volume create`
- **Kubernetes**: Maps to PersistentVolumeClaims
When `subPath` is specified:
- Volume must use `local` driver (for accessible Mountpoint)
- Resolved path is `Mountpoint + subPath` (bind mount)
- Path traversal protection ensures subPath stays within volume
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- server/src/services/docker.py:
- Cache `docker volume inspect` results in `_validate_volumes` and pass to `_build_volume_binds` to avoid redundant API calls.
- Add symlink-aware path traversal protection in `_validate_pvc_volume` using `os.path.realpath`.
- Use `posixpath` for Docker-internal path operations to ensure cross-platform consistency.
- server/tests/test_docker_service.py:
- Update tests to support the new `pvc_inspect_cache` parameter.
- Add `test_pvc_subpath_symlink_escape_rejected` to verify security protection.
- examples/docker-pvc-volume-mount/:
- Update README and README_zh to use `uv pip install opensandbox-server` for simpler installation.
- Use os.sep instead of hardcoded '/' in realpath-based security checks.
- Use os.path.normpath in tests to ensure cross-platform path matching.
- Clean up redundant imports in test_docker_service.py.
- Introduce run_with_retry_sync to handle flaky kernel/network states.
- Add delays between consecutive runs to mitigate 'session is busy' errors.
- Relax concurrency test requirements to allow 2/3 success in resource-constrained environments.
- Add recovery delay after execution interrupt.
- .github/workflows/real-e2e.yml:
- Switch python-e2e to self-hosted runner.
- Add pre and post execution cleanup for Docker containers and logs.
- tests/python/tests/test_code_interpreter_e2e.py:
- Add per-call timeout and TimeoutError handling to run_with_retry.
- Include 'session is busy' as a retryable error.
- Apply run_with_retry to initial execution calls for all languages to handle flaky kernel initialization.
Pangjiping
Pangjiping previously approved these changes Feb 14, 2026
@jwx0925

Copy link
Copy Markdown
Collaborator

@codex review

@chatgpt-codex-connectorchatgpt-codex-connectorBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit:d2059063df

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment threadserver/src/services/docker.py Outdated
Comment threadserver/src/services/docker.py
@jwx0925

Copy link
Copy Markdown
Collaborator

@codex review

@chatgpt-codex-connectorchatgpt-codex-connectorBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit:b52d62bb55

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment threadserver/src/services/docker.py

@jwx0925jwx0925 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM

@jwx0925
jwx0925 merged commit 58ef919 into opensandbox-group:mainFeb 24, 2026
11 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component/serverfeatureNew feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Named volume for docker backend

3 participants

@hittyt@jwx0925@Pangjiping