freebsd-src/man/man8
Don Brady 5caeef02fa
RAID-Z expansion feature
This feature allows disks to be added one at a time to a RAID-Z group,
expanding its capacity incrementally.  This feature is especially useful
for small pools (typically with only one RAID-Z group), where there
isn't sufficient hardware to add capacity by adding a whole new RAID-Z
group (typically doubling the number of disks).

== Initiating expansion ==

A new device (disk) can be attached to an existing RAIDZ vdev, by
running `zpool attach POOL raidzP-N NEW_DEVICE`, e.g. `zpool attach tank
raidz2-0 sda`.  The new device will become part of the RAIDZ group.  A
"raidz expansion" will be initiated, and the new device will contribute
additional space to the RAIDZ group once the expansion completes.

The `feature@raidz_expansion` on-disk feature flag must be `enabled` to
initiate an expansion, and it remains `active` for the life of the pool.
In other words, pools with expanded RAIDZ vdevs can not be imported by
older releases of the ZFS software.

== During expansion ==

The expansion entails reading all allocated space from existing disks in
the RAIDZ group, and rewriting it to the new disks in the RAIDZ group
(including the newly added device).

The expansion progress can be monitored with `zpool status`.

Data redundancy is maintained during (and after) the expansion.  If a
disk fails while the expansion is in progress, the expansion pauses
until the health of the RAIDZ vdev is restored (e.g. by replacing the
failed disk and waiting for reconstruction to complete).

The pool remains accessible during expansion.  Following a reboot or
export/import, the expansion resumes where it left off.

== After expansion ==

When the expansion completes, the additional space is available for use,
and is reflected in the `available` zfs property (as seen in `zfs list`,
`df`, etc).

Expansion does not change the number of failures that can be tolerated
without data loss (e.g. a RAIDZ2 is still a RAIDZ2 even after
expansion).

A RAIDZ vdev can be expanded multiple times.

After the expansion completes, old blocks remain with their old
data-to-parity ratio (e.g. 5-wide RAIDZ2, has 3 data to 2 parity), but
distributed among the larger set of disks.  New blocks will be written
with the new data-to-parity ratio (e.g. a 5-wide RAIDZ2 which has been
expanded once to 6-wide, has 4 data to 2 parity).  However, the RAIDZ
vdev's "assumed parity ratio" does not change, so slightly less space
than is expected may be reported for newly-written blocks, according to
`zfs list`, `df`, `ls -s`, and similar tools.

