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