From 761a73e77169490069e5dab699584457442a76eb Mon Sep 17 00:00:00 2001
From: Travis Glenn Hansen <travisghansen@yahoo.com>
Date: Thu, 3 Mar 2022 11:54:20 -0700
Subject: [PATCH] better logging/documentation around breaking change
 introduced

Signed-off-by: Travis Glenn Hansen <travisghansen@yahoo.com>
---
 CHANGELOG.md              | 15 ++++++++++++---
 examples/freenas-nfs.yaml |  4 ++--
 package.json              |  2 +-
 src/driver/freenas/ssh.js |  4 ++--
 4 files changed, 17 insertions(+), 8 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 8aa873e..c2c939e 100644
--- a/CHANGELOG.md
+++ b/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
diff --git a/examples/freenas-nfs.yaml b/examples/freenas-nfs.yaml
index 3ebe09f..352c85c 100644
--- a/examples/freenas-nfs.yaml
+++ b/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"
diff --git a/package.json b/package.json
index 5699491..6829e15 100644
--- a/package.json
+++ b/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": {
diff --git a/src/driver/freenas/ssh.js b/src/driver/freenas/ssh.js
index ce66d86..b15fa2a 100644
--- a/src/driver/freenas/ssh.js
+++ b/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);