Update note on disk removal GUI requirements #403
Conversation
Clarified that in current releases, the GUI only supports removing disks in RAID 1 configuration. If you do it with other redundant btrfs profiles, it will leave the pool degraded instead.
📝 WalkthroughWalkthroughDocumentation was updated to clarify that the GUI for removing disks in Unraid requires the pool to be configured with RAID 1 for both data and metadata on BTRFS, replacing the previous generic note about redundant RAID profiles. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ 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. 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: 1
🤖 Fix all issues with AI agents
In @docs/unraid-os/using-unraid-to/manage-storage/partials/remove-disk-gui.mdx:
- Line 4: Update the sentence that currently reads "The GUI currently only
supports removing devices if your pool is set up for %%RAID 1|raid1%% (for both
data and metadata for %%BTRFS|btrfs%%)" to (1) add the missing warning that
attempting disk removal via the GUI on pools using other redundant btrfs
profiles will leave the pool degraded, and (2) explicitly state the behavior for
ZFS pools (whether the RAID 1 requirement applies or if ZFS has different
support/limitations). Locate the sentence in remove-disk-gui.mdx and append a
clear warning sentence referencing non-RAID1 btrfs profiles leaving the pool
degraded, then add a short clarification line specifying the equivalent
requirement or difference for ZFS pools (e.g., "For ZFS, ...") so readers know
the exact support and risk.
📜 Review details
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/unraid-os/using-unraid-to/manage-storage/partials/remove-disk-gui.mdx
⏰ 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
|
|
||
| - You can only remove one drive at a time using the GUI. | ||
| - Make sure your pool is using a redundant %%RAID|raid%% profile (like %%RAID 1|raid1%% for both data and metadata). | ||
| - The GUI currently only supports removing devices if your pool is set up for %%RAID 1|raid1%% (for both data and metadata for %%BTRFS|btrfs%%). |
There was a problem hiding this comment.
Inconsistency with PR description and missing ZFS clarification.
The PR description states this change "notes that attempting disk removal via the GUI on pools using other redundant btrfs profiles will leave the pool degraded," but this warning is not present in the actual documentation. Additionally, while the note specifically mentions BTRFS, the rest of the document references both BTRFS and ZFS (lines 5, 14), but it's unclear whether the RAID 1 requirement also applies to ZFS pools or if ZFS has different requirements.
Consider:
- Adding the warning mentioned in the PR description about non-RAID 1 profiles leaving the pool degraded
- Clarifying whether the RAID 1 requirement applies to ZFS pools or if they have different support
💡 Suggested enhancement
-- The GUI currently only supports removing devices if your pool is set up for %%RAID 1|raid1%% (for both data and metadata for %%BTRFS|btrfs%%).
+- The GUI currently only supports removing devices if your pool is set up for %%RAID 1|raid1%% (for both data and metadata for %%BTRFS|btrfs%%). Attempting to remove devices from %%BTRFS|btrfs%% pools using other redundant profiles via the GUI will leave the pool degraded.📝 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.
| - The GUI currently only supports removing devices if your pool is set up for %%RAID 1|raid1%% (for both data and metadata for %%BTRFS|btrfs%%). | |
| - The GUI currently only supports removing devices if your pool is set up for %%RAID 1|raid1%% (for both data and metadata for %%BTRFS|btrfs%%). Attempting to remove devices from %%BTRFS|btrfs%% pools using other redundant profiles via the GUI will leave the pool degraded. |
🤖 Prompt for AI Agents
In @docs/unraid-os/using-unraid-to/manage-storage/partials/remove-disk-gui.mdx
at line 4, Update the sentence that currently reads "The GUI currently only
supports removing devices if your pool is set up for %%RAID 1|raid1%% (for both
data and metadata for %%BTRFS|btrfs%%)" to (1) add the missing warning that
attempting disk removal via the GUI on pools using other redundant btrfs
profiles will leave the pool degraded, and (2) explicitly state the behavior for
ZFS pools (whether the RAID 1 requirement applies or if ZFS has different
support/limitations). Locate the sentence in remove-disk-gui.mdx and append a
clear warning sentence referencing non-RAID1 btrfs profiles leaving the pool
degraded, then add a short clarification line specifying the equivalent
requirement or difference for ZFS pools (e.g., "For ZFS, ...") so readers know
the exact support and risk.
There was a problem hiding this comment.
- Adding the warning mentioned in the PR description about non-RAID 1 profiles leaving the pool degraded
- Clarifying whether the RAID 1 requirement applies to ZFS pools or if they have different support
I don't think this is needed, the section above this one already mentions btrfs and ZFS, and don't think we need to expand on the degraded issue, since it already says only raid1 is supported, but leave it up to @ljm42, please let me know if prefer that I change it.
There was a problem hiding this comment.
Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!
|
1 participant
Clarified that in current releases, the GUI only supports removing disks in RAID 1 configuration. If you do it with other redundant btrfs profiles, it will leave the pool degraded instead.
Before Submitting This PR, Please Ensure You Have Completed The Following:
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.