]>
Commit | Line | Data |
---|---|---|
8119f671 | 1 | [[storage_directory]] |
aa039b0f DM |
2 | Directory Backend |
3 | ----------------- | |
5f09af76 DM |
4 | ifdef::wiki[] |
5 | :pve-toplevel: | |
cb84ed18 | 6 | :title: Storage: Directory |
5f09af76 DM |
7 | endif::wiki[] |
8 | ||
aa039b0f DM |
9 | Storage pool type: `dir` |
10 | ||
11 | {pve} can use local directories or locally mounted shares for | |
12 | storage. A directory is a file level storage, so you can store any | |
13 | content type like virtual disk images, containers, templates, ISO images | |
14 | or backup files. | |
15 | ||
8c1189b6 | 16 | NOTE: You can mount additional storages via standard linux `/etc/fstab`, |
aa039b0f DM |
17 | and then define a directory storage for that mount point. This way you |
18 | can use any file system supported by Linux. | |
19 | ||
20 | This backend assumes that the underlying directory is POSIX | |
21 | compatible, but nothing else. This implies that you cannot create | |
871e1fd6 | 22 | snapshots at the storage level. But there exists a workaround for VM |
aa039b0f DM |
23 | images using the `qcow2` file format, because that format supports |
24 | snapshots internally. | |
25 | ||
871e1fd6 | 26 | TIP: Some storage types do not support `O_DIRECT`, so you can't use |
aa039b0f DM |
27 | cache mode `none` with such storages. Simply use cache mode |
28 | `writeback` instead. | |
29 | ||
30 | We use a predefined directory layout to store different content types | |
871e1fd6 | 31 | into different sub-directories. This layout is used by all file level |
aa039b0f DM |
32 | storage backends. |
33 | ||
34 | .Directory layout | |
35 | [width="100%",cols="d,m",options="header"] | |
36 | |=========================================================== | |
37 | |Content type |Subdir | |
8c1189b6 FG |
38 | |VM images |`images/<VMID>/` |
39 | |ISO images |`template/iso/` | |
40 | |Container templates |`template/cache/` | |
41 | |Backup files |`dump/` | |
c2c8eb89 | 42 | |Snippets |`snippets/` |
aa039b0f DM |
43 | |=========================================================== |
44 | ||
5eba0743 | 45 | |
aa039b0f DM |
46 | Configuration |
47 | ~~~~~~~~~~~~~ | |
48 | ||
49 | This backend supports all common storage properties, and adds an | |
50 | additional property called `path` to specify the directory. This | |
51 | needs to be an absolute file system path. | |
52 | ||
8c1189b6 | 53 | .Configuration Example (`/etc/pve/storage.cfg`) |
aa039b0f DM |
54 | ---- |
55 | dir: backup | |
56 | path /mnt/backup | |
57 | content backup | |
5c85b0a1 | 58 | prune-backups keep-last=7 |
2db55d5d | 59 | max-protected-backups 3 |
aa039b0f DM |
60 | ---- |
61 | ||
5c85b0a1 | 62 | The above configuration defines a storage pool called `backup`. That pool can be |
2db55d5d FE |
63 | used to store up to 7 regular backups (`keep-last=7`) and 3 protected backups |
64 | per VM. The real path for the backup files is `/mnt/backup/dump/...`. | |
aa039b0f DM |
65 | |
66 | ||
67 | File naming conventions | |
68 | ~~~~~~~~~~~~~~~~~~~~~~~ | |
69 | ||
70 | This backend uses a well defined naming scheme for VM images: | |
71 | ||
72 | vm-<VMID>-<NAME>.<FORMAT> | |
73 | ||
74 | `<VMID>`:: | |
75 | ||
76 | This specifies the owner VM. | |
77 | ||
78 | `<NAME>`:: | |
79 | ||
8c1189b6 | 80 | This can be an arbitrary name (`ascii`) without white space. The |
871e1fd6 | 81 | backend uses `disk-[N]` as default, where `[N]` is replaced by an |
aa039b0f DM |
82 | integer to make the name unique. |
83 | ||
84 | `<FORMAT>`:: | |
85 | ||
8c1189b6 | 86 | Specifies the image format (`raw|qcow2|vmdk`). |
aa039b0f DM |
87 | |
88 | When you create a VM template, all VM images are renamed to indicate | |
5eba0743 | 89 | that they are now read-only, and can be used as a base image for clones: |
aa039b0f DM |
90 | |
91 | base-<VMID>-<NAME>.<FORMAT> | |
92 | ||
93 | NOTE: Such base images are used to generate cloned images. So it is | |
871e1fd6 FG |
94 | important that those files are read-only, and never get modified. The |
95 | backend changes the access mode to `0444`, and sets the immutable flag | |
aa039b0f DM |
96 | (`chattr +i`) if the storage supports that. |
97 | ||
5eba0743 | 98 | |
aa039b0f DM |
99 | Storage Features |
100 | ~~~~~~~~~~~~~~~~ | |
101 | ||
871e1fd6 | 102 | As mentioned above, most file systems do not support snapshots out |
aa039b0f DM |
103 | of the box. To workaround that problem, this backend is able to use |
104 | `qcow2` internal snapshot capabilities. | |
105 | ||
106 | Same applies to clones. The backend uses the `qcow2` base image | |
107 | feature to create clones. | |
108 | ||
109 | .Storage features for backend `dir` | |
110 | [width="100%",cols="m,m,3*d",options="header"] | |
111 | |============================================================================== | |
c2c8eb89 DC |
112 | |Content types |Image formats |Shared |Snapshots |Clones |
113 | |images rootdir vztmpl iso backup snippets |raw qcow2 vmdk subvol |no |qcow2 |qcow2 | |
aa039b0f DM |
114 | |============================================================================== |
115 | ||
116 | ||
117 | Examples | |
118 | ~~~~~~~~ | |
119 | ||
120 | Please use the following command to allocate a 4GB image on storage `local`: | |
121 | ||
122 | # pvesm alloc local 100 vm-100-disk10.raw 4G | |
123 | Formatting '/var/lib/vz/images/100/vm-100-disk10.raw', fmt=raw size=4294967296 | |
7c384c31 | 124 | successfully created 'local:100/vm-100-disk10.raw' |
aa039b0f DM |
125 | |
126 | NOTE: The image name must conform to above naming conventions. | |
127 | ||
128 | The real file system path is shown with: | |
129 | ||
130 | # pvesm path local:100/vm-100-disk10.raw | |
131 | /var/lib/vz/images/100/vm-100-disk10.raw | |
132 | ||
133 | And you can remove the image with: | |
134 | ||
135 | # pvesm free local:100/vm-100-disk10.raw | |
136 | ||
deb4673f DM |
137 | |
138 | ifdef::wiki[] | |
139 | ||
140 | See Also | |
141 | ~~~~~~~~ | |
142 | ||
f532afb7 | 143 | * link:/wiki/Storage[Storage] |
deb4673f DM |
144 | |
145 | endif::wiki[] | |
146 | ||
147 |