Skip to content

[worker:doc-drift] correct minvmd session-state storage note to persistent ext4 volume - #1166

Merged
twitchyliquid64 merged 1 commit into
mainfrom
chore/doc-drift-minvmd-state-volume-c17bd8bc550e2990
Aug 5, 2026
Merged

[worker:doc-drift] correct minvmd session-state storage note to persistent ext4 volume#1166
twitchyliquid64 merged 1 commit into
mainfrom
chore/doc-drift-minvmd-state-volume-c17bd8bc550e2990

Conversation

@gominimal-aw-bot

@gominimal-aw-bot gominimal-aw-bot Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Resolves the doc-drift finding in #1160: the minvmd crate README "Notes" section — embedded verbatim into docs/internal/minvmd.md via @include — still described guest session state as living on an ephemeral /run/minimal tmpfs, with a persistent data disk called out as an unbuilt follow-up. That follow-up has shipped.

What changed

  • crates/minvmd/README.md — rewrote the drifted "Notes" bullet to describe the current storage model: session state and cache persist on a per-VM writable ext4 data volume (/dev/vdb) that minimald format-on-first-boot mounts at /var/lib/minimal (STATE_VOLUME_MOUNTPOINT), relocating both state and cache onto it, with the /run/minimal tmpfs no longer a fallback. Cites spec 08-spec-vm-ext4-volume (shipped). Removed the "persistent data disk ... is a follow-up" language.

Ground truth (code)

  • crates/minimald/src/guest.rs:396pub const STATE_VOLUME_MOUNTPOINT: &str = "/var/lib/minimal";
  • crates/minimald/src/main.rs:418 — data device /dev/vdb; lines 530-541 mount it and relocate the state + cache dirs onto it.
  • Spec 08-spec-vm-ext4-volume is status: shipped.

Scope is bounded to the single drifted bullet; no other README claims were touched, and no Rust source was modified.

Verification

This is a Markdown-only change to crates/minvmd/README.md. No .rs file was touched, and the README is not embedded into Rust via include_str!, so compilation is unaffected — there is nothing for a cargo build --workspace --all-targets self-check to exercise and no cargo fmt is needed for a doc-only edit. The non-bypassable host backstop still re-runs the full gate before this PR opens: cargo fmt --all --check, cargo build --workspace --all-targets --locked, cargo clippy --workspace --all-targets --locked -- -D warnings, and cargo test --workspace --all-targets --locked.

Closes #1160

Generated by Chore-issue worker agent (side-repo-ops operator) ·

Note

Correct minvmd README to document persistent ext4 volume for session-state storage

Updates the Notes section of README.md to reflect that session state and cache persist on a per-VM writable ext4 data volume (/dev/vdb) mounted at /var/lib/minimal (STATE_VOLUME_MOUNTPOINT), formatted by minimald on first boot. Removes the outdated claim that session state resides on a tmpfs at /run/minimal, and notes that /run/minimal is no longer a fallback and guest session state has no host copy.

Macroscope summarized bf02b29.

Summary by CodeRabbit

  • Documentation
    • Updated storage documentation to clarify that session state and cache data persist on each VM’s writable data volume.
    • Replaced the previous description of temporary storage with the current persistent storage behavior.
    • Removed the outdated note indicating persistent disk support was planned.

…olume

The minvmd README Notes section still described session state as living on an
ephemeral /run/minimal tmpfs with a persistent data disk as an unbuilt
follow-up. That follow-up has shipped (spec 08-spec-vm-ext4-volume): minimald
mounts a per-VM writable ext4 data volume at /dev/vdb -> /var/lib/minimal and
relocates both state and cache onto it, with no tmpfs fallback. Update the note
to match the current implementation. This README is embedded verbatim into
docs/internal/minvmd.md via @include, so the fix propagates there.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@gominimal-aw-bot
gominimal-aw-bot Bot requested a review from a team as a code owner August 3, 2026 19:58
@coderabbitai

coderabbitai Bot commented Aug 3, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The minvmd README now states that session state and cache use a per-VM writable ext4 volume at /var/lib/minimal, backed by /dev/vdb. It removes the outdated tmpfs and future-work descriptions.

Changes

Storage documentation

Layer / File(s) Summary
Document persistent VM storage
crates/minvmd/README.md
The Notes section describes the ext4 data volume mounted at /var/lib/minimal and the storage of session state and cache on that volume.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: norrietaylor

Poem

