zfs: use headings and define help anchors

[pve-docs.git] / local-zfs.adoc

diff --git a/local-zfs.adoc b/local-zfs.adoc
index 76a1ac209391df5169714956262cc765ced42fed..fd03e891cd7c0faadc6ab83f78e43377fb3019fe 100644 (file)
--- a/local-zfs.adoc
+++ b/local-zfs.adoc
@@ -172,7 +172,9 @@ manual pages, which can be read with:
 # man zfs
 -----
 
-.Create a new zpool
+[[sysadmin_zfs_create_new_zpool]]
+Create a new zpool
+^^^^^^^^^^^^^^^^^^
 
 To create a new pool, at least one disk is needed. The `ashift` should
 have the same sector-size (2 power of `ashift`) or larger as the
@@ -188,7 +190,9 @@ To activate compression (see section <<zfs_compression,Compression in ZFS>>):
 # zfs set compression=lz4 <pool>
 ----
 
-.Create a new pool with RAID-0
+[[sysadmin_zfs_create_new_zpool_raid0]]
+Create a new pool with RAID-0
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Minimum 1 disk
 
@@ -196,7 +200,9 @@ Minimum 1 disk
 # zpool create -f -o ashift=12 <pool> <device1> <device2>
 ----
 
-.Create a new pool with RAID-1
+[[sysadmin_zfs_create_new_zpool_raid1]]
+Create a new pool with RAID-1
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Minimum 2 disks
 
@@ -204,7 +210,9 @@ Minimum 2 disks
 # zpool create -f -o ashift=12 <pool> mirror <device1> <device2>
 ----
 
-.Create a new pool with RAID-10
+[[sysadmin_zfs_create_new_zpool_raid10]]
+Create a new pool with RAID-10
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Minimum 4 disks
 
@@ -212,7 +220,9 @@ Minimum 4 disks
 # zpool create -f -o ashift=12 <pool> mirror <device1> <device2> mirror <device3> <device4>
 ----
 
-.Create a new pool with RAIDZ-1
+[[sysadmin_zfs_create_new_zpool_raidz1]]
+Create a new pool with RAIDZ-1
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Minimum 3 disks
 
@@ -220,7 +230,8 @@ Minimum 3 disks
 # zpool create -f -o ashift=12 <pool> raidz1 <device1> <device2> <device3>
 ----
 
-.Create a new pool with RAIDZ-2
+Create a new pool with RAIDZ-2
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Minimum 4 disks
 
@@ -228,7 +239,9 @@ Minimum 4 disks
 # zpool create -f -o ashift=12 <pool> raidz2 <device1> <device2> <device3> <device4>
 ----
 
-.Create a new pool with cache (L2ARC)
+[[sysadmin_zfs_create_new_zpool_with_cache]]
+Create a new pool with cache (L2ARC)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 It is possible to use a dedicated cache drive partition to increase
 the performance (use SSD).
@@ -240,7 +253,9 @@ As `<device>` it is possible to use more devices, like it's shown in
 # zpool create -f -o ashift=12 <pool> <device> cache <cache_device>
 ----
 
-.Create a new pool with log (ZIL)
+[[sysadmin_zfs_create_new_zpool_with_log]]
+Create a new pool with log (ZIL)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 It is possible to use a dedicated cache drive partition to increase
 the performance(SSD).
@@ -252,7 +267,9 @@ As `<device>` it is possible to use more devices, like it's shown in
 # zpool create -f -o ashift=12 <pool> <device> log <log_device>
 ----
 
-.Add cache and log to an existing pool
+[[sysadmin_zfs_add_cache_and_log_dev]]
+Add cache and log to an existing pool
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 If you have a pool without cache and log. First partition the SSD in
 2 partition with `parted` or `gdisk`
@@ -267,7 +284,9 @@ can be used as cache.
 # zpool add -f <pool> log <device-part1> cache <device-part2>
 ----
 
-.Changing a failed device
+[[sysadmin_zfs_change_failed_dev]]
+Changing a failed device
+^^^^^^^^^^^^^^^^^^^^^^^^
 
 ----
 # zpool replace -f <pool> <old device> <new device>
@@ -291,7 +310,7 @@ different steps are needed which depend on the bootloader in use.
 NOTE: Use the `zpool status -v` command to monitor how far the resivlering
 process of the new disk has progressed.
 
-With `systemd-boot`:
+.With `systemd-boot`:
 
 ----
 # pve-efiboot-tool format <new disk's ESP>
@@ -302,7 +321,7 @@ NOTE: `ESP` stands for EFI System Partition, which is setup as partition #2 on
 bootable disks setup by the {pve} installer since version 5.4. For details, see
 xref:sysboot_systemd_boot_setup[Setting up a new partition for use as synced ESP].
 
-With `grub`:
+.With `grub`:
 
 ----
 # grub-install <new disk>
@@ -334,6 +353,7 @@ IMPORTANT: The only setting that is required is `ZED_EMAIL_ADDR`. All
 other settings are optional.
 
 
+[[sysadmin_zfs_limit_memory_usage]]
 Limit ZFS Memory Usage
 ~~~~~~~~~~~~~~~~~~~~~~
 
@@ -510,6 +530,7 @@ You can disable compression at any time with:
 Again, only new blocks will be affected by this change.
 
 
+[[sysadmin_zfs_special_device]]
 ZFS Special Device
 ~~~~~~~~~~~~~~~~~~