Skip to content

Add Singularity/Apptainer quick-start guide and update image refs#19

Merged
t0mdavid-m merged 2 commits into
mainfrom
claude/add-singularity-deployment-zNDIT
May 16, 2026
Merged

Add Singularity/Apptainer quick-start guide and update image refs#19
t0mdavid-m merged 2 commits into
mainfrom
claude/add-singularity-deployment-zNDIT

Conversation

@t0mdavid-m
Copy link
Copy Markdown
Member

@t0mdavid-m t0mdavid-m commented May 16, 2026

Summary

This PR adds comprehensive documentation for running OpenDiaKiosk with Singularity/Apptainer container runtimes, updates all image references to use the correct repository name, and removes the "simple" variant from CI builds.

Key Changes

  • New Singularity/Apptainer quick-start section: Added a new "Alternative: run with Singularity" section in the main README with clear instructions for pulling and running SIF images via ORAS, including bind-mount semantics and port forwarding details
  • Updated image repository references: Corrected all GHCR image references from openms/streamlit-template to openms/opendiakiosk throughout the HPC documentation section
  • Simplified variant matrix: Removed the "simple" variant from the CI build matrix, now only building the "full" variant for SIF images
  • Consistent tag documentation: Updated tag scheme documentation to reflect that only latest, main-full, v*-full, and per-commit SHAs are available (removed references to -simple variants)

Implementation Details

  • The new Singularity section mirrors the Docker setup workflow but uses ORAS transport for direct SIF pulls, eliminating the need for on-the-fly OCI→SIF conversion
  • Documentation clarifies HPC-specific considerations (read-only root filesystem, unprivileged runtime, runtime-state relocation) with a reference to a dedicated HPC section
  • All references now consistently use opendiakiosk as the image name, matching the actual repository structure

https://claude.ai/code/session_01BBxwxciydgHsT9xha8NV69

Summary by CodeRabbit

  • Documentation

    • Added Singularity deployment guide for prebuilt images with volume mount instructions.
    • Updated Apptainer/Singularity documentation with new image sources and tag scheme information.
  • Chores

    • Modified container image publishing configuration.

Review Change Stack

claude and others added 2 commits May 16, 2026 06:12
The self-hosted deployment section only documented Docker, but the SIF
artifact is already published to GHCR. Add a Singularity sub-section so
users on rootless workstations / shared VMs have a one-shot pull+run
example without having to read the HPC section.

Also fix the publish-apptainer job: its matrix included `simple`, but
the build matrix only produces a `full` variant (no Dockerfile_simple
exists), so the artifact download for the simple SIF was guaranteed to
fail on every push. While here, correct the existing HPC section's
leftover `openms/streamlit-template` image refs and drop the dead
`*-simple` tag mentions.
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 16, 2026

Warning

Rate limit exceeded

@t0mdavid-m has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 56 minutes and 29 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 6e0e9c89-ac01-4ae2-860b-c3ab87924e3b

📥 Commits

Reviewing files that changed from the base of the PR and between 42ae5b2 and 719fa7b.

📒 Files selected for processing (1)
  • README.md
📝 Walkthrough

Walkthrough

This PR restricts Apptainer SIF image publishing to the full variant in CI, and adds comprehensive Singularity/Apptainer deployment documentation for both self-hosted and HPC environments, describing how to pull and run prebuilt SIF images from GHCR using the OpenDIAKiosk image with a defined tag scheme.

Changes

Apptainer publishing and deployment documentation

Layer / File(s) Summary
Restrict Apptainer publishing to full variant
.github/workflows/build-and-test.yml
The publish-apptainer job matrix is restricted to variant: [full], removing the simple variant from SIF publishing to GHCR.
Singularity/Apptainer deployment documentation
README.md
README adds a self-hosted Singularity/Apptainer alternative subsection describing ORAS-based SIF pull and bind-mount configuration (/mounted-data read-only, /workspaces-streamlit-template read-write). HPC section updated to reference OpenDIAKiosk SIF from ghcr.io/openms/opendiakiosk/sif:latest, documents available tags (latest, main-full, v*-full, per-commit SHAs), and updates the on-the-fly conversion fallback to use docker://ghcr.io/openms/opendiakiosk:<tag>.

Possibly related PRs

🐰 A workflow refined, images now lean and mean,
Just the full variant, the finest you've seen!
Docs now guide the way, with ORAS in hand,
Singularity and Apptainer, across every land.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main changes: adding Singularity/Apptainer documentation and updating image references in both the README and CI workflow.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/add-singularity-deployment-zNDIT

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@t0mdavid-m t0mdavid-m merged commit 5d72a8b into main May 16, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants