How to guide for using rclone as Docker Volume driver
Here are a step-by-step guide on how to use rclone/docker-volume-rclone
volume driver.
- Create
config
andcache
directories - Create
rclone.conf
configuration file - Install
rclone/docker-volume-rclone
plugin
Important
You need to perform the above tasks on all nodes that required access to the volume driver.
By default the plugin use this following directory to store rclone.conf
and cache
but you must create the directory before hand.
sudo mkdir -p /var/lib/docker-plugins/rclone/config
sudo mkdir -p /var/lib/docker-plugins/rclone/cache
If you wish to change the directory please install the plugin using custom config
and cache
directory.
Create rclone.conf
configuration file in the config
directory you just created.
Here an example using MinIO:
[minio]
type = s3
provider = Minio
env_auth = false
access_key_id = minioadmin
secret_access_key = minioadmin
region = us-east-1
endpoint = http:https://127.0.0.1:9000
location_constraint =
server_side_encryption =
Default install
docker plugin install rclone/docker-volume-rclone:amd64 \
--alias rclone \
--grant-all-permissions \
args="-v --allow-other"
# config=/var/lib/docker-plugins/rclone/config
# cache=/var/lib/docker-plugins/rclone/cache
Or install with custom config
and cache
directory.
docker plugin install rclone/docker-volume-rclone:amd64 \
--alias rclone \
--grant-all-permissions \
args="-v --allow-other" \
config=/path/rclone/config \
cache=/path/rclone/cache
To enable the plugin, run:
docker plugin enable rclone
To diable the plugin, run:
docker plugin enable rclone
Note
Before you can disable the plugin, you will need to stop/remove any containers and volumes that are currently using the plugin.