Skip to content

Commit 03d4da5

Browse files
committed
Update SR docs
- Add a warning for local SRs: devices or partitions get formatted. - ZFS SR: remove extraneous tip (mentioned twice) and refer users to docs after giving them optimization tips. Signed-off-by: Samuel Verschelde <[email protected]>
1 parent f3f4b2d commit 03d4da5

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

docs/storage.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,14 @@ Cost of thick provisioning is relatively high when you do snapshots (used for ba
129129
A local SR is using a disk or a partition of your local disk, to create a space for your VM disks. Local LVM will use logical volumes, whereas Local EXT will create an `ext4` filesystem and put `.vhd` files in it.
130130

131131
:::tip
132-
The concept is simple: tell XCP-ng which disk or partition you want to use, and it will do everything for you! Don't do anything yourself (no need to create a logical volume or a filesystem)
132+
The concept is simple: tell XCP-ng which disk or partition you want to use, and it will do everything for you! Don't do anything yourself (no need to create a logical volume or a filesystem).
133+
:::
134+
135+
:::warning
136+
As XCP-ng will handle everything for you, be aware that the device or partition will be formatted.
137+
138+
* Don't create a SR over a device or partition that contains important data.
139+
* If you want to attach an existing SR to your pool, don't create a new local SR over it, else your virtual disks will be deleted. Instead, use the `xe sr-attach` command.
133140
:::
134141

135142
In [Xen Orchestra](management.md#xen-orchestra):
@@ -198,8 +205,6 @@ Now you can create the SR on top of it:
198205
xe sr-create host-uuid=<HOST_UUID> type=zfs content-type=user name-label=LocalZFS device-config:location=/mnt/zfs/
199206
```
200207

201-
For better performance, you can disable sync with `zfs set sync=disabled tank`.
202-
203208
:::tip
204209
Please report any problems (performance or otherwise) you might encounter with ZFS. [Our forum](https://xcp-ng.org/forum) is here for that!
205210
:::
@@ -253,6 +258,8 @@ There are many options to increase the performance of ZFS SRs:
253258
* Turn on compression (it's cheap but effective): `zfs set compress=lz4 tank/zfssr`
254259
* Disable accesstime log: `zfs set atime=off tank/zfssr`
255260

261+
Check ZFS documentation to understand the pros and cons of each optimization.
262+
256263
### XFS
257264

258265
Local, thin-provisioned storage.

0 commit comments

Comments
 (0)