From 8d3705b08b077e7568b60099cbaf1299955ef693 Mon Sep 17 00:00:00 2001 From: Waqar Ahmed Date: Thu, 30 Jul 2020 19:41:15 +0500 Subject: [PATCH] chore(doc): Update Readme to specify usage of child dataset for poolname (#190) As discussed in https://github.com/openebs/zfs-localpv/issues/189, it is possible to use a child dataset instead of the root dataset and this change reflects the usage in readme for users. Signed-off-by: Waqar Ahmed --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 89fd520..ce0d706 100644 --- a/README.md +++ b/README.md @@ -135,8 +135,14 @@ provisioner: zfs.csi.openebs.io The storage class contains the volume parameters like recordsize, compression, dedup and fstype. You can select what are all parameters you want. In case, zfs properties paramenters are not provided, the volume will inherit the properties from the ZFS Pool. -Also currently supported fs types are ext2/3/4, xfs and zfs only. The *poolname* is the must argument. -Also there must be a ZPOOL running on *all the nodes* with the name given in the storage class. +Also currently supported fs types are ext2/3/4, xfs and zfs only. The *poolname* is the must argument. It should be noted that *poolname* +can either be the root dataset or a child dataset e.g. +``` +poolname: "zfspv-pool" +poolname: "zfspv-pool/child" +``` + +Also the dataset provided under `poolname` must exist on *all the nodes* with the name given in the storage class. ##### ext2/3/4 or xfs or btrfs as FsType