zfs_delegate_admin: fix: zfs allow cannot parse unknown uid/gid

[papamoose]

When setting allow permissions for particular users or groups there will be circumstances when that user is not known to the host system.

In that case the output of zfs allow <pool/dataset> looks similar to this:

$ sudo zfs allow tank/test
---- Permissions on tank/test ---------------------------------------
Local+Descendent permissions:
user (unknown: 1002) hold
user zfsuser receive

The fix in this commit removes (unknown:+) from the output leaving only the uid/gid.

This allows the current parser to continue even if the uid/gid is not known.

This situation occurs most often when moving a zpool from one system to another that may not have the same users/groups. Simply adding permissions to a user/group and then deleting the user/group from the system will cause this situation to occur.

SUMMARY

Fixes #5941

Removing (unknown: + ) from line allows the user to remove and permissions to uids or gids even if the host system is unaware of an actual user/group by that name.

Ideally, openzfs could modify the zfs allow command to allow for machine readable output like most of the zfs commands available: e.g. -H -o name,permissions,entity.

ISSUE TYPE

• Bugfix Pull Request

COMPONENT NAME

community.general.zfs_delegate_admin

ADDITIONAL INFORMATION

Testing

  tasks:

  - name: remove all perms
    community.general.zfs_delegate_admin:
      name: tank/test
      users: "zfsuser,1002"
      groups: 2000
      permissions: send,hold
      recursive: yes
      state: absent

  - ansible.builtin.command:
      cmd: zfs allow tank/test
    register: o1

  - debug:
      msg: "{{ o1.stdout.split('\n') }}"

  - name: add perm
    community.general.zfs_delegate_admin:
      name: tank/test
      users: "zfsuser,1002"
      groups: 2000
      permissions: send
      recursive: yes
      state: present

  - ansible.builtin.command:
      cmd: zfs allow tank/test
    register: o2

  - debug:
      msg: "{{ o2.stdout.split('\n') }}"

  - name: remove perm
    community.general.zfs_delegate_admin:
      name: tank/test
      users: "zfsuser,1002"
      groups: 2000
      permissions: send
      recursive: yes
      state: absent

  - ansible.builtin.command:
      cmd: zfs allow tank/test
    register: o3

  - debug:
      msg: "{{ o3.stdout.split('\n') }}"

$ ansible-playbook a.yml -l machine-a

PLAY [all] *************************************************************************************************

TASK [Gathering Facts] *************************************************************************************
ok: [machine-a]

TASK [remove all perms] ************************************************************************************
changed: [machine-a]

TASK [ansible.builtin.command] *****************************************************************************
changed: [machine-a]

TASK [debug] ***********************************************************************************************
ok: [machine-a] => {
    "msg": [
        ""
    ]
}

TASK [add perm] ********************************************************************************************
changed: [machine-a]

TASK [ansible.builtin.command] *****************************************************************************
changed: [machine-a]

TASK [debug] ***********************************************************************************************
ok: [machine-a] => {
    "msg": [
        "---- Permissions on tank/test ----------------------------------------",
        "Local+Descendent permissions:",
        "\tuser (unknown: 1002) send",
        "\tuser zfsuser send",
        "\tgroup (unknown: 2000) send"
    ]
}

TASK [remove perm] *****************************************************************************************
changed: [machine-a]

TASK [ansible.builtin.command] *****************************************************************************
changed: [machine-a]

TASK [debug] ***********************************************************************************************
ok: [machine-a] => {
    "msg": [
        ""
    ]
}

PLAY RECAP *************************************************************************************************
machine-a                      : ok=10   changed=6    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   

[ansibullbot]

cc @bcoca @fishman @jasperla @jpdasma @mator @natefoo @scathatheworm @troy2914 @xen0l
click here for bot help

[felixfontein]

Thanks for your contribution. Could you please add a changelog fragment and adjust the spacing after commas? Thanks.

[felixfontein]

If nobody objects, I'll merge this by this weekend for the next release.

[patchback]

Backport to stable-5: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-5/53f729730bcc95c75354b11d6ad5f999f883fe9d/pr-5943

Backported as #6085

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

[patchback]

Backport to stable-6: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-6/53f729730bcc95c75354b11d6ad5f999f883fe9d/pr-5943

Backported as #6086

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

[felixfontein]

@papamoose thank you very much for your contribution!

[github-actions]

Docs Build 📝

Thank you for contribution!✨

This PR has been merged and your docs changes will be incorporated when they are next published.