|
|
@ -2,7 +2,7 @@
|
|
|
|
Python-SimpleZFS
|
|
|
|
Python-SimpleZFS
|
|
|
|
################
|
|
|
|
################
|
|
|
|
|
|
|
|
|
|
|
|
A thin wrapper around ZFS from the `ZFS on Linux <https://zfsonlinux.org/>`_ project.
|
|
|
|
A thin wrapper around ZFS from the OpenZFS_ project.
|
|
|
|
|
|
|
|
|
|
|
|
The library aims at providing a simple, low-level interface for working with ZFS, either by wrapping the ``zfs(8)`` and
|
|
|
|
The library aims at providing a simple, low-level interface for working with ZFS, either by wrapping the ``zfs(8)`` and
|
|
|
|
``zpool(8)`` CLI utilities or by accessing the native python API.
|
|
|
|
``zpool(8)`` CLI utilities or by accessing the native python API.
|
|
|
@ -14,7 +14,7 @@ Two interface classes make up the API, ``ZFS`` and ``ZPool``, which are wrappers
|
|
|
|
tools of the same name. They come with two implementations:
|
|
|
|
tools of the same name. They come with two implementations:
|
|
|
|
|
|
|
|
|
|
|
|
* The CLI implementation wraps the executables
|
|
|
|
* The CLI implementation wraps the executables
|
|
|
|
* The Native implementation uses the native API released with ZoL 0.8.
|
|
|
|
* The Native implementation uses the native API released with OpenZFS 0.8.
|
|
|
|
|
|
|
|
|
|
|
|
In this early stage, the native implementation has not been written.
|
|
|
|
In this early stage, the native implementation has not been written.
|
|
|
|
|
|
|
|
|
|
|
@ -100,9 +100,9 @@ Compatibility
|
|
|
|
The library is written with `Python` 3.6 or higher in mind, which was in a stable release in a few of the major Linux
|
|
|
|
The library is written with `Python` 3.6 or higher in mind, which was in a stable release in a few of the major Linux
|
|
|
|
distributions we care about (Debian Buster, Ubuntu 18.04 LTS, RHEL 8, Gentoo).
|
|
|
|
distributions we care about (Debian Buster, Ubuntu 18.04 LTS, RHEL 8, Gentoo).
|
|
|
|
|
|
|
|
|
|
|
|
On the ZoL_ side, the code is developed mostly on version ``0.8``, and takes some validation values from that release.
|
|
|
|
On the OpenZFS_ side, the code is developed on version ``0.8`` and newer, and takes some validation values from that
|
|
|
|
The library doesn't make a lot of assumptions, the code should work on ``0.7``, too. If you spot an incompatibility,
|
|
|
|
release. The library doesn't make a lot of assumptions, the code should work on ``0.7``, too. If you spot an
|
|
|
|
please let us know via the issue tracker.
|
|
|
|
incompatibility, please let us know via the issue tracker.
|
|
|
|
|
|
|
|
|
|
|
|
Testing
|
|
|
|
Testing
|
|
|
|
*******
|
|
|
|
*******
|
|
|
@ -116,4 +116,4 @@ It is planned to add a separate set of `destructive` tests that need to be speci
|
|
|
|
works when run against an actual Linux system. This can't be done using most of the CI providers, as the nature of ZFS
|
|
|
|
works when run against an actual Linux system. This can't be done using most of the CI providers, as the nature of ZFS
|
|
|
|
requires having a operating system with loaded modules that may be destroyed during the test run.
|
|
|
|
requires having a operating system with loaded modules that may be destroyed during the test run.
|
|
|
|
|
|
|
|
|
|
|
|
.. _ZoL: https://zfsonlinux.org/
|
|
|
|
.. _OpenZFS: https://openzfs.org/
|
|
|
|