Docker Volume Driver For Linode

Requirements

• Linux (tested on Ubuntu 18.04, should work with other versions and distros)
• Docker (tested on version 17, should work with other versions)

Installation

Install and Configure (one step)

docker plugin install --alias linode linode/docker-volume-linode linode-token=<linode token> linode-region=<linode region> linode-label=<linode label>

Install and Configure (separate steps)

docker plugin install --alias linode linode/docker-volume-linode
docker plugin disable linode
docker plugin set linode linode-token=<linode token>
docker plugin set linode linode-region=<linode region>
docker plugin set linode linode-label=<linode label>
docker plugin enable linode

<linode token>: Token must be generated usigng Linode Control Panel https://login.linode.com. The generated API Token must have Read/Write permission for Volumes and Linodes. <linode regions>: us-east, us-central, us-southeast, us-west, eu-west, eu-central, ap-south, ap-northeast, ap-northeast-1a <linode label>: The label given to the host Linode Control Panel.

• For a complete list of regions: https://api.linode.com/v4/regions
• For all options see "Driver Options" section

Docker Swarm

For this volume to work in swarm mode it must be installed in all nodes.

Usage

All examples assume driver has been aliased to linode.

Create Volume

$ docker volume create -d linode my-test-volume
my-test-volume

Create 50G Volume

$ docker volume create -o size=50 -d linode my-test-volume-50
my-test-volume-50

List Volumes

$ docker volume ls
DRIVER              VOLUME NAME
linode:latest       my-test-volume
linode:latest       my-test-volume-50

Use Volume

$ docker run --rm -it -v my-test-volume:/usr/local/apache2/htdocs/ httpd
...

Remove Volumes

$ docker volume rm my-test-volume
my-test-volume

$ docker volume rm my-test-volume-50
my-test-volume-50

Driver Options

Option Name	Description
linode-token	Required The Linode APIv4 Personal Access Token
linode-label	Required The Linode Label to attach block storage volumes to (defaults to the system hostname)
linode-region	The Linode region to create volumes in (inferred if using linode-label, defaults to us-west)
socket-file	Sets the socket file/address (defaults to /run/docker/plugins/linode.sock)
socket-gid	Sets the socket GID (defaults to 0)
mount-root	Sets the root directory for volume mounts (default /mnt)
log-level	Sets log level to debug,info,warn,error (defaults to info)

Options can be set once for all future uses with docker plugin set.

Manual Installation

Requirements

• Install Golang: https://golang.org/
• Get code and Compile: go get -u github.com/linode/docker-volume-linode

Run the driver

docker-volume-linode --linode-token=<token from linode console> --linode-region=<linode region> --linode-label=<linode label>

Debugging

Enable Debug Level on plugin

The driver name when running manually is the same name as the socket file.

docker plugin set docker-volume-linode LOG_LEVEL=debug

Enable Debug Level in manual installation

docker-volume-linode --linode-token=<...> --linode-region=<...> --linode-label=<...> --log-level=debug

Tested On

Ubuntu 18.04 LTS

Tested With:
Client:
 Version:       17.12.1-ce
 API version:   1.35
 Go version:    go1.10.1
 Git commit:    7390fc6
 Built: Wed Apr 18 01:23:11 2018
 OS/Arch:       linux/amd64

Server:
 Engine:
  Version:      17.12.1-ce
  API version:  1.35 (minimum version 1.12)
  Go version:   go1.10.1
  Git commit:   7390fc6
  Built:        Wed Feb 28 17:46:05 2018
  OS/Arch:      linux/amd64
  Experimental: false