Skip to content

mistifyio/gozfs

Repository files navigation

Pure Go Client for ZFS Stable API

GoDoc status=alpha MIT Licensed

Requirements

You need a working ZFS setup with a few patches, in the following order.

  1. stable api openzfs/zfs#3907
  2. patch on top of stable api https://github.com/ClusterHQ/zfs/pull/13.patch

Generally you need root privileges to use anything zfs related.

Status

status=alpha

We have implemented most of the features we need. If any features are wanted please open an issue or (better yet) pull request. The beta TODO list is more or less:

  • stabilize zfs_receive
  • avoid zfs_cmd_t in its current form
  • implement usable public api akin to go-zfs
  • find a better name

Contributing

See the contributing guidelines

cgo

All the nv list handling is fully implemented in go. The only use of cgo is a wrapper that actually calls ioctl with the zfs_cmd_t, this may be changed in the future.