Merge pull request #160 from democratic-csi/next

better logging/documentation around breaking change introduced

CHANGELOG.md

@@ -1,10 +1,19 @@
+# v1.5.4
+
+Released 2022-03-03
+
+- more descriptive error message for breaking changes introduced in `v1.5.3`
+
 # v1.5.3
 
 Released 2022-03-02
 
-- support for running `freenas-iscsi` and `freenas-nfs` sudo-less (see #151)
-- more robust chown / chmod logic for all zfs drivers
-- all for setting extent comment/description in `freenas-iscsi` and
+- support for running `freenas-iscsi` and `freenas-nfs` `sudo`-less (see #151)
+  - BREAKING CHANGE for `freenas-nfs`, if set `datasetPermissionsUser` and
+    `datasetPermissionsGroup` must be numeric user/group IDs, alpha values such
+    as `root` and `wheel` will no longer work
+- more robust `chown` / `chmod` logic for all zfs drivers
+- allow for setting extent comment/description in `freenas-iscsi` and
   `freenas-api-iscsi` (see #158)
 
 # v1.5.2

examples/freenas-nfs.yaml

@@ -51,8 +51,8 @@ zfs:
   datasetEnableQuotas: true
   datasetEnableReservation: false
   datasetPermissionsMode: "0777"
-  datasetPermissionsUser: root
-  datasetPermissionsGroup: wheel
+  datasetPermissionsUser: 0
+  datasetPermissionsGroup: 0
   #datasetPermissionsAcls:
   #- "-m everyone@:full_set:allow"
   #- "-m u:kube:full_set:allow"

package.json

@@ -1,6 +1,6 @@
 {
   "name": "democratic-csi",
-  "version": "1.5.3",
+  "version": "1.5.4",
   "description": "kubernetes csi driver framework",
   "main": "bin/democratic-csi",
   "scripts": {

src/driver/freenas/ssh.js

@@ -1757,7 +1757,7 @@ class FreeNASSshDriver extends ControllerZfsBaseDriver {
           if (String(user).match(/^[0-9]+$/) == null) {
             throw new GrpcError(
               grpc.status.FAILED_PRECONDITION,
-              `datasetPermissionsUser must be numeric: ${user}`
+              `BREAKING CHANGE since v1.5.3! datasetPermissionsUser must be numeric: ${user} is invalid`
             );
           }
           perms.uid = Number(user);
@@ -1768,7 +1768,7 @@ class FreeNASSshDriver extends ControllerZfsBaseDriver {
           if (String(group).match(/^[0-9]+$/) == null) {
             throw new GrpcError(
               grpc.status.FAILED_PRECONDITION,
-              `datasetPermissionsGroup must be numeric: ${group}`
+              `BREAKING CHANGE since v1.5.3! datasetPermissionsGroup must be numeric: ${group} is invalid`
             );
           }
           perms.gid = Number(group);