Docker volume plugin for bindfs

This project is based on vieux/docker-volume-sshfs. With this plugin you're able to mount a given path and remap its owner and group.

The plugin is based on bindfs usage to mount folders. https://bindfs.org/

About this fork

This is a fork of https://github.com/lebokus/docker-volume-bindfs

• support multiple volume with same mount points
• can choose version of bindfs (consult available version from here
• add more info and clean build process
• resolve bindfs defunct process each time a volume is destroyed
• isolate bindfs-state.json state file for each plugin version

Usage

Install the plugin

This will install the plugin from pre-built versions

docker plugin install studioetrange/bindfs:2.0

Notes on available pre-built versions

In docker hub, under studioetrange/bindfs available versions are

PLUGIN NAME	BINDFS VERSION	GO VERSION	NOTES
studioetrange/bindfs:2.0b	1.13.11	1.20.1	upgrade plugin logic itself and version of go
studioetrange/bindfs:2.0a	1.17.2	1.20.1	upgrade plugin logic itself and version of bindfs and go
studioetrange/bindfs:1.2	1.13.11	1.14.12	upgrade of docker go-plugin-helpers to remove useless docker log spam
studioetrange/bindfs:1.1	1.13.11
studioetrange/bindfs:1.0	1.13.10		DO NOT USE : Have a bug, create bindfs defunct process when removing volume

Create a volume

docker volume create -d studioetrange/bindfs:2.0 -o sourcePath=$PWD -o map=$(id -u)/0:@$(id -g)/@0 [-o <any_bindfs_-o_option> ] bindfsvolume

docker volume ls

DRIVER              VOLUME NAME
local               be9632386a2d396d438c9707e261f86fd9f5e72a7319417901d84041c8f14a4d
local               e1496dfe4fa27b39121e4383d1b16a0a7510f0de89f05b336aab3c0deb4dda0e
studioetrange/bindfs      bindfsvolume

Use the volume

docker run -it -v bindfsvolume:<path> busybox ls -la <path>

Example for docker-compose file

export EUID=$(id -u)
export EGID=$(id -g)

version: '2'
services:
    app:
        image: busybox
        command: "ls -la /mnt/test"
        volumes:
          - data:/mnt/test

volumes:
    data:
        driver: studioetrange/bindfs:2.0
        driver_opts:
            sourcePath: "${PWD}"
            map: "${EUID}/0:@${EGID}/@0"

Plugin development

Build plugin

• This will build plugin, tagged as latest, delete plugin if he already exists and install it

  git clone https://github.com/StudioEtrange/docker-volume-bindfs
  cd docker-volume-bindfs
  make all
  

• Options : you can fix a TAG for the plugin version and choose a bindfs version

  make PLUGIN_TAG=2.0a BINDFS_VERSION=1_17_2 all
  make PLUGIN_TAG=2.0b BINDFS_VERSION=1_13_11 all
  
  # without using docker cache :
  make PLUGIN_TAG=2.0a BINDFS_VERSION=1_17_2 all-nocache 
  

Enable built plugin

• This will enable the plugin, you need this before using it

  make enable
  

• Choose the version to enable

  make enable PLUGIN_TAG=2.0
  

Debug

• Enable debug mode on the installed plugin

  make enable-debug
  

  OR

  docker plugin disable studioetrange/bindfs:latest
  docker plugin set studioetrange/bindfs:latest DEBUG=1
  docker plugin enable studioetrange/bindfs:latest
  

• Exec into the installed and running plugin

  # get ID of the plugin
  sudo runc --root /run/docker/runtime-runc/plugins.moby list 
  # exec shell into plugin
  sudo runc --root /run/docker/runtime-runc/plugins.moby exec -t <ID> sh
  

• Build and launch a new container with plugin binaries inside

  make test
  # without using docker cache :
  make test-nocache
  

Publish plugin

• Publish a built plugin to docker hub

  make DOCKER_LOGIN='foo' DOCKER_PASSWORD='bar' PLUGIN_TAG=2.0 push
  

GO update version and dependency management

• For go 2.20 using standard Go Modules (without govendor) (project tag =>2.0)

  git clone https://github.com/StudioEtrange/docker-volume-bindfs
  git checkout 2.0
  cd docker-volume-bindfs
  docker run -it --rm --volume=$(pwd):/go/src/github.com/StudioEtrange/docker-volume-bindfs golang:1.20.1-bullseye bash
  
  # FROM INSIDE CONTAINER
  cd /go/src/github.com/StudioEtrange/docker-volume-bindfs
  
  
  # check status of used packaged from source code
  go mod verify
  
  # INIT Go modules management
  go mod init
  
  # SYNC package between vendor content and vendor.json 
  go mod vendor
  
  # FROM OUTSIDE CONTAINER
  sudo chown -R $(id -u):$(id -g) vendor
  sudo chown -R $(id -u):$(id -g) go.mod
  sudo chown -R $(id -u):$(id -g) go.sum
  

• For go 1.14 with govendor (project tag <=1.2)

  git clone https://github.com/StudioEtrange/docker-volume-bindfs
  git checkout 1.2
  cd docker-volume-bindfs
  docker run -it --rm --volume=$(pwd):/go/src/github.com/StudioEtrange/docker-volume-bindfs golang:1.14.12-stretch bash
  
  # FROM INSIDE CONTAINER
  go get github.com/StudioEtrange/govendor
  cd /go/src/github.com/StudioEtrange/docker-volume-bindfs
  
  
  # check status of used packaged from source code
  govendor list
  
  # INIT a vendor folder
  govendor init
  
  # ADD/UPDATE a package with a specific version into vendor and update vendor.json
  govendor fetch <dep>@<version>
  govendor fetch github.com/Sirupsen/logrus@181d419aa9e2223811b824e8f0b4af96f9ba930
  
  # SYNC package between vendor content and vendor.json 
  govendor sync
  
  # FROM OUTSIDE CONTAINER
  sudo chown -R $(id -u):$(id -g) vendor
  

LICENSE

MIT