Design Doc: OCI storage and runtime selection #284
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Proposal to separate image storage from execution configuration: - Clean registry URL scheme (docker://, quay://, ghcr://) - Native OCI format storage with git-annex tracking - Execution profiles (YAML) for reusable run configurations - Profile inheritance with clobber semantics - CLI overrides (--image, --exec) for flexibility Builds on the skopeo branch which implements OCI storage. Includes: - Main proposal: docs/design/image-container-refactor.md - ReproNim integration: docs/design/image-container-refactor-repronim.md - Tutorial: docs/design/tutorial-mriqc-workflow.md - ReproNim example: docs/design/repronim-containers-mriqc-example.md 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #284 +/- ##
=======================================
Coverage 93.88% 93.88%
=======================================
Files 24 24
Lines 1112 1112
=======================================
Hits 1044 1044
Misses 68 68 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Documents: - URL scheme changes (docker:// now OCI, removed dhub://, oci:, shub://) - Storage path changes (.datalad/containers/images/<name>/<version>/) - Execution config removal (cmdexec not set) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
- Use colon separator for versioning (like Docker tags) - Document Docker daemon loading and tagging behavior - Show version defaulting from URL tag - Update usage examples throughout 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
- Use name:version format (colon separator)
- {img} expands to Docker image name (datalad-container/name:version)
- Show docker run examples instead of apptainer/oci paths
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
- Document both Docker and Apptainer usage patterns
- List all placeholders: {img}, {img_path}, {cmd}
- Note support for multiple runtimes
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
- {img} = Docker image name (datalad-container/name:version)
- {img_path} = OCI directory path
- Update profile examples to use correct placeholders
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
- Mark Phase 3 (Execution Profiles) as complete - Update examples to use tested docker-default/apptainer-default profiles - Document implemented features and test commands 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
- Add "very rough draft" status note
- Document available placeholders: {img}, {img_path}, {cmd}
- Add runtime-only profiles option (no image, require --image)
- Update examples to use name:version format (mriqc:23.1.0)
- Fix placeholder usage: oci:{img_path} for apptainer, {img} for docker
- Add datalad save commands to workflow examples
- Simplify Docker profile example
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
asmacdo
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updated PR description:
Design doc for OCI storage and runtime selection refactor.
Builds on the skopeo OCI image storage PR: #277
Key changes:
docker://URLs store images as OCI directories via Skopeo.datalad/environments/<name>/<version>/image/--runtimeflag oncontainers-addto select docker/podman/apptainerURL scheme simplification:
docker://- OCI storage, runtime via--runtimeflagshub://- SIF file, singularity execoci:docker://,dhub://Main doc: docs/design/oci-runtime-refactor.md