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 <waqarahmedjoyia@live.com>
This commit is contained in:
Waqar Ahmed 2020-07-30 19:41:15 +05:00 committed by GitHub
parent cd4a0de932
commit 8d3705b08b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -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 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. 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 currently supported fs types are ext2/3/4, xfs and zfs only. The *poolname* is the must argument. It should be noted that *poolname*
Also there must be a ZPOOL running on *all the nodes* with the name given in the storage class. 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 ##### ext2/3/4 or xfs or btrfs as FsType