Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

zpool-remove.8: describe top-level vdev sector size limitation #12472

Merged

Conversation

smammy
Copy link
Contributor

@smammy smammy commented Aug 11, 2021

Document that top-level vdevs cannot be removed unless all top-level vdevs have the same sector size.

Signed-off-by: Sam Hathaway sam@sam-hathaway.com
Closes: #11339

Motivation and Context

It is currently undocumented that top-level vdevs cannot be removed unless all top-level vdevs have the same sector size. This patch adds this fact to zpool-remove.8.

Description

This patch adds text to zpool-remove.8 to explain that top-level vdevs cannot be removed unless all top-level vdevs have the same sector size.

How Has This Been Tested?

I compiled the manpage to ensure that I hadn't broken anything.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Performance enhancement (non-breaking change which improves efficiency)
  • Code cleanup (non-breaking change which makes code smaller or more readable)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Library ABI change (libzfs, libzfs_core, libnvpair, libuutil and libzfsbootenv)
  • Documentation (a change to man pages or other documentation)

Checklist:

@smammy smammy force-pushed the zpool-remove-document-sector-size-limitation branch from b2af61d to 55560c1 Compare August 12, 2021 16:01
@smammy
Copy link
Contributor Author

smammy commented Aug 13, 2021

Sorry if I messed things up by force-pushing a commit here. (I had a commit message line longer than 72 chars, so checkstyle was failing.)

.Pp
Top-level vdevs can only be removed if the primary pool storage does not contain
a top-level raidz vdev, all top-level vdevs have the same sector size, and the
keys for all encrypted datasets are loaded.
Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for mentioning the sector size restriction, however I think in the updated wording we should make it clear these restriction don't apply to spares, cache and log devices. Only top-level vdevs which are part of the primary pool storage (singletons, mirrors, dedup, and special vdevs). The pool also cannot contain either raidz or draid vdevs.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point. I'll re-work it to be clearer.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@behlendorf I pushed 9f93ea4 with what I think is clearer wording.

Document that top-level vdevs cannot be removed unless all top-level
vdevs have the same sector size.

Signed-off-by: Sam Hathaway <sam@sam-hathaway.com>
Closes: #11339
@smammy smammy force-pushed the zpool-remove-document-sector-size-limitation branch from 55560c1 to 9f93ea4 Compare August 13, 2021 19:39
@behlendorf behlendorf added Status: Code Review Needed Ready for review and testing Type: Documentation Indicates a requested change to the documentation Status: Revision Needed Changes are required for the PR to be accepted and removed Status: Code Review Needed Ready for review and testing labels Aug 13, 2021
@behlendorf behlendorf added Status: Accepted Ready to integrate (reviewed, tested) and removed Status: Revision Needed Changes are required for the PR to be accepted labels Aug 23, 2021
@behlendorf behlendorf merged commit 2e9e2c8 into openzfs:master Aug 23, 2021
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Aug 23, 2021
Document that top-level vdevs cannot be removed unless all top-level
vdevs have the same sector size.

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: George Melikov <mail@gmelikov.ru>
Signed-off-by: Sam Hathaway <sam@sam-hathaway.com>
Closes openzfs#11339
Closes openzfs#12472
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Aug 24, 2021
Document that top-level vdevs cannot be removed unless all top-level
vdevs have the same sector size.

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: George Melikov <mail@gmelikov.ru>
Signed-off-by: Sam Hathaway <sam@sam-hathaway.com>
Closes openzfs#11339
Closes openzfs#12472
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Aug 24, 2021
Document that top-level vdevs cannot be removed unless all top-level
vdevs have the same sector size.

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: George Melikov <mail@gmelikov.ru>
Signed-off-by: Sam Hathaway <sam@sam-hathaway.com>
Closes openzfs#11339
Closes openzfs#12472
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Aug 24, 2021
Document that top-level vdevs cannot be removed unless all top-level
vdevs have the same sector size.

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: George Melikov <mail@gmelikov.ru>
Signed-off-by: Sam Hathaway <sam@sam-hathaway.com>
Closes openzfs#11339
Closes openzfs#12472
behlendorf pushed a commit that referenced this pull request Aug 31, 2021
Document that top-level vdevs cannot be removed unless all top-level
vdevs have the same sector size.

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: George Melikov <mail@gmelikov.ru>
Signed-off-by: Sam Hathaway <sam@sam-hathaway.com>
Closes #11339
Closes #12472
tonyhutter pushed a commit to tonyhutter/zfs that referenced this pull request Sep 15, 2021
Document that top-level vdevs cannot be removed unless all top-level
vdevs have the same sector size.

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: George Melikov <mail@gmelikov.ru>
Signed-off-by: Sam Hathaway <sam@sam-hathaway.com>
Closes openzfs#11339
Closes openzfs#12472
rincebrain pushed a commit to rincebrain/zfs that referenced this pull request Sep 22, 2021
Document that top-level vdevs cannot be removed unless all top-level
vdevs have the same sector size.

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: George Melikov <mail@gmelikov.ru>
Signed-off-by: Sam Hathaway <sam@sam-hathaway.com>
Closes openzfs#11339
Closes openzfs#12472
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Accepted Ready to integrate (reviewed, tested) Type: Documentation Indicates a requested change to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Unability to remove vdev with different ashift values is not documented
3 participants