Skip to content

Conversation

@Znerox
Copy link
Contributor

@Znerox Znerox commented Dec 21, 2025

ZFS native encryption is not the same as LUKS.

Summary by CodeRabbit

  • Documentation
    • Updated ZFS storage configuration guidance to clarify encryption options, streamlining the presentation of file system type choices for improved clarity.

✏️ Tip: You can customize this high-level summary in your review settings.

ZFS native encryption is not the same as LUKS.
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 21, 2025

📝 Walkthrough

Walkthrough

A documentation update that removes an explicit note about LUKS encryption in step 7 of the ZFS storage configuration guide. The step instruction now directly states "Set the file system type to zfs or zfs-encrypted" without a separate explanatory note.

Changes

Cohort / File(s) Summary
Documentation Updates
docs/unraid-os/advanced-configurations/optimize-storage/zfs-storage.mdx
Removed explicit LUKS encryption note from step 7; simplified instruction to read "Set the file system type to zfs or zfs-encrypted"

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A note was trimmed with gentle care,
Step seven's lighter now, so fair,
ZFS encrypted, clear and bright,
The docs simplified just right! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description check ⚠️ Warning The description is minimal and lacks required checklist items from the template. The author provided only a brief note about ZFS encryption without completing the documentation submission checklist. Complete the required checklist from the template by verifying all five items (relative links, file naming conventions, asset locations, duplicate PRs, and build status) and marking them appropriately.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the main change: removing a mention of LUKS encryption from the documentation, which directly corresponds to the content modification.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3f8dd0e and e8ab159.

📒 Files selected for processing (1)
  • docs/unraid-os/advanced-configurations/optimize-storage/zfs-storage.mdx (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: deploy-preview
🔇 Additional comments (1)
docs/unraid-os/advanced-configurations/optimize-storage/zfs-storage.mdx (1)

105-105: LGTM! Documentation accuracy improved.

Removing the LUKS reference is appropriate. ZFS native encryption and LUKS are distinct encryption technologies that operate at different layers of the storage stack, and the simplified instruction is clear without the additional note.


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.

@github-actions
Copy link
Contributor

github-actions bot commented Dec 21, 2025

PR Preview Action v1.6.3
Preview removed because the pull request was closed.
2025-12-23 17:41 UTC

@ljm42
Copy link
Member

ljm42 commented Dec 23, 2025

ZFS native encryption is not the same as LUKS.

Correct, and Unraid uses LUKS not ZFS native encryption

@ljm42 ljm42 closed this Dec 23, 2025
@Znerox
Copy link
Contributor Author

Znerox commented Dec 23, 2025

Wow, that's a huge surprise to me. So if anyone does off-site ZFS replication with the "raw" flag set, they think they are sending encrypted data, but they are actually sending it in cleartext. This seems too easy to overlook as a ZFS user.

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