]>
Commit | Line | Data |
---|---|---|
80c0adcb | 1 | [[chapter_storage]] |
aa039b0f | 2 | ifdef::manvolnum[] |
b2f242ab DM |
3 | pvesm(1) |
4 | ======== | |
5f09af76 DM |
5 | :pve-toplevel: |
6 | ||
aa039b0f DM |
7 | NAME |
8 | ---- | |
9 | ||
10 | pvesm - Proxmox VE Storage Manager | |
11 | ||
12 | ||
49a5e11c | 13 | SYNOPSIS |
aa039b0f DM |
14 | -------- |
15 | ||
16 | include::pvesm.1-synopsis.adoc[] | |
17 | ||
18 | DESCRIPTION | |
19 | ----------- | |
20 | endif::manvolnum[] | |
aa039b0f DM |
21 | ifndef::manvolnum[] |
22 | {pve} Storage | |
23 | ============= | |
194d2f29 | 24 | :pve-toplevel: |
aa039b0f | 25 | endif::manvolnum[] |
5f09af76 | 26 | ifdef::wiki[] |
cb84ed18 | 27 | :title: Storage |
5f09af76 DM |
28 | endif::wiki[] |
29 | ||
aa039b0f DM |
30 | The {pve} storage model is very flexible. Virtual machine images |
31 | can either be stored on one or several local storages, or on shared | |
32 | storage like NFS or iSCSI (NAS, SAN). There are no limits, and you may | |
33 | configure as many storage pools as you like. You can use all | |
34 | storage technologies available for Debian Linux. | |
35 | ||
36 | One major benefit of storing VMs on shared storage is the ability to | |
37 | live-migrate running machines without any downtime, as all nodes in | |
38 | the cluster have direct access to VM disk images. There is no need to | |
39 | copy VM image data, so live migration is very fast in that case. | |
40 | ||
8c1189b6 | 41 | The storage library (package `libpve-storage-perl`) uses a flexible |
aa039b0f | 42 | plugin system to provide a common interface to all storage types. This |
cc15d2c5 | 43 | can be easily adopted to include further storage types in the future. |
aa039b0f DM |
44 | |
45 | ||
46 | Storage Types | |
47 | ------------- | |
48 | ||
49 | There are basically two different classes of storage types: | |
50 | ||
e21e6f8a TL |
51 | File level storage:: |
52 | ||
cc15d2c5 | 53 | File level based storage technologies allow access to a fully featured (POSIX) |
e21e6f8a TL |
54 | file system. They are in general more flexible than any Block level storage |
55 | (see below), and allow you to store content of any type. ZFS is probably the | |
56 | most advanced system, and it has full support for snapshots and clones. | |
57 | ||
aa039b0f DM |
58 | Block level storage:: |
59 | ||
60 | Allows to store large 'raw' images. It is usually not possible to store | |
61 | other files (ISO, backups, ..) on such storage types. Most modern | |
62 | block level storage implementations support snapshots and clones. | |
e4fefc2c | 63 | RADOS and GlusterFS are distributed systems, replicating storage |
aa039b0f DM |
64 | data to different nodes. |
65 | ||
aa039b0f DM |
66 | |
67 | .Available storage types | |
b84c51fa | 68 | [width="100%",cols="<2d,1*m,4*d",options="header"] |
aa039b0f DM |
69 | |=========================================================== |
70 | |Description |PVE type |Level |Shared|Snapshots|Stable | |
71 | |ZFS (local) |zfspool |file |no |yes |yes | |
db7f8770 | 72 | |Directory |dir |file |no |no^1^ |yes |
d9bfc251 | 73 | |BTRFS |btrfs |file |no |yes |technology preview |
db7f8770 | 74 | |NFS |nfs |file |yes |no^1^ |yes |
de14ebff | 75 | |CIFS |cifs |file |yes |no^1^ |yes |
67558489 | 76 | |Proxmox Backup |pbs |both |yes |n/a |yes |
db7f8770 | 77 | |GlusterFS |glusterfs |file |yes |no^1^ |yes |
71996a81 | 78 | |CephFS |cephfs |file |yes |yes |yes |
db7f8770 | 79 | |LVM |lvm |block |no^2^ |no |yes |
9801e1c3 | 80 | |LVM-thin |lvmthin |block |no |yes |yes |
aa039b0f DM |
81 | |iSCSI/kernel |iscsi |block |yes |no |yes |
82 | |iSCSI/libiscsi |iscsidirect |block |yes |no |yes | |
83 | |Ceph/RBD |rbd |block |yes |yes |yes | |
aa039b0f | 84 | |ZFS over iSCSI |zfs |block |yes |yes |yes |
93e1d33e | 85 | |=========================================================== |
aa039b0f | 86 | |
db7f8770 DC |
87 | ^1^: On file based storages, snapshots are possible with the 'qcow2' format. |
88 | ||
c1bcd141 AS |
89 | ^2^: It is possible to use LVM on top of an iSCSI or FC-based storage. |
90 | That way you get a `shared` LVM storage. | |
aa039b0f | 91 | |
5eba0743 FG |
92 | |
93 | Thin Provisioning | |
2afe468c | 94 | ~~~~~~~~~~~~~~~~~ |
ebc15cbc | 95 | |
c730e973 | 96 | A number of storages, and the QEMU image format `qcow2`, support 'thin |
8c1189b6 | 97 | provisioning'. With thin provisioning activated, only the blocks that |
2afe468c | 98 | the guest system actually use will be written to the storage. |
ebc15cbc | 99 | |
2afe468c | 100 | Say for instance you create a VM with a 32GB hard disk, and after |
5eba0743 | 101 | installing the guest system OS, the root file system of the VM contains |
2afe468c DM |
102 | 3 GB of data. In that case only 3GB are written to the storage, even |
103 | if the guest VM sees a 32GB hard drive. In this way thin provisioning | |
104 | allows you to create disk images which are larger than the currently | |
105 | available storage blocks. You can create large disk images for your | |
106 | VMs, and when the need arises, add more disks to your storage without | |
5eba0743 | 107 | resizing the VMs' file systems. |
2afe468c | 108 | |
8c1189b6 | 109 | All storage types which have the ``Snapshots'' feature also support thin |
2afe468c | 110 | provisioning. |
ebc15cbc | 111 | |
ba1d96fd | 112 | CAUTION: If a storage runs full, all guests using volumes on that |
38d1cf56 | 113 | storage receive IO errors. This can cause file system inconsistencies |
ba1d96fd DM |
114 | and may corrupt your data. So it is advisable to avoid |
115 | over-provisioning of your storage resources, or carefully observe | |
116 | free space to avoid such conditions. | |
ebc15cbc | 117 | |
5eba0743 | 118 | |
aa039b0f DM |
119 | Storage Configuration |
120 | --------------------- | |
121 | ||
122 | All {pve} related storage configuration is stored within a single text | |
8c1189b6 | 123 | file at `/etc/pve/storage.cfg`. As this file is within `/etc/pve/`, it |
aa039b0f DM |
124 | gets automatically distributed to all cluster nodes. So all nodes |
125 | share the same storage configuration. | |
126 | ||
cc15d2c5 FE |
127 | Sharing storage configuration makes perfect sense for shared storage, |
128 | because the same ``shared'' storage is accessible from all nodes. But it is | |
aa039b0f DM |
129 | also useful for local storage types. In this case such local storage |
130 | is available on all nodes, but it is physically different and can have | |
131 | totally different content. | |
132 | ||
5eba0743 | 133 | |
aa039b0f DM |
134 | Storage Pools |
135 | ~~~~~~~~~~~~~ | |
136 | ||
5eba0743 FG |
137 | Each storage pool has a `<type>`, and is uniquely identified by its |
138 | `<STORAGE_ID>`. A pool configuration looks like this: | |
aa039b0f DM |
139 | |
140 | ---- | |
141 | <type>: <STORAGE_ID> | |
142 | <property> <value> | |
143 | <property> <value> | |
a550860d | 144 | <property> |
aa039b0f DM |
145 | ... |
146 | ---- | |
147 | ||
aa039b0f | 148 | The `<type>: <STORAGE_ID>` line starts the pool definition, which is then |
a550860d TL |
149 | followed by a list of properties. Most properties require a value. Some have |
150 | reasonable defaults, in which case you can omit the value. | |
aa039b0f | 151 | |
9c41b54d DM |
152 | To be more specific, take a look at the default storage configuration |
153 | after installation. It contains one special local storage pool named | |
8c1189b6 | 154 | `local`, which refers to the directory `/var/lib/vz` and is always |
9c41b54d DM |
155 | available. The {pve} installer creates additional storage entries |
156 | depending on the storage type chosen at installation time. | |
157 | ||
8c1189b6 | 158 | .Default storage configuration (`/etc/pve/storage.cfg`) |
9801e1c3 DM |
159 | ---- |
160 | dir: local | |
aa039b0f | 161 | path /var/lib/vz |
9801e1c3 DM |
162 | content iso,vztmpl,backup |
163 | ||
9c41b54d | 164 | # default image store on LVM based installation |
9801e1c3 DM |
165 | lvmthin: local-lvm |
166 | thinpool data | |
167 | vgname pve | |
168 | content rootdir,images | |
9c41b54d DM |
169 | |
170 | # default image store on ZFS based installation | |
171 | zfspool: local-zfs | |
172 | pool rpool/data | |
173 | sparse | |
174 | content images,rootdir | |
9801e1c3 | 175 | ---- |
aa039b0f | 176 | |
5eba0743 | 177 | |
aa039b0f DM |
178 | Common Storage Properties |
179 | ~~~~~~~~~~~~~~~~~~~~~~~~~ | |
180 | ||
871e1fd6 | 181 | A few storage properties are common among different storage types. |
aa039b0f DM |
182 | |
183 | nodes:: | |
184 | ||
185 | List of cluster node names where this storage is | |
186 | usable/accessible. One can use this property to restrict storage | |
187 | access to a limited set of nodes. | |
188 | ||
189 | content:: | |
190 | ||
191 | A storage can support several content types, for example virtual disk | |
192 | images, cdrom iso images, container templates or container root | |
871e1fd6 | 193 | directories. Not all storage types support all content types. One can set |
cc15d2c5 | 194 | this property to select what this storage is used for. |
aa039b0f DM |
195 | |
196 | images::: | |
197 | ||
c730e973 | 198 | QEMU/KVM VM images. |
aa039b0f DM |
199 | |
200 | rootdir::: | |
201 | ||
871e1fd6 | 202 | Allow to store container data. |
aa039b0f DM |
203 | |
204 | vztmpl::: | |
205 | ||
206 | Container templates. | |
207 | ||
208 | backup::: | |
209 | ||
8c1189b6 | 210 | Backup files (`vzdump`). |
aa039b0f DM |
211 | |
212 | iso::: | |
213 | ||
214 | ISO images | |
215 | ||
c2c8eb89 DC |
216 | snippets::: |
217 | ||
218 | Snippet files, for example guest hook scripts | |
219 | ||
aa039b0f DM |
220 | shared:: |
221 | ||
222 | Mark storage as shared. | |
223 | ||
224 | disable:: | |
225 | ||
226 | You can use this flag to disable the storage completely. | |
227 | ||
228 | maxfiles:: | |
229 | ||
3a976366 FE |
230 | Deprecated, please use `prune-backups` instead. Maximum number of backup files |
231 | per VM. Use `0` for unlimited. | |
232 | ||
233 | prune-backups:: | |
234 | ||
235 | Retention options for backups. For details, see | |
236 | xref:vzdump_retention[Backup Retention]. | |
aa039b0f DM |
237 | |
238 | format:: | |
239 | ||
240 | Default image format (`raw|qcow2|vmdk`) | |
241 | ||
0537ebf1 FE |
242 | preallocation:: |
243 | ||
244 | Preallocation mode (`off|metadata|falloc|full`) for `raw` and `qcow2` images on | |
245 | file-based storages. The default is `metadata`, which is treated like `off` for | |
246 | `raw` images. When using network storages in combination with large `qcow2` | |
247 | images, using `off` can help to avoid timeouts. | |
aa039b0f DM |
248 | |
249 | WARNING: It is not advisable to use the same storage pool on different | |
871e1fd6 | 250 | {pve} clusters. Some storage operation need exclusive access to the |
aa039b0f | 251 | storage, so proper locking is required. While this is implemented |
871e1fd6 | 252 | within a cluster, it does not work between different clusters. |
aa039b0f DM |
253 | |
254 | ||
255 | Volumes | |
256 | ------- | |
257 | ||
258 | We use a special notation to address storage data. When you allocate | |
871e1fd6 | 259 | data from a storage pool, it returns such a volume identifier. A volume |
aa039b0f DM |
260 | is identified by the `<STORAGE_ID>`, followed by a storage type |
261 | dependent volume name, separated by colon. A valid `<VOLUME_ID>` looks | |
262 | like: | |
263 | ||
264 | local:230/example-image.raw | |
265 | ||
266 | local:iso/debian-501-amd64-netinst.iso | |
267 | ||
268 | local:vztmpl/debian-5.0-joomla_1.5.9-1_i386.tar.gz | |
269 | ||
270 | iscsi-storage:0.0.2.scsi-14f504e46494c4500494b5042546d2d646744372d31616d61 | |
271 | ||
5eba0743 | 272 | To get the file system path for a `<VOLUME_ID>` use: |
aa039b0f DM |
273 | |
274 | pvesm path <VOLUME_ID> | |
275 | ||
5eba0743 | 276 | |
aa039b0f DM |
277 | Volume Ownership |
278 | ~~~~~~~~~~~~~~~~ | |
279 | ||
8c1189b6 | 280 | There exists an ownership relation for `image` type volumes. Each such |
aa039b0f DM |
281 | volume is owned by a VM or Container. For example volume |
282 | `local:230/example-image.raw` is owned by VM 230. Most storage | |
283 | backends encodes this ownership information into the volume name. | |
284 | ||
871e1fd6 | 285 | When you remove a VM or Container, the system also removes all |
aa039b0f DM |
286 | associated volumes which are owned by that VM or Container. |
287 | ||
288 | ||
289 | Using the Command Line Interface | |
290 | -------------------------------- | |
291 | ||
871e1fd6 FG |
292 | It is recommended to familiarize yourself with the concept behind storage |
293 | pools and volume identifiers, but in real life, you are not forced to do any | |
aa039b0f DM |
294 | of those low level operations on the command line. Normally, |
295 | allocation and removal of volumes is done by the VM and Container | |
296 | management tools. | |
297 | ||
8c1189b6 FG |
298 | Nevertheless, there is a command line tool called `pvesm` (``{pve} |
299 | Storage Manager''), which is able to perform common storage management | |
aa039b0f DM |
300 | tasks. |
301 | ||
302 | ||
303 | Examples | |
304 | ~~~~~~~~ | |
305 | ||
306 | Add storage pools | |
307 | ||
308 | pvesm add <TYPE> <STORAGE_ID> <OPTIONS> | |
309 | pvesm add dir <STORAGE_ID> --path <PATH> | |
310 | pvesm add nfs <STORAGE_ID> --path <PATH> --server <SERVER> --export <EXPORT> | |
311 | pvesm add lvm <STORAGE_ID> --vgname <VGNAME> | |
312 | pvesm add iscsi <STORAGE_ID> --portal <HOST[:PORT]> --target <TARGET> | |
313 | ||
314 | Disable storage pools | |
315 | ||
316 | pvesm set <STORAGE_ID> --disable 1 | |
317 | ||
318 | Enable storage pools | |
319 | ||
320 | pvesm set <STORAGE_ID> --disable 0 | |
321 | ||
322 | Change/set storage options | |
323 | ||
324 | pvesm set <STORAGE_ID> <OPTIONS> | |
325 | pvesm set <STORAGE_ID> --shared 1 | |
326 | pvesm set local --format qcow2 | |
327 | pvesm set <STORAGE_ID> --content iso | |
328 | ||
329 | Remove storage pools. This does not delete any data, and does not | |
330 | disconnect or unmount anything. It just removes the storage | |
331 | configuration. | |
332 | ||
333 | pvesm remove <STORAGE_ID> | |
334 | ||
335 | Allocate volumes | |
336 | ||
337 | pvesm alloc <STORAGE_ID> <VMID> <name> <size> [--format <raw|qcow2>] | |
338 | ||
339 | Allocate a 4G volume in local storage. The name is auto-generated if | |
340 | you pass an empty string as `<name>` | |
341 | ||
342 | pvesm alloc local <VMID> '' 4G | |
343 | ||
5eba0743 | 344 | Free volumes |
aa039b0f DM |
345 | |
346 | pvesm free <VOLUME_ID> | |
347 | ||
348 | WARNING: This really destroys all volume data. | |
349 | ||
350 | List storage status | |
351 | ||
352 | pvesm status | |
353 | ||
354 | List storage contents | |
355 | ||
356 | pvesm list <STORAGE_ID> [--vmid <VMID>] | |
357 | ||
358 | List volumes allocated by VMID | |
359 | ||
360 | pvesm list <STORAGE_ID> --vmid <VMID> | |
361 | ||
362 | List iso images | |
363 | ||
364 | pvesm list <STORAGE_ID> --iso | |
365 | ||
366 | List container templates | |
367 | ||
368 | pvesm list <STORAGE_ID> --vztmpl | |
369 | ||
5eba0743 | 370 | Show file system path for a volume |
aa039b0f DM |
371 | |
372 | pvesm path <VOLUME_ID> | |
373 | ||
13962741 DJ |
374 | Exporting the volume `local:103/vm-103-disk-0.qcow2` to the file `target`. |
375 | This is mostly used internally with `pvesm import`. | |
376 | The stream format qcow2+size is different to the qcow2 format. | |
377 | Consequently, the exported file cannot simply be attached to a VM. | |
378 | This also holds for the other formats. | |
379 | ||
380 | pvesm export local:103/vm-103-disk-0.qcow2 qcow2+size target --with-snapshots 1 | |
381 | ||
deb4673f DM |
382 | ifdef::wiki[] |
383 | ||
384 | See Also | |
385 | -------- | |
386 | ||
f532afb7 | 387 | * link:/wiki/Storage:_Directory[Storage: Directory] |
deb4673f | 388 | |
f532afb7 | 389 | * link:/wiki/Storage:_GlusterFS[Storage: GlusterFS] |
deb4673f | 390 | |
f532afb7 | 391 | * link:/wiki/Storage:_User_Mode_iSCSI[Storage: User Mode iSCSI] |
deb4673f | 392 | |
f532afb7 | 393 | * link:/wiki/Storage:_iSCSI[Storage: iSCSI] |
deb4673f | 394 | |
f532afb7 | 395 | * link:/wiki/Storage:_LVM[Storage: LVM] |
deb4673f | 396 | |
f532afb7 | 397 | * link:/wiki/Storage:_LVM_Thin[Storage: LVM Thin] |
deb4673f | 398 | |
f532afb7 | 399 | * link:/wiki/Storage:_NFS[Storage: NFS] |
deb4673f | 400 | |
de14ebff WL |
401 | * link:/wiki/Storage:_CIFS[Storage: CIFS] |
402 | ||
7b43e874 | 403 | * link:/wiki/Storage:_Proxmox_Backup_Server[Storage: Proxmox Backup Server] |
93e1d33e | 404 | |
f532afb7 | 405 | * link:/wiki/Storage:_RBD[Storage: RBD] |
deb4673f | 406 | |
ef488ba5 | 407 | * link:/wiki/Storage:_CephFS[Storage: CephFS] |
a82d3cc3 | 408 | |
f532afb7 | 409 | * link:/wiki/Storage:_ZFS[Storage: ZFS] |
deb4673f | 410 | |
032e755c | 411 | * link:/wiki/Storage:_ZFS_over_iSCSI[Storage: ZFS over iSCSI] |
deb4673f DM |
412 | |
413 | endif::wiki[] | |
414 | ||
251666be DM |
415 | ifndef::wiki[] |
416 | ||
aa039b0f DM |
417 | // backend documentation |
418 | ||
419 | include::pve-storage-dir.adoc[] | |
420 | ||
421 | include::pve-storage-nfs.adoc[] | |
422 | ||
de14ebff WL |
423 | include::pve-storage-cifs.adoc[] |
424 | ||
93e1d33e TL |
425 | include::pve-storage-pbs.adoc[] |
426 | ||
aa039b0f DM |
427 | include::pve-storage-glusterfs.adoc[] |
428 | ||
429 | include::pve-storage-zfspool.adoc[] | |
430 | ||
431 | include::pve-storage-lvm.adoc[] | |
432 | ||
9801e1c3 DM |
433 | include::pve-storage-lvmthin.adoc[] |
434 | ||
aa039b0f DM |
435 | include::pve-storage-iscsi.adoc[] |
436 | ||
437 | include::pve-storage-iscsidirect.adoc[] | |
438 | ||
439 | include::pve-storage-rbd.adoc[] | |
440 | ||
669bce8b AA |
441 | include::pve-storage-cephfs.adoc[] |
442 | ||
ea856d57 | 443 | include::pve-storage-btrfs.adoc[] |
aa039b0f | 444 | |
93f65836 SI |
445 | include::pve-storage-zfs.adoc[] |
446 | ||
251666be | 447 | |
aa039b0f DM |
448 | ifdef::manvolnum[] |
449 | include::pve-copyright.adoc[] | |
450 | endif::manvolnum[] | |
451 | ||
251666be DM |
452 | endif::wiki[] |
453 |