A rabbit checks the storage note,
Where state and cache now safely float.
On /dev/vdb, the data stays,
Mounted through persistent ways.
No tmpfs tale remains to quote.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Linked Issues check ✅ Passed The README update satisfies issue #1160 by documenting persistent ext4 storage and removing the outdated tmpfs and follow-up claims.
Out of Scope Changes check ✅ Passed The changes are limited to the documented session-state storage note in the minvmd README.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title clearly identifies the documentation drift correction and the persistent session-state storage change.
Description check ✅ Passed The description explains the change, provides code-based context, and documents verification steps, but it omits the template checklist.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/doc-drift-minvmd-state-volume-c17bd8bc550e2990

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

@coderabbitai coderabbitai Bot 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.

Actionable comments posted: 1

🤖 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 `@crates/minvmd/README.md`:
- Around line 238-242: Clarify the README description of the
STATE_VOLUME_MOUNTPOINT sequence by explicitly stating that minimald formats the
ext4 data volume on first boot and then mounts it at /var/lib/minimal. Keep the
existing persistence and /run/minimal behavior unchanged.
🪄 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: 226d00cf-81ba-4155-8743-ea85b1e36c32

📥 Commits

Reviewing files that changed from the base of the PR and between 3e1fcbd and bf02b29.

📒 Files selected for processing (1)
  • crates/minvmd/README.md

Comment thread crates/minvmd/README.md
Comment on lines +238 to +242
- Session state and cache persist on a per-VM writable **ext4 data volume**
(`/dev/vdb`) that minimald format-on-first-boot mounts at `/var/lib/minimal`
(`STATE_VOLUME_MOUNTPOINT`) and relocates both state and cache onto. The
`/run/minimal` tmpfs is no longer a fallback — guest session state is user
data with no host copy. Per spec `08-spec-vm-ext4-volume` (shipped).

@coderabbitai coderabbitai Bot Aug 3, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Clarify the formatting and mounting sequence.

Line 239 uses format-on-first-boot as if it were a verb. This makes it unclear whether minimald formats the volume, mounts it, or performs both actions. Use separate verbs.

Proposed wording
-  (`/dev/vdb`) that minimald format-on-first-boot mounts at `/var/lib/minimal`
-  (`STATE_VOLUME_MOUNTPOINT`) and relocates both state and cache onto.
+  (`/dev/vdb`) that minimald formats on first boot and mounts at
+  `/var/lib/minimal` (`STATE_VOLUME_MOUNTPOINT`), then relocates both state
+  and cache there.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- Session state and cache persist on a per-VM writable **ext4 data volume**
(`/dev/vdb`) that minimald format-on-first-boot mounts at `/var/lib/minimal`
(`STATE_VOLUME_MOUNTPOINT`) and relocates both state and cache onto. The
`/run/minimal` tmpfs is no longer a fallback — guest session state is user
data with no host copy. Per spec `08-spec-vm-ext4-volume` (shipped).
- Session state and cache persist on a per-VM writable **ext4 data volume**
(`/dev/vdb`) that minimald formats on first boot and mounts at
`/var/lib/minimal` (`STATE_VOLUME_MOUNTPOINT`), then relocates both state
and cache there. The `/run/minimal` tmpfs is no longer a fallback — guest
session state is user data with no host copy. Per spec `08-spec-vm-ext4-volume`
(shipped).
🧰 Tools
🪛 LanguageTool

[grammar] ~239-~239: Ensure spelling is correct
Context: ...ext4 data volume* (/dev/vdb) that minimald format-on-first-boot mounts at `/var/li...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🤖 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 `@crates/minvmd/README.md` around lines 238 - 242, Clarify the README
description of the STATE_VOLUME_MOUNTPOINT sequence by explicitly stating that
minimald formats the ext4 data volume on first boot and then mounts it at
/var/lib/minimal. Keep the existing persistence and /run/minimal behavior
unchanged.

Source: Linters/SAST tools

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

[worker-iterate:addressed]
Addressed: split format-on-first-boot into explicit verbs — "minimald formats on first boot and mounts at /var/lib/minimal, then relocates both state and cache there".

Generated by Worker iterate agent (side-repo-ops operator)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Skipped: comment is from another GitHub bot.

@twitchyliquid64
twitchyliquid64 merged commit a3eaa8d into main Aug 5, 2026
30 checks passed
@twitchyliquid64
twitchyliquid64 deleted the chore/doc-drift-minvmd-state-volume-c17bd8bc550e2990 branch August 5, 2026 21:11
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.

agent:doc-drift: minvmd README states session state is ephemeral tmpfs, but it now persists on an ext4 data volume

1 participant