Ansible Role: rclone_docker_plugin

This Ansible role installs and sets up the rclone Docker Volume Plugin.

To install the role, run: ansible-galaxy role install tigattack.rclone_docker_plugin

For more details, check the rclone Docker Volume Plugin documentation. It's helpful for understanding how everything works.

Requirements

You need to have the community.docker collection.

You can install it with: ansible-galaxy collection install community.docker

Role Variables

Here are the main variables you might use. More variables and their defaults can be found in default/main.yml.

Important
Changing any of these variables after the initial installation may cause errors because volume plugins can't be updated while they are still active.
If you need to change any settings, you must remove the volumes using the plugin and disable the plugin first.

rclone_docker_plugin_version

This specifies the rclone volume plugin version. By default, it will install the latest version.

rclone_docker_plugin_args

These are the arguments for rclone. You can use rclone serve docker flags and generic rclone flags, including backend parameters that serve as defaults for volume creation.

rclone_docker_plugin_cache_dir

This is the cache directory for rclone. You usually don’t need to change it from the default value unless necessary.

rclone_docker_plugin_config_dir

This is the configuration directory for rclone. The plugin will look for rclone.conf in this directory. Again, the default value is usually fine unless you have a specific need to change it.

Example Playbook

Basic Use - Install just the plugin:

- hosts: all
  roles:
    - role: tigattack.rclone_docker_plugin

Advanced Use - Install a specific plugin version with custom arguments and a custom cache directory:

- hosts: all
  roles:
    - role: tigattack.rclone_docker_plugin
      vars:
        rclone_docker_plugin_version: '1.65.2'
        rclone_docker_plugin_args: >-
          --allow-other
          --vfs-cache-mode=full
          --vfs-cache-max-size=5G
        rclone_docker_plugin_cache_dir: /home/user/.cache/rclone
        rclone_docker_plugin_cache_dir_owner: user
        rclone_docker_plugin_cache_dir_group: user

Acknowledgements

Thanks to cycneuramus for the basic functionality of this role (cycneuramus/ansible-hybrid-cloud).