feat(audit): persist flash creation records#14
Draft
elibosley wants to merge 1 commit into
Draft
Conversation
- Purpose: give partners a durable per-media audit trail for flash creation actions. - Before: flash and internal boot operations kept detailed operation logs under /tmp, which were useful during the session but did not persist for later partner review. - Problem: partners could not reliably inspect installer media later to confirm which Unraid ZIP, target device, boot settings, or runtime overrides were used. - Change: write compact JSON audit records under /mnt/persist/logs when installer persistence is mounted, including status, selected ZIP checksum, target details, and runtime override checksums. - How: add audit writers to create_flash_boot.sh and create_internal_boot_user.sh, maintain flash-audit-latest.json, prune timestamped records by count and total bytes, and document the retention controls.
📝 WalkthroughWalkthroughThese changes introduce persistent flash audit logging functionality that records flash creation operations as structured JSON entries when a persistent mount is available, capturing operation status, ZIP metadata, device details, and runtime override file checksums with configurable log retention policies. Changes
Sequence DiagramsequenceDiagram
participant Script as Installation Script
participant Audit as Audit System
participant FS as Persistence Layer
Script->>Audit: Initialize audit state (AUDIT_STARTED=1)
activate Audit
Note over Audit: Set default limits, prepare audit context
Script->>Script: Perform flash creation operations
alt Operation succeeds
Script->>Audit: Collect metadata (ZIP, device, overrides)
Audit->>Audit: Compute SHA256s, format JSON
Audit->>FS: Write success audit record to /mnt/persist/logs/
else Operation fails
Script->>Audit: error_msg() updates AUDIT_ERROR
Audit->>Audit: Collect metadata, format JSON with error
Audit->>FS: Write failure audit record via EXIT trap
end
Audit->>FS: Prune old logs (enforce max files/bytes limits)
deactivate Audit
FS-->>FS: Remove excess timestamped audit files
Estimated code review effort🎯 4 (Complex) | ⏱️ ~50 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
Review rate limit: 2/5 reviews remaining, refill in 24 minutes and 29 seconds. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/USER_COMMANDS.md`:
- Around line 186-203: Update the "Persistent Flash Audit Logs" section wording
to state that audit records under /mnt/persist/logs/ include both flash creation
and internal-boot creation actions (specifically mention create_internal_boot as
well as create_flash_boot.sh), so users know the timestamped files
(flash-audit-<timestamp>.json and flash-audit-latest.json) cover installer
actions for both flash and internal-boot; keep the existing details about
included fields, pruning defaults, and the INSTALLER_AUDIT_MAX_FILES /
INSTALLER_AUDIT_MAX_BYTES overrides but change any language that implies
"flash-only" to "installer actions (flash and internal-boot)".
In `@scripts/create_flash_boot.sh`:
- Around line 412-416: The audit filename generation (variables timestamp and
filename) uses only second-level precision and can collide with other scripts
writing the same pattern; change the filename generation to be
collision-resistant by appending a high-resolution timestamp or unique token
(e.g., include nanoseconds from date +%N, the process id $$, or a generated
UUID) or by creating a unique temporary name via mktemp and then moving it into
final; ensure you update tmp/final handling so the unique name is preserved and
latest still points to the correct file (adjust variables filename, tmp, final,
and latest accordingly).
🪄 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 (Legacy)
Run ID: 36869a57-5dfd-4ff2-8c0b-977f6e1c1c99
📒 Files selected for processing (3)
docs/USER_COMMANDS.mdscripts/create_flash_boot.shscripts/create_internal_boot_user.sh
Comment on lines
+186
to
+203
| ## Persistent Flash Audit Logs | ||
|
|
||
| When persistence is mounted, flash creation writes compact JSON audit records to | ||
| the installer media under `/mnt/persist/logs/`. | ||
|
|
||
| - `flash-audit-<timestamp>.json`: timestamped audit record | ||
| - `flash-audit-latest.json`: copy of the latest audit record | ||
|
|
||
| Audit records include the flash action, status, selected Unraid ZIP filename and | ||
| SHA256, target device details, and runtime override SHA256s when override files | ||
| are present. They are written to the installer media persistence partition, not | ||
| to the target Unraid server or newly created flash device. | ||
|
|
||
| To avoid filling persistence, audit logs are pruned after writes. Defaults keep | ||
| at most 25 timestamped audit files and at most 1 MiB total timestamped audit log | ||
| data. Override with `INSTALLER_AUDIT_MAX_FILES` and | ||
| `INSTALLER_AUDIT_MAX_BYTES` if a partner workflow needs a different retention | ||
| window. |
There was a problem hiding this comment.
Document the internal-boot audit path too.
This section reads as flash-only, but the PR also persists create_internal_boot audit records into the same location. Update the wording so users know these files cover both installer actions, not just create_flash_boot.sh.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/USER_COMMANDS.md` around lines 186 - 203, Update the "Persistent Flash
Audit Logs" section wording to state that audit records under /mnt/persist/logs/
include both flash creation and internal-boot creation actions (specifically
mention create_internal_boot as well as create_flash_boot.sh), so users know the
timestamped files (flash-audit-<timestamp>.json and flash-audit-latest.json)
cover installer actions for both flash and internal-boot; keep the existing
details about included fields, pruning defaults, and the
INSTALLER_AUDIT_MAX_FILES / INSTALLER_AUDIT_MAX_BYTES overrides but change any
language that implies "flash-only" to "installer actions (flash and
internal-boot)".
Comment on lines
+412
to
+416
| timestamp="$(date -u '+%Y-%m-%dT%H:%M:%SZ' 2>/dev/null || date)" | ||
| filename="flash-audit-$(date -u '+%Y%m%dT%H%M%SZ' 2>/dev/null || date '+%Y%m%dT%H%M%S').json" | ||
| final="$audit_dir/$filename" | ||
| tmp="$final.tmp" | ||
| latest="$audit_dir/flash-audit-latest.json" |
There was a problem hiding this comment.
Use a collision-resistant audit filename.
This name only has second-level precision, and scripts/create_internal_boot_user.sh writes to the same directory with the same pattern. Two installer actions finishing in the same second will clobber one another and silently drop an audit record.
💡 Suggested fix
- local audit_root audit_dir timestamp filename tmp final latest
+ local audit_root audit_dir timestamp tmp final latest
@@
- filename="flash-audit-$(date -u '+%Y%m%dT%H%M%SZ' 2>/dev/null || date '+%Y%m%dT%H%M%S').json"
- final="$audit_dir/$filename"
- tmp="$final.tmp"
+ tmp="$(mktemp "$audit_dir/flash-audit-$(date -u '+%Y%m%dT%H%M%SZ' 2>/dev/null || date '+%Y%m%dT%H%M%S').XXXXXX.json.tmp")" || return 0
+ final="${tmp%.tmp}"
latest="$audit_dir/flash-audit-latest.json"🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@scripts/create_flash_boot.sh` around lines 412 - 416, The audit filename
generation (variables timestamp and filename) uses only second-level precision
and can collide with other scripts writing the same pattern; change the filename
generation to be collision-resistant by appending a high-resolution timestamp or
unique token (e.g., include nanoseconds from date +%N, the process id $$, or a
generated UUID) or by creating a unique temporary name via mktemp and then
moving it into final; ensure you update tmp/final handling so the unique name is
preserved and latest still points to the correct file (adjust variables
filename, tmp, final, and latest accordingly).
Member
Author
|
Release-readiness triage update on 2026-05-20: Leaving this as a draft enhancement. Persistent flash audit records are useful partner-facing functionality, but this PR is not required for public repository visibility or the minimal/unseeded release path. Before this should be considered merge-ready, it still needs to be refreshed against current |
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
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.
Summary
create_flash_boot.shandcreate_internal_boot_user.shwhen installer persistence is mounted.flash-audit-latest.jsonand prune timestampedflash-audit-*.jsonrecords by count and total bytes to avoid filling persistence.docs/USER_COMMANDS.md.Why
Partners need a durable per-media audit trail for what the installer flashed, but the existing operation logs live under
/tmpand do not survive reboot. These records are written to the installer media persistence partition, not the target Unraid server or newly created flash device.Retention
Defaults:
INSTALLER_AUDIT_MAX_FILES=25INSTALLER_AUDIT_MAX_BYTES=1048576flash-audit-latest.jsonis a convenience copy of the latest record; pruning applies to timestamped audit records.Validation
bash -n scripts/create_flash_boot.shbash -n scripts/create_internal_boot_user.shgit diff --check HEAD~1..HEADshellcheck scripts/create_flash_boot.sh scripts/create_internal_boot_user.shpython3 -m json.toolpython3 -m json.toolINSTALLER_AUDIT_MAX_FILES=2and verifiedflash-audit-latest.jsonis preservedSummary by CodeRabbit
Release Notes
New Features
Documentation