From d1abfc89b9ff91c4e8994a795ea526b6a7990655 Mon Sep 17 00:00:00 2001 From: Nick Woolmer <29717167+nwoolmer@users.noreply.github.com> Date: Thu, 11 Jul 2024 12:57:08 +0100 Subject: [PATCH 1/3] Add note on compression choices for ZFS --- guides/compression-zfs.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/guides/compression-zfs.md b/guides/compression-zfs.md index 3af0b80a..f9035140 100644 --- a/guides/compression-zfs.md +++ b/guides/compression-zfs.md @@ -26,3 +26,19 @@ The exact commands depend on which version of ZFS you are running. Use the to customize your ZFS to meet your requirements. Once created, ZFS provides system-level compression. + +## Compression choices + +ZFS offers a number of compression choices when constructing the volume. + +*lz4* offers a good balance of compression ratio versus increased CPU usage, and slowed performance. For general usage, we would recommend using *lz4*. + +*zstd* is another strong option. This will provide higher compression ratios, but take longer to decompress. We would recommend this when storage size is an absolute priority, or for embedded-style deployments (i.e Raspberry PI, home IoT setups). + +As always, it is best to benchmark your choice to ensure that the performance matches your use case. + +:::note + +We run CI tests using *ZFS* with *lz4* compression. If you encounter issues with other compression algorithms, please let us know. + +::: From 4b961eebd20c83bc805267d4192f1eac26a6a6da Mon Sep 17 00:00:00 2001 From: Nick Woolmer <29717167+nwoolmer@users.noreply.github.com> Date: Thu, 11 Jul 2024 13:04:42 +0100 Subject: [PATCH 2/3] Apply suggestions from code review Thanks Andrei! Co-authored-by: Andrei Pechkurov <37772591+puzpuzpuz@users.noreply.github.com> --- guides/compression-zfs.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/guides/compression-zfs.md b/guides/compression-zfs.md index f9035140..62b4d542 100644 --- a/guides/compression-zfs.md +++ b/guides/compression-zfs.md @@ -31,14 +31,14 @@ Once created, ZFS provides system-level compression. ZFS offers a number of compression choices when constructing the volume. -*lz4* offers a good balance of compression ratio versus increased CPU usage, and slowed performance. For general usage, we would recommend using *lz4*. +[LZ4](https://github.com/lz4/lz4) offers a good balance of compression ratio versus increased CPU usage, and slowed performance. For general usage, we recommend using LZ4. -*zstd* is another strong option. This will provide higher compression ratios, but take longer to decompress. We would recommend this when storage size is an absolute priority, or for embedded-style deployments (i.e Raspberry PI, home IoT setups). +[zstd](https://github.com/facebook/zstd) is another strong option. This will provide higher compression ratios, but take longer to decompress. We recommend this when storage size is an absolute priority, or for embedded-style deployments (i.e. Raspberry Pi, home IoT setups). As always, it is best to benchmark your choice to ensure that the performance matches your use case. :::note -We run CI tests using *ZFS* with *lz4* compression. If you encounter issues with other compression algorithms, please let us know. +We regularly run tests using *ZFS* with *LZ4* compression. If you encounter issues with other compression algorithms, please let us know. ::: From 7b6b6c2abdf11e3f46289f5b44f3b6d70b03bd0c Mon Sep 17 00:00:00 2001 From: goodroot <9484709+goodroot@users.noreply.github.com> Date: Thu, 11 Jul 2024 07:51:37 -0700 Subject: [PATCH 3/3] Update guides/compression-zfs.md --- guides/compression-zfs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guides/compression-zfs.md b/guides/compression-zfs.md index 62b4d542..5633ae82 100644 --- a/guides/compression-zfs.md +++ b/guides/compression-zfs.md @@ -27,7 +27,7 @@ to customize your ZFS to meet your requirements. Once created, ZFS provides system-level compression. -## Compression choices +## Compression choices, LZ4 and zstd ZFS offers a number of compression choices when constructing the volume.