Skip to main content

From 0 to ZFS replication in 5m with syncoid

The ZFS filesystem has many features that once you try them you can never go back. One of the lesser known is probably the support for replicating a zfs filesystem by sending the changes over the network with zfs send/receive.
Technically the filesystem changes don't even need to be sent over a network: you could as well dump them on a removable disk, then receive  from the same removable disk.

I suppose the reason send/receive is not so instantly popular among Linux users starting with ZFS is because they had access to rsync for such a long time and it works so well that they just don't feel the need for another replication tool.

TIP: when rsync'ing to ZFS use --in-place to improve performance

The way ZFS send/receive works is by selecting just the changed blocks between two snapshot. It does not have to walk the filesystem tree and compute, exchange and compare hashes, sizes, timestamps and so on like rsync does which means it is extremely efficient. Also, excluding compression, it is more bandwidth efficient than rsync because the involved parties do not have to exchange file lists.

While you could script zfs send/receive manually, the fastest way to replicate one pool or filesystem to another is by using one of the many tools building upon it. Probably the best tool for this job is syncoid (which is a part of sanoid).

Caveat: syncoid requires that target filesystem does not exist: it will complain and refuse to work if it does. It is best to start with an empty target or replicate one filesystem at the time.

While not necessary it is a good idea to install the following extra packages to run syncoid at its full potential: mbuffer, lzop, pv, git. Ubuntu provides binaries for all of them, other distributions might not.

To use syncoid first clone the sanoid github repository:

git clone

then cd into sanoid or copy syncoid to a directory in your path. Also I have found that syncoid attempts to use an SSH cypher that might not always be available. If that happens edit line 28 and leave the sshcipher option empty (there are probably ciphers more efficient than others for this purpose, but I'm not an expert. If you knwo of them let me know in the comments).

After that set up ssh for key-based autentication and then go ahead and try your first replication:

syncoid --recursive tank root@remotehost:tank

try adding --debug if you want to look under the hood.

Syncoid uses mbuffer to read large chunks of data into a memory buffer, compress it with lzop and transfer it over the network with ssh. The same happens on the receiving side, only in reversed order.

To replicate again re-run syncoid with the same options.


Blogger said…
Bluehost is the best hosting provider for any hosting services you need.

Popular posts from this blog

Indexing Apache access logs with ELK (Elasticsearch+Logstash+Kibana)

Who said that grepping Apache logs has to be boring?

The truth is that, as Enteprise applications move to the browser too, Apache access logs are a gold mine, it does not matter what your role is: developer, support or sysadmin. If you are not mining them you are most likely missing out a ton of information and, probably, making the wrong decisions.
ELK (Elasticsearch, Logstash, Kibana) is a terrific, Open Source stack for visually analyzing Apache (or nginx) logs (but also any other timestamped data).

A not so short guide to ZFS on Linux

Updated Oct 16 2013: shadow copies, memory settings and links for further learning.
Updated Nov 15 2013: shadow copies example, samba tuning.

Unless you've been living under a rock you should have by now heard many stories about how awesome ZFS is and the many ways it can help with saving your bacon.

The downside is that ZFS is not available (natively) for Linux because the CDDL license under which it is released is incompatible with the GPL. Assuming you are not interested in converting to one of the many Illumos distributions or FreeBSD this guide might serve you as a starting point if you are attracted  by ZFS features but are reluctant to try it out on production systems.

Basically in this post I note down both the tought process and the actual commands for implementing a fileserver for a small office. The fileserver will run as a virtual machine in a large ESXi host and use ZFS as the filesystem for shared data.