Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/chong601/pyzfs-rest-api

REST API for ZFS zpool and zfs command line tool
https://github.com/chong601/pyzfs-rest-api

flask python3 torture zfs

Last synced: 2 months ago
JSON representation

REST API for ZFS zpool and zfs command line tool

Awesome Lists containing this project

README 

        
# pyzfs-rest-api

REST API for ZFS zpool and ZFS, because ZFS is *awesome*. It just needs more pizzaz and automation love.



pyzfs-rest-api is based on [OpenZFS `libzfs_core`](https://github.com/openzfs/zfs/tree/master/contrib/pyzfs) implementation with custom implementation for unimplemented calls.



# Goals

pyzfs-rest-api is intended to be (almost) feature-parity with upstream OpenZFS, as long the implementation is clear enough.



API implementation will be considered stable if the interface is at least compatible with all currently supported versions of ZFS (subject to change)



ABI support between pyzfs-rest-api and libzfs_core will depend on how complicated pyzfs is (might need to learn cffi *shudders*)



# `libzfs_core` status (through `pylibzfs_core`)

| Function name | Status | Notes |

| - | - | - |

lzc_create | Works | Requires root |

lzc_clone | Works | Requires root |

lzc_promote | Works | May work without root |

lzc_rename | Works | Requires root |

lzc_destroy | Works | Requires root |

lzc_snapshot | Works | Requires root |

lzc_destroy_snap | Unknown | |

lzc_snaprange_space | Unknown | |

lzc_exists | Works | Not exposed on zpool/zfs |

lzc_sync | Works | Can be executed by non-root users |

lzc_hold | Done | Code exists, not tested |

lzc_release | Done | Code exists, not tested |

lzc_get_holds | Done | Code exists, not tested |

lzc_send | Unknown | |

lzc_send_redacted | Unknown | |

lzc_send_resume | Unknown | |

lzc_send_resume_redacted | Unknown | |

lzc_send_space_resume_redacted | Unknown | |

lzc_send_space | Unknown | |

lzc_receive | Unknown | |

lzc_receive_resumable | Unknown | |

lzc_receive_with_header | Unknown | |

lzc_receive_one | Unknown | |

lzc_receive_with_cmdprops | Unknown | |

lzc_rollback | Works | Requires root |

lzc_rollback_to | Works | Requires root |

lzc_bookmark | Unknown | |

lzc_get_bookmarks | Unknown | |

lzc_get_bookmark_props | Unknown | |

lzc_destroy_bookmarks | Unknown | |

lzc_channel_program_impl | Unknown | |

lzc_channel_program | Unknown | |

lzc_pool_checkpoint | Unknown | |

lzc_pool_checkpoint_discard | Unknown | |

lzc_channel_program_nosync | Unknown | |

lzc_load_key | Unknown | |

lzc_unload_key | Unknown | |

lzc_change_key | Unknown | |

lzc_reopen | Unknown | |

lzc_initialize | Unknown | |

lzc_trim | NOT AVAILABLE | Missing from libzfs_core. Requires port-in to libzfs_core |

lzc_redact | Unknown | |

lzc_wait | Unknown | |

lzc_wait_tag | Unknown | |

lzc_wait_fs | Unknown | |

lzc_set_bootenv | Unknown | |

lzc_get_bootenv | Unknown | |



# `pyzfs` implementation

| Function name | Status | Notes |

| - | - | - |

| zfs_list | Pending | Lack of sleep sucks |

| zpool_list | Partially done | Needs more testing on properties |

| zfs_trim | Done | Alternative implementation to lzc_trim which is missing in `libzfs_core` |



# Why the split between libzfs_core and pyzfs?

Simple.



libzfs_core only implements subset of ZFS functions that is offered by ZFS (for now).

The idea of libzfs_core is to provide a stable API for any applications that want to interact with

core ZFS features.



Sadly the libzfs_core development is slow, which makes extending ZFS much more difficult.



Anything that `libzfs_core` does not cover will be implemented on `pyzfs` until C function replacements is available.

# Plans

TBD.



# License

I'm currently undecided on how to license this code. Do provide a recommended license if you're expert in this field!

pyzfs is ©️ ClusterHQ 2015 and ©️ OpenZFS 2018-current and is licensed under Apache License 2.0