ZFS - Revision history

John3-16: Style/grammar amendments.

2026-04-23T01:36:49Z

Style/grammar amendments.

← Older revision		Revision as of 01:36, 23 April 2026
Line 55:		Line 55:
	== Maintenance ==		== Maintenance ==

	On Alpine Linux, there in no cron/script provided to scrub (and eventually trim) your pool(s) on a regular basis, like in other Linux distributions.		On Alpine Linux, there is no cron/script provided to scrub (and eventually trim) your pool(s) on a regular basis, like in other Linux distributions.

	=== Scrub ===		=== Scrub ===
Line 114:		Line 114:
	Make the script executable: {{cmd\|# chmod +x /usr/libexec/zfs/scrub}}		Make the script executable: {{cmd\|# chmod +x /usr/libexec/zfs/scrub}}

	It is recommended to scrub regularly to ~~assure~~ your pool(s) and data are in good shape. In our example, the scrub script will be launched once a month, on the 2nd Sunday of the month using [[cron]].		It is recommended to scrub regularly to ensure that your pool(s) and data are in good shape. In our example, the scrub script will be launched once a month, on the 2nd Sunday of the month using [[cron]].

	Edit your crontabs using the command: {{cmd\|# crontab -e}}		Edit your crontabs using the command: {{cmd\|# crontab -e}}
Line 120:		Line 120:
	and add these 2 lines:		and add these 2 lines:
	<pre>		<pre>
	# ~~zfs~~ scrub the 2nd Sunday of every month		# ZFS scrub the 2nd Sunday of every month
	24 0 8-14 * * if [ $(date +\%w) -eq 0 ] && [ -x /usr/libexec/zfs/scrub ]; then /usr/libexec/zfs/scrub; fi		24 0 8-14 * * if [ $(date +\%w) -eq 0 ] && [ -x /usr/libexec/zfs/scrub ]; then /usr/libexec/zfs/scrub; fi
	</pre>		</pre>
Line 195:		Line 195:
	Make the script executable: {{cmd\|# chmod +x /usr/libexec/zfs/trim}}		Make the script executable: {{cmd\|# chmod +x /usr/libexec/zfs/trim}}

	It is recommended to trim regularly to ensure that your pool(s) and data are in good shape. In our example, the trim script will be launched once a month, on the 1st Sunday of the month using [[cron]]		It is recommended to trim regularly to ensure that your pool(s) and data are in good shape. In our example, the trim script will be launched once a month, on the 1st Sunday of the month using [[cron]].

	Edit your crontabs using the command: {{cmd\|# crontab -e}}		Edit your crontabs using the command: {{cmd\|# crontab -e}}
	and add these 2 lines:		and add these 2 lines:
	<pre>		<pre>
	# ~~zfs~~ trim the 1st Sunday of every month		# ZFS trim the 1st Sunday of every month
	24 0 1-7 * * if [ $(date +\%w) -eq 0 ] && [ -x /usr/libexec/zfs/trim ]; then /usr/libexec/zfs/trim; fi		24 0 1-7 * * if [ $(date +\%w) -eq 0 ] && [ -x /usr/libexec/zfs/trim ]; then /usr/libexec/zfs/trim; fi
	</pre>		</pre>

John3-16: Style/grammar amendments.

2026-04-21T04:23:30Z

Style/grammar amendments.

← Older revision		Revision as of 04:23, 21 April 2026
Line 65:		Line 65:
	A scrub is split into two parts: metadata scanning and block scrubbing. The metadata scanning sorts blocks into large sequential ranges which can then be read much more efficiently from disk when issuing the scrub I/O.		A scrub is split into two parts: metadata scanning and block scrubbing. The metadata scanning sorts blocks into large sequential ranges which can then be read much more efficiently from disk when issuing the scrub I/O.

	This script is taken from ~~debian zfs~~ scripts. It is used to list the pools, ~~make~~ sure they are online, and no scrub is being done at the time. The contents of the script placed at {{path\|/usr/libexec/zfs/scrub}} are as follows:{{cat\|/usr/libexec/zfs/scrub\|<nowiki>#!/bin/sh -eu		This script is taken from Debian ZFS scripts. It is used to list the pools, making sure that they are online and that no scrub is being done at the time. The contents of the script placed at {{path\|/usr/libexec/zfs/scrub}} are as follows:{{cat\|/usr/libexec/zfs/scrub\|<nowiki>#!/bin/sh -eu

	# directly exit successfully when zfs module is not loaded		# directly exit successfully when zfs module is not loaded
Line 114:		Line 114:
	Make the script executable: {{cmd\|# chmod +x /usr/libexec/zfs/scrub}}		Make the script executable: {{cmd\|# chmod +x /usr/libexec/zfs/scrub}}

	It is recommended to scrub regularly to assure your pool(s) and ~~datas~~ are in good shape. In our example, the scrub script will be launched once a month, on the 2nd Sunday of the month using [[cron]].		It is recommended to scrub regularly to assure your pool(s) and data are in good shape. In our example, the scrub script will be launched once a month, on the 2nd Sunday of the month using [[cron]].

	Edit your crontabs using the command: {{cmd\|# crontab -e}}		Edit your crontabs using the command: {{cmd\|# crontab -e}}
Line 128:		Line 128:
	The command {{ic\|zpool trim}} initiates an immediate on-demand TRIM operation for all of the free space in a pool. This operation informs the underlying storage devices of all blocks in the pool which are no longer allocated and allows thinly provisioned devices to reclaim the space.		The command {{ic\|zpool trim}} initiates an immediate on-demand TRIM operation for all of the free space in a pool. This operation informs the underlying storage devices of all blocks in the pool which are no longer allocated and allows thinly provisioned devices to reclaim the space.

	A manual on-demand TRIM operation can be initiated irrespective of the [https://openzfs.github.io/openzfs-docs/man/v2.2/7/zpoolprops.7.html#autotrim autotrim] pool property setting. The link shows the types of ~~vdev~~ devices ~~which~~ can be trimmed.		A manual on-demand TRIM operation can be initiated irrespective of the [https://openzfs.github.io/openzfs-docs/man/v2.2/7/zpoolprops.7.html#autotrim autotrim] pool property setting. The link shows the types of VDEV devices that can be trimmed.

	This script is taken from ~~debian zfs~~ scripts. It is used to list the pools, ~~make~~ sure they are online, ~~build~~ only with ~~NVME ssd~~ drive(s) and no trim is being done at the time. The contents of the script placed at {{path\|/usr/libexec/zfs/trim}} is as follows:{{cat\|/usr/libexec/zfs/trim\|<nowiki>#!/bin/sh -eu		This script is taken from Debian ZFS scripts. It is used to list the pools, making sure that they are online, built only with NVMe SSD drive(s) and that no trim is being done at the time. The contents of the script placed at {{path\|/usr/libexec/zfs/trim}} are as follows:{{cat\|/usr/libexec/zfs/trim\|<nowiki>#!/bin/sh -eu

	# directly exit successfully when zfs module is not loaded		# directly exit successfully when zfs module is not loaded
Line 195:		Line 195:
	Make the script executable: {{cmd\|# chmod +x /usr/libexec/zfs/trim}}		Make the script executable: {{cmd\|# chmod +x /usr/libexec/zfs/trim}}

	It is recommended to trim regularly to ~~assure~~ your pool(s) and ~~datas~~ are in good shape. So the trim script will be launched once a month, on the 1st ~~sunday~~ of the month using [[cron]]		It is recommended to trim regularly to ensure that your pool(s) and data are in good shape. In our example, the trim script will be launched once a month, on the 1st Sunday of the month using [[cron]]

	Edit your crontabs using the command: {{cmd\|# crontab -e}}		Edit your crontabs using the command: {{cmd\|# crontab -e}}
	and add these 2 lines		and add these 2 lines:
	<pre>		<pre>
	# zfs trim the ~~first sunday~~ of every month		# zfs trim the 1st Sunday of every month
	24 0 1-7 * * if [ $(date +\%w) -eq 0 ] && [ -x /usr/libexec/zfs/trim ]; then /usr/libexec/zfs/trim; fi		24 0 1-7 * * if [ $(date +\%w) -eq 0 ] && [ -x /usr/libexec/zfs/trim ]; then /usr/libexec/zfs/trim; fi
	</pre>		</pre>

John3-16: Style/grammar amendments.

2026-04-19T03:59:10Z

Style/grammar amendments.

Apropos: fix: replace markdown code syntax with mediawiki syntax

2026-04-12T05:26:38Z

fix: replace markdown code syntax with mediawiki syntax

← Older revision		Revision as of 05:26, 12 April 2026
Line 23:		Line 23:
	=== Create the zpool ===		=== Create the zpool ===

	Replace `/dev/sd...` with the name of the disk or partition where you would like to make the zfs filesystem, such as `/dev/nvme0n1` or `/dev/sda1`. If you would like to be prompted for a password at boot rather than using the key as generated above, then replace `-O keylocation=file:///etc/home.key -O keyformat=raw` with `-O keylocation=prompt -O keyformat=passphrase`. The name "homepool" can be anything.{{Cmd\|<nowiki># zpool create -o ashift=12 -O acltype=posixacl -O compression=lz4 \		Replace <code>/dev/sd...</code> with the name of the disk or partition where you would like to make the zfs filesystem, such as <code>/dev/nvme0n1</code> or <code>/dev/sda1</code>. If you would like to be prompted for a password at boot rather than using the key as generated above, then replace <code>-O keylocation=file:///etc/home.key -O keyformat=raw</code> with <code>-O keylocation=prompt -O keyformat=passphrase</code>. The name "homepool" can be anything.{{Cmd\|<nowiki># zpool create -o ashift=12 -O acltype=posixacl -O compression=lz4 \
	-O dnodesize=auto -O normalization=formD -O relatime=on -O xattr=sa \		-O dnodesize=auto -O normalization=formD -O relatime=on -O xattr=sa \
	-O encryption=aes-256-gcm -O keylocation=file:///etc/home.key -O keyformat=raw \		-O encryption=aes-256-gcm -O keylocation=file:///etc/home.key -O keyformat=raw \

SocksInSpace: add information about zfs-udev to installation section

2026-04-02T18:23:55Z

add information about zfs-udev to installation section

← Older revision		Revision as of 18:23, 2 April 2026
Line 8:		Line 8:
	Ensure that the kernel modules are loaded and verify that the device nodes are present:{{Cmd\|<nowiki># modprobe zfs		Ensure that the kernel modules are loaded and verify that the device nodes are present:{{Cmd\|<nowiki># modprobe zfs
	# mdev -s </nowiki> }}		# mdev -s </nowiki> }}
			If your use of ZFS depends on volumes appearing in {{Path\|/dev/zvol/$ZPOOL/$ZVOL}}, you will also need to [[Eudev\|setup eudev]] and:{{Cmd\|# apk add zfs-udev}}

	== Configuration ==		== Configuration ==

Fossdd: /* Installation */ zfs0

2025-07-11T12:40:23Z

Installation: zfs0

← Older revision		Revision as of 12:40, 11 July 2025
Line 5:		Line 5:
	== Installation ==		== Installation ==

	Install the necessary packages and utilities by using the command:{{Cmd\|# apk add zfs ~~zfs-lts~~}}		Install the necessary packages and utilities by using the command:{{Cmd\|# apk add zfs}}
	Ensure that the kernel modules are loaded and verify that the device nodes are present:{{Cmd\|<nowiki># modprobe zfs		Ensure that the kernel modules are loaded and verify that the device nodes are present:{{Cmd\|<nowiki># modprobe zfs
	# mdev -s </nowiki> }}		# mdev -s </nowiki> }}

Prabuanand: added additional categories

2025-04-02T10:11:19Z

added additional categories

← Older revision		Revision as of 10:11, 2 April 2025
Line 210:		Line 210:
	* [[Setting up ZFS on LUKS]]		* [[Setting up ZFS on LUKS]]
	[[Category:Filesystems]]		[[Category:Filesystems]]
			[[Category:Storage]]
			[[Category:Installation]]
			[[Category:Security]]

Prabuanand: fixed caps

2025-04-02T10:02:51Z

fixed caps

← Older revision		Revision as of 10:02, 2 April 2025
Line 43:		Line 43:
	The last command i.e ''chown'' is likely unnecessary if not creating a homedir.		The last command i.e ''chown'' is likely unnecessary if not creating a homedir.

	=== Service ~~Configuration~~ ===		=== Service configuration ===

	Setup the following services to auto-mount the new filesystem using [[OpenRC]]		Setup the following services to auto-mount the new filesystem using [[OpenRC]]
Line 50:		Line 50:
	Finally to mount the filesystems:{{Cmd\|# rc-update add zfs-mount}}		Finally to mount the filesystems:{{Cmd\|# rc-update add zfs-mount}}

	Reboot the system, so that the encrypted ZFS drive is automounted and becomes available for use.		Reboot the system, so that the encrypted ZFS drive is automounted and becomes available for use.

	== Maintenance ==		== Maintenance ==

Prabuanand: added reference to Root on ZFS with native encryption in introduction

2025-04-02T09:59:56Z

added reference to Root on ZFS with native encryption in introduction

← Older revision		Revision as of 09:59, 2 April 2025
Line 1:		Line 1:
	[https://openzfs.org/wiki/Main_Page ZFS] or OpenZFS is an open-source storage platform. It includes the functionality of both traditional file systems and volume manager.		[https://openzfs.org/wiki/Main_Page ZFS] or OpenZFS is an open-source storage platform. It includes the functionality of both traditional file systems and volume manager.

	This page has instructions for creating and auto-mounting an encrypted ZFS drive or partition on an existing encrypted alpine linux system, using ZFS's own encryption capabilities.		This page has instructions for creating and auto-mounting an encrypted ZFS drive or partition on an existing encrypted alpine linux system, using ZFS's own encryption capabilities. To do fresh install of Alpine Linux with root partition on ZFS, see [[Root on ZFS with native encryption]].

	== Installation ==		== Installation ==

Prabuanand: removed the link

2025-04-02T09:56:19Z

removed the link

← Older revision		Revision as of 09:56, 2 April 2025
Line 207:		Line 207:
	* [https://openzfs.org/wiki/System_Administration ZFS System Administration]		* [https://openzfs.org/wiki/System_Administration ZFS System Administration]
	* [https://openzfs.github.io/openzfs-docs/Getting%20Started/Alpine%20Linux/Root%20on%20ZFS.html OpenZFS Guide for Alpine Linux]		* [https://openzfs.github.io/openzfs-docs/Getting%20Started/Alpine%20Linux/Root%20on%20ZFS.html OpenZFS Guide for Alpine Linux]
	* [[Setting up ZFS with native encryption]]
	* [[Root on ZFS with native encryption]]		* [[Root on ZFS with native encryption]]
	* [[Setting up ZFS on LUKS]]		* [[Setting up ZFS on LUKS]]
	[[Category:Filesystems]]		[[Category:Filesystems]]

← Older revision		Revision as of 03:59, 19 April 2026
Line 1:		Line 1:
	[https://openzfs.org/wiki/Main_Page ZFS] or OpenZFS is an open-source storage platform. It includes the functionality of both traditional file systems and volume manager.		[https://openzfs.org/wiki/Main_Page ZFS] or OpenZFS is an open-source storage platform. It includes the functionality of both traditional file systems and volume manager.

	This page has instructions for creating and ~~auto-mounting~~ an encrypted ZFS drive or partition on an existing encrypted ~~alpine linux~~ system, using ZFS's own encryption capabilities. To do fresh install of Alpine Linux with root partition on ZFS, see [[Root on ZFS with native encryption]].		This page has instructions for creating and automounting an encrypted ZFS drive or partition on an existing encrypted Alpine Linux system using ZFS's own encryption capabilities. To do a fresh install of Alpine Linux with root partition on ZFS, see [[Root on ZFS with native encryption]].

	== Installation ==		== Installation ==
Line 16:		Line 16:
	=== Create an encryption key ===		=== Create an encryption key ===

	This section can be skipped if you intend to unlock the drive by typing a password rather than unlocking automatically. You should use a password instead if your root partition is not encrypted. The location of the file {{Path\|/etc/home.key}} can be ~~anything~~. {{Cmd\|<nowiki># dd if=/dev/random of=/etc/home.key bs=32 count=1		This section can be skipped if you intend to unlock the drive by typing a password rather than unlocking automatically. You should use a password instead if your root partition is not encrypted. The location of the file {{Path\|/etc/home.key}} can be anywhere. {{Cmd\|<nowiki># dd if=/dev/random of=/etc/home.key bs=32 count=1
	# chmod 600 /etc/home.key</nowiki>}}		# chmod 600 /etc/home.key</nowiki>}}

	IMPORTANT: Make sure you don't lose this key by overwriting your root filesystem or ~~anything like that~~. You might want to store a copy of it on an encrypted USB drive, for instance.		IMPORTANT: Make sure you don't lose this key by overwriting your root filesystem or similar. You might want to store a copy of it on an encrypted USB drive, for instance.

	=== Create the zpool ===		=== Create the zpool ===

	Replace <code>/dev/sd...</code> with the name of the disk or partition where you would like to make the zfs filesystem, such as <code>/dev/nvme0n1</code> or <code>/dev/sda1</code>. If you would like to be prompted for a password at boot rather than using the key as generated above, then replace <code>-O keylocation=file:///etc/home.key -O keyformat=raw</code> with <code>-O keylocation=prompt -O keyformat=passphrase</code>. The name "homepool" can be anything.{{Cmd\|<nowiki># zpool create -o ashift=12 -O acltype=posixacl -O compression=lz4 \		Replace <code>/dev/sd...</code> with the name of the disk or partition where you would like to make the zfs filesystem, such as <code>/dev/nvme0n1</code> or <code>/dev/sda1</code>. If you would like to be prompted for a password at boot rather than using the key as generated above, then replace <code>-O keylocation=file:///etc/home.key -O keyformat=raw</code> with <code>-O keylocation=prompt -O keyformat=passphrase</code>. The name <var>"homepool"</var> can be anything.{{Cmd\|<nowiki># zpool create -o ashift=12 -O acltype=posixacl -O compression=lz4 \
	-O dnodesize=auto -O normalization=formD -O relatime=on -O xattr=sa \		-O dnodesize=auto -O normalization=formD -O relatime=on -O xattr=sa \
	-O encryption=aes-256-gcm -O keylocation=file:///etc/home.key -O keyformat=raw \		-O encryption=aes-256-gcm -O keylocation=file:///etc/home.key -O keyformat=raw \
	-O mountpoint=none homepool /dev/sd...</nowiki>}}		-O mountpoint=none homepool /dev/sd...</nowiki>}}

	After completing this, verifying that the pool has been created should return something ~~like:~~:{{Cmd\|<nowiki># zpool status		After completing this, verifying that the pool has been created should return something similar to the following: {{Cmd\|<nowiki># zpool status
	pool: homepool		pool: homepool
	state: ONLINE		state: ONLINE
Line 39:		Line 39:
	errors: No known data errors</nowiki>}}		errors: No known data errors</nowiki>}}

	To create and mount the filesystem issue the command {{Cmd\|<nowiki># zfs create -o mountpoint=/home/username homepool/username		To create and mount the filesystem, issue the command {{Cmd\|<nowiki># zfs create -o mountpoint=/home/username homepool/username
	# chown username:username /home/username </nowiki>}}		# chown username:username /home/username </nowiki>}}

Line 46:		Line 46:
	=== Service configuration ===		=== Service configuration ===

	Setup the following services to ~~auto-mount~~ the new filesystem using [[OpenRC]]		Setup the following services to automount the new filesystem using [[OpenRC]].
	To import existing zpools:{{Cmd\|# rc-update add zfs-import}}		To import existing zpools:{{Cmd\|# rc-update add zfs-import}}
	To load the encryption keys:{{Cmd\|# rc-update add zfs-load-key}}		To load the encryption keys:{{Cmd\|# rc-update add zfs-load-key}}
	Finally to mount the filesystems:{{Cmd\|# rc-update add zfs-mount}}		Finally, to mount the filesystems:{{Cmd\|# rc-update add zfs-mount}}

	Reboot the system, so that the encrypted ZFS drive is automounted and becomes available for use.		Reboot the system so that the encrypted ZFS drive is automounted and becomes available for use.

	== Maintenance ==		== Maintenance ==

	On ~~alpine~~ Linux, there in no cron/script provided to scrub (and eventually trim) your pool(s) on a regular basis, like in other Linux distributions.		On Alpine Linux, there in no cron/script provided to scrub (and eventually trim) your pool(s) on a regular basis, like in other Linux distributions.

	=== Scrub ===		=== Scrub ===

	Scrubbing (and eventually trim) your pool(s) on a [https://blogs.oracle.com/oracle-systems/post/disk-scrub-why-and-when Oracle ~~regular basis~~] ~~is essential~~. The scrub examines all data in the specified pools to verify that it checksums correctly. For replicated (mirror, raidz, or draid) devices, ZFS automatically repairs any damage discovered during the scrub		Scrubbing (and eventually trim) your pool(s) on a regular basis is essential, as discussed in [https://blogs.oracle.com/oracle-systems/post/disk-scrub-why-and-when an official Oracle blog post] on Exadata disk scrubbing. The scrub examines all data in the specified pools to verify that it checksums correctly. For replicated (mirror, raidz, or draid) devices, ZFS automatically repairs any damage discovered during the scrub.

	When scrubbing a pool with encrypted filesystems the keys do not need to be loaded. However, if the keys are not loaded and an unrepairable checksum error is detected the file name cannot be included in the zpool status -v verbose error report.		When scrubbing a pool with encrypted filesystems, the keys do not need to be loaded. However, if the keys are not loaded and an unrepairable checksum error is detected the file name cannot be included in the zpool status -v verbose error report.

	A scrub is split into two parts: metadata scanning and block scrubbing. The metadata scanning sorts blocks into large sequential ranges which can then be read much more efficiently from disk when issuing the scrub I/O.		A scrub is split into two parts: metadata scanning and block scrubbing. The metadata scanning sorts blocks into large sequential ranges which can then be read much more efficiently from disk when issuing the scrub I/O.

	This script is taken from debian zfs scripts. It is used to list the pools, make sure they are online, and no scrub is being done at the time. The contents of the script placed at {{path\|/usr/libexec/zfs/scrub}} is as follows:{{cat\|/usr/libexec/zfs/scrub\|<nowiki>#!/bin/sh -eu		This script is taken from debian zfs scripts. It is used to list the pools, make sure they are online, and no scrub is being done at the time. The contents of the script placed at {{path\|/usr/libexec/zfs/scrub}} are as follows:{{cat\|/usr/libexec/zfs/scrub\|<nowiki>#!/bin/sh -eu

	# directly exit successfully when zfs module is not loaded		# directly exit successfully when zfs module is not loaded
Line 114:		Line 114:
	Make the script executable: {{cmd\|# chmod +x /usr/libexec/zfs/scrub}}		Make the script executable: {{cmd\|# chmod +x /usr/libexec/zfs/scrub}}

	It is recommended to scrub regularly to assure your pool(s) and datas are in good shape. So the scrub script will be launched once a month, on the 2nd ~~sunday~~ of the month using [[cron]]		It is recommended to scrub regularly to assure your pool(s) and datas are in good shape. In our example, the scrub script will be launched once a month, on the 2nd Sunday of the month using [[cron]].

	Edit your crontabs using the command: {{cmd\|# crontab -e}}		Edit your crontabs using the command: {{cmd\|# crontab -e}}

	and add these 2 lines		and add these 2 lines:
	<pre>		<pre>
	# zfs scrub the ~~second sunday~~ of every month		# zfs scrub the 2nd Sunday of every month
	24 0 8-14 * * if [ $(date +\%w) -eq 0 ] && [ -x /usr/libexec/zfs/scrub ]; then /usr/libexec/zfs/scrub; fi		24 0 8-14 * * if [ $(date +\%w) -eq 0 ] && [ -x /usr/libexec/zfs/scrub ]; then /usr/libexec/zfs/scrub; fi
	</pre>		</pre>