Sponsored-by: The FreeBSD Foundation
Sponsored-by: iXsystems, Inc.
Sponsored-by: vStack
Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: Mark Maybee <mark.maybee@delphix.com>
Authored-by: Matthew Ahrens <mahrens@delphix.com>
Contributions-by: Fedor Uporov <fuporov.vstack@gmail.com>
Contributions-by: Stuart Maybee <stuart.maybee@comcast.net>
Contributions-by: Thorsten Behrens <tbehrens@outlook.com>
Contributions-by: Fmstrat <nospam@nowsci.com>
Contributions-by: Don Brady <dev.fs.zfs@gmail.com>
Signed-off-by: Don Brady <dev.fs.zfs@gmail.com>
Closes #15022
2023-11-08 10:19:41 -08:00
..
.gitignore Add zfs_prepare_disk script for disk firmware install 2023-09-21 08:36:26 -07:00
fsck.zfs.8 Ubuntu 22.04 integration: mancheck 2022-11-18 11:26:41 -08:00
mount.zfs.8 Replace dead opensolaris.org license link 2022-07-11 14:16:13 -07:00
vdev_id.8 Ubuntu 22.04 integration: mancheck 2022-11-18 11:26:41 -08:00
zdb.8 zdb: Add missing poolname to -C synopsis 2023-06-29 10:54:43 -07:00
zed.8.in Ubuntu 22.04 integration: mancheck 2022-11-18 11:26:41 -08:00
zfs-allow.8 Ubuntu 22.04 integration: mancheck 2022-11-18 11:26:41 -08:00
zfs-bookmark.8 Replace dead opensolaris.org license link 2022-07-11 14:16:13 -07:00
zfs-change-key.8 Reorganize zfs(8) man page into sections 2019-11-12 11:17:40 -08:00
zfs-clone.8 Replace dead opensolaris.org license link 2022-07-11 14:16:13 -07:00
zfs-create.8 zfs-create(8): ZFS for swap: caution, clarity 2023-06-02 11:25:13 -07:00
zfs-destroy.8 Replace dead opensolaris.org license link 2022-07-11 14:16:13 -07:00
zfs-diff.8 Replace dead opensolaris.org license link 2022-07-11 14:16:13 -07:00
zfs-get.8 Reorganize zfs(8) man page into sections 2019-11-12 11:17:40 -08:00
zfs-groupspace.8 Reorganize zfs(8) man page into sections 2019-11-12 11:17:40 -08:00
zfs-hold.8 Adds the -p option to zfs holds 2022-11-08 10:08:21 -08:00
zfs-inherit.8 Reorganize zfs(8) man page into sections 2019-11-12 11:17:40 -08:00
zfs-jail.8 Ubuntu 22.04 integration: mancheck 2022-11-18 11:26:41 -08:00
zfs-list.8 Replace dead opensolaris.org license link 2022-07-11 14:16:13 -07:00
zfs-load-key.8 Ubuntu 22.04 integration: mancheck 2022-11-18 11:26:41 -08:00
zfs-mount-generator.8.in Ubuntu 22.04 integration: mancheck 2022-11-18 11:26:41 -08:00
zfs-mount.8 Ubuntu 22.04 integration: mancheck 2022-11-18 11:26:41 -08:00
zfs-program.8 Add zfs.sync.snapshot_rename 2022-09-02 13:31:19 -07:00
zfs-project.8 Ubuntu 22.04 integration: mancheck 2022-11-18 11:26:41 -08:00
zfs-projectspace.8 Reorganize zfs(8) man page into sections 2019-11-12 11:17:40 -08:00
zfs-promote.8 Ubuntu 22.04 integration: mancheck 2022-11-18 11:26:41 -08:00
zfs-receive.8 Improve tests and update man page for healing recv 2023-03-15 10:34:10 -07:00
zfs-recv.8 Reorganize zfs(8) man page into sections 2019-11-12 11:17:40 -08:00
zfs-redact.8 Reorganize zfs(8) man page into sections 2019-11-12 11:17:40 -08:00
zfs-release.8 Reorganize zfs(8) man page into sections 2019-11-12 11:17:40 -08:00
zfs-rename.8 Replace dead opensolaris.org license link 2022-07-11 14:16:13 -07:00
zfs-rollback.8 Replace dead opensolaris.org license link 2022-07-11 14:16:13 -07:00
zfs-send.8 libzfs: sendrecv: send_progress_thread: handle SIGINFO/SIGUSR1 2023-08-08 09:35:35 -07:00
zfs-set.8 Add '-u' - nomount flag for zfs set 2023-10-02 16:58:54 -07:00
zfs-share.8 Replace dead opensolaris.org license link 2022-07-11 14:16:13 -07:00
zfs-snapshot.8 Replace dead opensolaris.org license link 2022-07-11 14:16:13 -07:00
zfs-unallow.8 Reorganize zfs(8) man page into sections 2019-11-12 11:17:40 -08:00
zfs-unjail.8 Add FreeBSD jail support hooks 2019-12-11 11:58:37 -08:00
zfs-unload-key.8 Reorganize zfs(8) man page into sections 2019-11-12 11:17:40 -08:00
zfs-unmount.8 Reorganize zfs(8) man page into sections 2019-11-12 11:17:40 -08:00
zfs-unzone.8 Add Linux namespace delegation support 2022-06-10 09:51:46 -07:00
zfs-upgrade.8 Replace dead opensolaris.org license link 2022-07-11 14:16:13 -07:00
zfs-userspace.8 Ubuntu 22.04 integration: mancheck 2022-11-18 11:26:41 -08:00
zfs-wait.8 Replace dead opensolaris.org license link 2022-07-11 14:16:13 -07:00
zfs-zone.8 Replace dead opensolaris.org license link 2022-07-11 14:16:13 -07:00
zfs.8 Add colored output to zfs list 2023-03-24 10:24:11 -07:00
zfs_ids_to_path.8 Replace dead opensolaris.org license link 2022-07-11 14:16:13 -07:00
zfs_prepare_disk.8.in Add zfs_prepare_disk script for disk firmware install 2023-09-21 08:36:26 -07:00
zgenhostid.8 Replace dead opensolaris.org license link 2022-07-11 14:16:13 -07:00
zinject.8 Ubuntu 22.04 integration: mancheck 2022-11-18 11:26:41 -08:00
zpool-add.8 Replace dead opensolaris.org license link 2022-07-11 14:16:13 -07:00
zpool-attach.8 RAID-Z expansion feature 2023-11-08 10:19:41 -08:00
zpool-checkpoint.8 Replace dead opensolaris.org license link 2022-07-11 14:16:13 -07:00
zpool-clear.8 Replace dead opensolaris.org license link 2022-07-11 14:16:13 -07:00
zpool-create.8 Remove unnecessary commas in zpool-create.8 2023-06-27 16:58:32 -07:00
zpool-destroy.8 Replace dead opensolaris.org license link 2022-07-11 14:16:13 -07:00
zpool-detach.8 Replace dead opensolaris.org license link 2022-07-11 14:16:13 -07:00
zpool-events.8 Don't emit cksum_{actual_expected} in ereport.fs.zfs.checksum events 2023-07-21 11:49:26 -07:00
zpool-export.8 Ubuntu 22.04 integration: mancheck 2022-11-18 11:26:41 -08:00
zpool-get.8 Replace dead opensolaris.org license link 2022-07-11 14:16:13 -07:00
zpool-history.8 Replace dead opensolaris.org license link 2022-07-11 14:16:13 -07:00
zpool-import.8 Replace dead opensolaris.org license link 2022-07-11 14:16:13 -07:00
zpool-initialize.8 Add the ability to uninitialize 2023-05-18 10:02:20 -07:00
zpool-iostat.8 Ubuntu 22.04 integration: mancheck 2022-11-18 11:26:41 -08:00
zpool-labelclear.8 Replace dead opensolaris.org license link 2022-07-11 14:16:13 -07:00
zpool-list.8 Replace dead opensolaris.org license link 2022-07-11 14:16:13 -07:00
zpool-offline.8 Replace dead opensolaris.org license link 2022-07-11 14:16:13 -07:00
zpool-online.8 Reorganize zpool(8) man page into sections 2019-11-13 09:21:07 -08:00
zpool-reguid.8 Replace dead opensolaris.org license link 2022-07-11 14:16:13 -07:00
zpool-remove.8 Ubuntu 22.04 integration: mancheck 2022-11-18 11:26:41 -08:00
zpool-reopen.8 Replace dead opensolaris.org license link 2022-07-11 14:16:13 -07:00
zpool-replace.8 Replace dead opensolaris.org license link 2022-07-11 14:16:13 -07:00
zpool-resilver.8 Ubuntu 22.04 integration: mancheck 2022-11-18 11:26:41 -08:00
zpool-scrub.8 Do not report bytes skipped by scan as issued. 2023-06-30 08:47:13 -07:00
zpool-set.8 Reorganize zpool(8) man page into sections 2019-11-13 09:21:07 -08:00
zpool-split.8 Ubuntu 22.04 integration: mancheck 2022-11-18 11:26:41 -08:00
zpool-status.8 Enable the head_errlog feature to remove errors 2023-05-09 08:53:27 -07:00
zpool-sync.8 Replace dead opensolaris.org license link 2022-07-11 14:16:13 -07:00
zpool-trim.8 Replace dead opensolaris.org license link 2022-07-11 14:16:13 -07:00
zpool-upgrade.8 Ubuntu 22.04 integration: mancheck 2022-11-18 11:26:41 -08:00
zpool-wait.8 RAID-Z expansion feature 2023-11-08 10:19:41 -08:00
zpool.8 checkstyle: fix action failures 2023-08-29 09:12:40 -07:00
zpool_influxdb.8 Consistentify miscellaneous style on remaining manpages 2021-06-09 14:35:53 -07:00
zstream.8 Add ability to recompress send streams with new compression algorithm 2022-11-10 15:23:46 -08:00
zstreamdump.8 zstreamdump: replace with link to zstream 2021-05-21 10:16:14 -07:00