]> git.proxmox.com Git - pve-docs.git/blame - pve-storage-zfspool.adoc
Makefile: cleanup, remove duplicate rules
[pve-docs.git] / pve-storage-zfspool.adoc
CommitLineData
aa039b0f
DM
1Local ZFS Pool Backend
2----------------------
3
4Storage pool type: `zfspool`
5
6This backend allows you to access local ZFS pools (or ZFS filesystems
7inside such pools).
8
9Configuration
10~~~~~~~~~~~~~
11
12The backend supports the common storage properties `content`, `nodes`,
13`disable`, and the following ZFS specific properties:
14
15pool::
16
17Select the ZFS pool/filesystem. All allocations are done within that
18pool.
19
20blocksize::
21
22Set ZFS blocksize parameter.
23
24sparse::
25
26Use ZFS thin-provisioning. A sparse volume is a volume whose
27reservation is not equal to the volume size.
28
29.Configuration Example ('/etc/pve/storage.cfg')
30----
31zfspool: vmdata
32 pool tank/vmdata
33 content rootdir,images
34 sparse
35----
36
37File naming conventions
38~~~~~~~~~~~~~~~~~~~~~~~
39
40The backend uses the following naming scheme for VM images:
41
42 vm-<VMID>-<NAME> // normal VM images
43 base-<VMID>-<NAME> // template VM image (read-only)
44 subvol-<VMID>-<NAME> // subvolumes (ZFS filesystem for containers)
45
46`<VMID>`::
47
48This specifies the owner VM.
49
50`<NAME>`::
51
52This scan be an arbitrary name (`ascii`) without white spaces. The
53backend uses `disk[N]` as default, where `[N]` is replaced by an
54integer to make the name unique.
55
56
57Storage Features
58~~~~~~~~~~~~~~~~
59
60ZFS is probably the most advanced storage type regarding snapshot and
61cloning. The backend uses ZFS datasets for both VM images (format
62`raw`) and container data (format `subvol`). ZFS properties are
63inherited from the parent dataset, so you can simply set defaults
64on the parent dataset.
65
66.Storage features for backend `zfs`
67[width="100%",cols="m,m,3*d",options="header"]
68|==============================================================================
69|Content types |Image formats |Shared |Snapshots |Clones
70|images rootdir |raw subvol |no |yes |yes
71|==============================================================================
72
73Examples
74~~~~~~~~
75
76It is recommended to create and extra ZFS filesystem to store your VM images:
77
78 # zfs create tank/vmdata
79
80To enable compression on that newly allocated filesystem:
81
82 # zfs set compression=on tank/vmdata
83
84You can get a list of available ZFS filesystems with:
85
86 # pvesm zfsscan