docs: use mounts for examples by feloy · Pull Request #91 · openkaiden/openshell-image-builder

feloy · 2026-06-16T11:49:26Z

Update examples in README to use podman mount feature.

codecov · 2026-06-16T11:51:41Z

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

coderabbitai · 2026-06-16T11:52:16Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 97897e9a-2c0d-4c73-9e3e-faad5f525f37

📥 Commits

Reviewing files that changed from the base of the PR and between fc74ddc and 988a798.

📒 Files selected for processing (1)

README.md

🚧 Files skipped from review as they are similar to previous changes (1)

README.md

📝 Walkthrough

Walkthrough

README example commands for sandbox creation across all agent/provider flows (Anthropic, OpenCode+Anthropic, Ollama, OpenAI, Vertex AI) are updated to use --driver-config-json with Podman bind mounts instead of --upload .. The Vertex AI example is further simplified by collapsing the multi-step bashrc injection, sandbox upload, and sandbox connect sequence into a single openshell sandbox create command with inline environment variables.

Changes

README Sandbox Example Updates

Layer / File(s)	Summary
Anthropic and OpenCode/Anthropic sandbox examples `README.md`	Code fence formatting corrected; `--driver-config-json` bind mount replaces `--upload .` in the Claude Code + Anthropic and OpenCode + Anthropic example blocks.
Ollama, OpenAI, and Vertex AI sandbox examples `README.md`	`--driver-config-json` bind mount replaces `--upload .` in the Ollama and OpenAI examples; the Vertex AI example removes the bashrc injection + `sandbox upload` + `sandbox connect` sequence, replacing it with a single `openshell sandbox create` command using bind mounts and inline environment variables.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'docs: use mounts for examples' is concise and directly related to the main change: updating README examples to use podman mount feature instead of copying sources.
Description check	✅ Passed	The description 'Update examples in README to use podman mount feature' is directly related to the changeset, accurately summarizing the core modification of the pull request.
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.}

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.}

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (1)

README.md (1)
509-538: 💤 Low value

Clarify presentation consistency: show both old and new approaches in all examples, or only new.

The first two examples (Claude + Anthropic at 509–538 and OpenCode + Anthropic at 542–571) show both the old --upload . approach and the new --driver-config-json mount approach in a single code block, separated by a comment. However, the OpenAI example (617–636) appears to replace --upload . inline (line 632 marked as changed) without showing both approaches side-by-side for comparison.

For consistency and to help users migrate, either:

Show both old and new in all examples (as in Claude/OpenCode + Anthropic), or

Simplify all to show only the new approach (removing the old code entirely)

The current mixed presentation may confuse readers about which style the documentation prefers.

Also applies to: 542-571, 617-636
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 509 - 538, The README documentation shows
inconsistent presentation of migration approaches across examples. Some examples
(Claude + Anthropic and OpenCode + Anthropic) display both the old `--upload .`
approach and the new `--driver-config-json` mount approach side-by-side in a
single code block separated by comments, while the OpenAI example shows only the
new approach inline. Standardize the presentation by choosing either to show
both old and new approaches in all examples separated by clarifying comments (to
help users migrate), or simplify all examples to show only the new approach
(removing the old code entirely) and apply this chosen style consistently across
all provider examples in the documentation.

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Line 530: The NVIDIA documentation link on lines 530 and 563 in README.md
contains an invalid anchor fragment `#podman-driver-config-mounts` that does not
exist on the NVIDIA documentation page. Fix this by either verifying and
correcting the anchor to point to the actual section name on the NVIDIA docs
page, or remove the anchor fragment entirely to link to the base documentation
URL. Apply the same correction to both locations where this invalid link
appears.

---

Nitpick comments:
In `@README.md`:
- Around line 509-538: The README documentation shows inconsistent presentation
of migration approaches across examples. Some examples (Claude + Anthropic and
OpenCode + Anthropic) display both the old `--upload .` approach and the new
`--driver-config-json` mount approach side-by-side in a single code block
separated by comments, while the OpenAI example shows only the new approach
inline. Standardize the presentation by choosing either to show both old and new
approaches in all examples separated by clarifying comments (to help users
migrate), or simplify all examples to show only the new approach (removing the
old code entirely) and apply this chosen style consistently across all provider
examples in the documentation.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 35d324e1-6ac4-444c-bb08-470dfba5d70e

📥 Commits

Reviewing files that changed from the base of the PR and between 50f27de and fc74ddc.

📒 Files selected for processing (1)

README.md

benoitf · 2026-06-16T12:16:22Z

 $ openshell sandbox create \
  --from sandbox_image:claude_vertexai \
-  --upload . \
+  --env CLAUDE_CODE_USE_VERTEX=1 \


shouldn't it create first a google-vertex-ai type provider ?
https://docs.nvidia.com/openshell/providers/google-vertex-ai

and then use --provider to give this provider

I would prefer to wait for this to stabilize on openshell (NVIDIA/OpenShell#1752 and NVIDIA/OpenShell#1763 are still open) before to document it

benoitf

LGTM for the mounting process but I think for vertex ai, it should use now its provider

Signed-off-by: Philippe Martin <phmartin@redhat.com>

feloy changed the title ~~doc(example): use mounts for examples~~ docs(example): use mounts for examples Jun 16, 2026

feloy changed the title ~~docs(example): use mounts for examples~~ docs(example): use mounts for examples Jun 16, 2026

feloy changed the title ~~docs(example): use mounts for examples~~ chore(docs): use mounts for examples Jun 16, 2026

feloy changed the title ~~chore(docs): use mounts for examples~~ docs: use mounts for examples Jun 16, 2026

coderabbitai Bot reviewed Jun 16, 2026

View reviewed changes

Comment thread README.md

feloy force-pushed the doc-mount branch 2 times, most recently from 9c21865 to c1d542b Compare June 16, 2026 11:54

feloy requested review from benoitf and jeffmaury June 16, 2026 12:04

benoitf reviewed Jun 16, 2026

View reviewed changes

benoitf approved these changes Jun 16, 2026

View reviewed changes

feloy enabled auto-merge (squash) June 16, 2026 13:45

docs: use mounts for examples

988a798

Signed-off-by: Philippe Martin <phmartin@redhat.com>

feloy force-pushed the doc-mount branch from c1d542b to 988a798 Compare June 17, 2026 08:02

feloy merged commit eaddd22 into openkaiden:main Jun 17, 2026
8 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: use mounts for examples#91

docs: use mounts for examples#91
feloy merged 1 commit into
openkaiden:mainfrom
feloy:doc-mount

feloy commented Jun 16, 2026 •

edited

Loading

Uh oh!

codecov Bot commented Jun 16, 2026

Uh oh!

coderabbitai Bot commented Jun 16, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

benoitf Jun 16, 2026

Uh oh!

feloy Jun 16, 2026 •

edited

Loading

Uh oh!

benoitf left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

feloy commented Jun 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov Bot commented Jun 16, 2026

Codecov Report

Uh oh!

coderabbitai Bot commented Jun 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

benoitf Jun 16, 2026

Choose a reason for hiding this comment

Uh oh!

feloy Jun 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

benoitf left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

feloy commented Jun 16, 2026 •

edited

Loading

coderabbitai Bot commented Jun 16, 2026 •

edited

Loading

feloy Jun 16, 2026 •

edited

Loading