anybox / buttervolume

BTRFS Volume plugin for Docker
Apache License 2.0
81 stars 11 forks source link

Relationship to the built-in BTRFS storage driver? #48

Closed NKnusperer closed 8 months ago

NKnusperer commented 8 months ago

Hello, what is the relationship between buttervolume and the built-in BTRFS storage driver ? I'm a bit confused because in the Running the plugin section --volume-driver=anybox/buttervolume:latest is used while in Creating and deleting volumes it is volume-driver=btrfs. Thanks in advance for the clarification :)

ccomb commented 8 months ago

Hi ! Thanks a lot for your question! It seems you just reported a bug in the documentation.

The driver used to be named after the created socket, which is btrfs.sock. But now the volume-driver option takes the outside name of the driver, which is anybox/buttervolume.

There is no relation with the built-in btrfs storage driver. Buttervolume is not a storage driver, but a volume plugin or volume driver.

NKnusperer commented 8 months ago

Thank you. Should we use the built-in btrfs storage driver in conjunction with Buttervolume?

ccomb commented 8 months ago

You can use any storage driver with buttervolume since it's unrelated. I personnaly use it both on my 100% BTRFS laptop with a btrfs storage driver, and on a Flatcar server whose storage driver is overlay2 on top of an ext4 partition, with just a BTRFS parttion for buttervolume.

(BTW I've fixed the doc, thanks again)

ccomb commented 8 months ago

Just a remark the btrfs name must still be used when the package is used manually with buttervolume run without building the docker driver.