Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sapk/docker-volume-rclone
Use Rclone as a backend for docker volume (also as a plugin). This permit to easely mount a lot of cloud provider (https://rclone.org/overview).
https://github.com/sapk/docker-volume-rclone
docker docker-plugin docker-volume docker-volume-plugin rclone
Last synced: about 2 months ago
JSON representation
Use Rclone as a backend for docker volume (also as a plugin). This permit to easely mount a lot of cloud provider (https://rclone.org/overview).
- Host: GitHub
- URL: https://github.com/sapk/docker-volume-rclone
- Owner: sapk
- License: mit
- Created: 2017-11-11T16:32:55.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-02-25T07:00:36.000Z (almost 2 years ago)
- Last Synced: 2024-08-01T03:23:08.618Z (4 months ago)
- Topics: docker, docker-plugin, docker-volume, docker-volume-plugin, rclone
- Language: Go
- Homepage:
- Size: 7.87 MB
- Stars: 108
- Watchers: 8
- Forks: 9
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Support: support/docker/Dockerfile
Awesome Lists containing this project
- stars - sapk/docker-volume-rclone
README
# docker-volume-rclone [](https://github.com/sapk/docker-volume-rclone/blob/master/LICENSE) 
[](https://github.com/sapk/docker-volume-rclone/releases) [](https://goreportcard.com/report/github.com/sapk/docker-volume-rclone)
[](https://codecov.io/gh/sapk/docker-volume-rclone)
master : [](https://travis-ci.org/sapk/docker-volume-rclone) develop : [](https://travis-ci.org/sapk/docker-volume-rclone)
Use Rclone as a backend for docker volume. This permit to easely mount a lot of cloud provider (https://rclone.org/overview/).
Status : **BETA (work and in use but still need improvements)**
Use Rclone cli in the plugin container so it depend on fuse on the host.
## Docker plugin (Easy method) [](https://hub.docker.com/r/sapk/plugin-rclone) [](https://hub.docker.com/r/sapk/plugin-rclone)
```
docker plugin install sapk/plugin-rclone
docker volume create --driver sapk/plugin-rclone --opt config="$(base64 ~/.config/rclone/rclone.conf)" --opt remote=some-remote:bucket/path --name test
docker run -v test:/mnt --rm -ti ubuntu
```
## Build
```
make
```
## Start daemon
```
./docker-volume-rclone daemon
OR in a docker container
docker run -d --device=/dev/fuse:/dev/fuse --cap-add=SYS_ADMIN --cap-add=MKNOD -v /run/docker/plugins:/run/docker/plugins -v /var/lib/docker-volumes/rclone:/var/lib/docker-volumes/rclone:shared sapk/docker-volume-rclone
```
For more advance params : ```./docker-volume-rclone --help OR ./docker-volume-rclone daemon --help```
```
Run listening volume drive deamon to listen for mount request
Usage:
docker-volume-rclone daemon [flags]
Global Flags:
-b, --basedir string Mounted volume base directory (default "/var/lib/docker-volumes/rclone")
-v, --verbose Turns on verbose logging
```
## Create and Mount volume
```
docker volume create --driver rclone --opt config="$(base64 ~/.config/rclone/rclone.conf)" --opt remote=some-remote:bucket/path --name test
docker run -v test:/mnt --rm -ti ubuntu
```
## Allow acces to non-root user
Some image doesn't run with the root user (and for good reason). To allow the volume to be accesible to the container user you need to add some mount option: `--opt args="--uid 1001 --gid 1001 --allow-root --allow-other"`.
For example, to run an ubuntu image with an non root user (uid 33) and mount a volume:
```
docker volume create --driver sapk/plugin-rclone --opt config="$(base64 ~/.config/rclone/rclone.conf)" --opt args="--uid 33 --gid 33 --allow-root --allow-other" --opt remote=some-remote:bucket/path --name test
docker run -i -t -u 33:33 --rm -v test:/mnt ubuntu /bin/ls -lah /mnt
```
## Docker-compose
First put your rclone config in a env variable:
```
export RCLONE_CONF_BASE64=$(base64 ~/.config/rclone/rclone.conf)
```
And setup you docker-compose.yml file like that
```
volumes:
some_vol:
driver: sapk/plugin-rclone
driver_opts:
config: "${RCLONE_CONF_BASE64}"
args: "--read-only --fast-list"
remote: "some-remote:bucket/path"
```
You can also hard-code your config in the docker-compose file in place of the env variable.
## Healthcheck
The docker plugin volume protocol doesn't allow the plugin to inform the container or the docker host that the volume is not available anymore.
To ensure that the volume is always live, It is recommended to setup an healthcheck to verify that the mount is responding.
You can add an healthcheck like this example:
```
services:
server:
image: my_image
healthcheck:
test: ls /my/rclone/mount/folder || exit 1
interval: 1m
timeout: 15s
retries: 3
start_period: 15s
```
## Inspired from :
- https://github.com/ContainX/docker-volume-netshare/
- https://github.com/vieux/docker-volume-sshfs/
- https://github.com/sapk/docker-volume-gvfs
- https://github.com/calavera/docker-volume-glusterfs
- https://github.com/codedellemc/rexray
## How to debug docker managed plugin :
```
#Restart plugin in debug mode
docker plugin disable sapk/plugin-rclone
docker plugin set sapk/plugin-rclone DEBUG=1
docker plugin enable sapk/plugin-rclone
#Get files under /var/log of plugin
runc --root /var/run/docker/plugins/runtime-root/plugins.moby list
runc --root /var/run/docker/plugins/runtime-root/plugins.moby exec -t $CONTAINER_ID cat /var/log/rclone.log
runc --root /var/run/docker/plugins/runtime-root/plugins.moby exec -t $CONTAINER_ID cat /var/log/docker-volume-rclone.log
```