https://github.com/djmaze/docker-plugin-volume-mounter

Automatically mount docker plugin mounts under a central path
https://github.com/djmaze/docker-plugin-volume-mounter

Last synced: about 1 month ago
JSON representation

Automatically mount docker plugin mounts under a central path

• Host: GitHub
• URL: https://github.com/djmaze/docker-plugin-volume-mounter
• Owner: djmaze
• Created: 2019-09-30T19:55:45.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-05-11T20:39:15.000Z (over 1 year ago)
• Last Synced: 2024-12-08T20:41:20.654Z (about 2 months ago)
• Language: Go
• Homepage: https://hub.docker.com/r/decentralize/docker-plugin-volume-mounter
• Size: 168 KB
• Stars: 1
• Watchers: 5
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# Docker Plugin Volume Mounter

[![Docker Pulls](https://img.shields.io/docker/pulls/decentralize/docker-plugin-volume-mounter.svg)](https://hub.docker.com/r/decentralize/docker-plugin-volume-mounter)

[![Build Status](https://ci.strahlungsfrei.de/api/badges/djmaze/docker-plugin-volume-mounter/status.svg)](https://ci.strahlungsfrei.de/djmaze/docker-plugin-volume-mounter)

Docker container which makes remote Docker volumes available under a well-known path. This helps with backups.

## What does it do?

This containers watches the Docker API for new volume mounts (that happens when a container is started with a volume). If the volume is not using the `local` driver, the mount directory is bind-mounted to a subfolder in `/mnt/docker-volumes`.

## What is it good for?

When using a Docker volume for mounting remote drives or directories (e.g. S3 with [Rexray](https://github.com/rexray/rexray/)), the remote directory is mounted under a non-deterministic path beyond the volume plugin's root directory. Thus, there is no clean way of taking backups from within the cluster.

When running this container, DVM will make sure there is a directory for each remote volume. Also, the directory is deterministically named after the volume name.

This allows making consistent backups also in a Swarm cluster, e.g. with [Resticker](https://github.com/djmaze/resticker).

## Usage

```bash

docker run -d --rm \

  --cap-add SYS_ADMIN \

  --privileged \

  -v /mnt/docker-volumes:/mnt/docker-volumes:shared \

  -v /var/lib/docker/plugins:/var/lib/docker/plugins:ro \

  -v /var/run/docker.sock:/var/run/docker.sock \

  decentralize/docker-plugin-volume-mounter-starter

```

See also the provided _docker-compose.*.yml_ files for examples on how to run this on single server, in a Swarm cluster and with [Docker Socket Proxy](https://github.com/Tecnativa/docker-socket-proxy).

### Running on Docker Swarm

As the container needs `SYS_ADMIN` capabilities and Docker Swarm does not yet support running with caps, there is a starter image (`decentralize/docker-plugin-volume-mounter-starter`) which uses the Docker socket in order to run a container with the required capability. The starter container itself does not required heightened capabilities, so it can be created as a Swarm service.

See [docker-compose.swarm.yml](docker-compose.swarm.yml) on how it can used.