NexentaEdge Plugin for Docker Volumes

Description

This plugin provides the ability to use NexentaEdge 2.0 Clusters as backend devices in a Docker environment over NFS protocol.

Prerequisites

Golang

To install the latest Golang, just follow the easy steps on the Go install websiste. Again, I prefer to download the tarball and install myself rather than use a package manager like apt or yum: Get Go

NOTE: It's very important that you follow the directions and setup your Go environment. After downloading the appropriate package be sure to scroll down to the Linux, Mac OS X, and FreeBSD tarballs section and set up your Go environment as per the instructions.

You will need to make sure you've added the $GOPATH/bin to your path, AND on Ubuntu you will also need to enable the use of the GO Bin path by sudo; either run visudo and edit, or provide an alias in your .bashrc file.

You need to pre-create a folder for the GO code. For example in your .bashrc set the following alias after setting up PATH:

export GOPATH=<your GO folder>
export PATH=$PATH:/usr/local/go/bin:$GOPATH/bin/
alias sudo='sudo env PATH=$PATH'

Source .bashrc to update variables

  source .bashrc

GCC

  apt-get install gcc

NOTE: Should be run as root and command may differ depending on your OS.

Docker

You can find instructions and steps on the Docker website here: Get Docker

Driver Installation

After the above Prerequisites are met, use the Makefile:

git clone -b stable/v13 --single-branch https://github.com/Nexenta/nedge-docker-nfs-builders.git
cd nedge-docker-nfs-builders
make install

NDNFS plugin and related modules will be downloaded to GO workspace into $GOPATH/src/github.com/Nexenta/nedge-docker-nfs folder NDNFS plugin will be build into $GOPATH/bin folder and installed into /opt/nedge/sbin/ folder

Configuration

Default path to config file is

/opt/nedge/etc/ccow/ndnfs.json

Starting the daemon

After install and setting up a configuration, all you need to is start the nexenta-docker-driver daemon so tha it can accept requests from Docker.

sudo /opt/nedge/sbin/ndnfs daemon start -v

Usage Examples

Now that the daemon is running, you're ready to issue calls via the Docker Volume API and have the requests serviced by the NexentaEdge Driver.

For a list of avaialable commands run:

docker volume --help

Here's an example of how to create a Nexenta volume using the Docker Volume API:

docker volume create -d ndnfs --name=testvolume -o size=1024

Now in order to use that volume with a Container you simply specify

docker run -v testvolume:/Data --volume-driver=ndnfs -i -t ubuntu
/bin/bash

Note that if you had NOT created the volume already, Docker will issue the create call to the driver for you while launching the container. The Driver create method checks the Nexenta backend to see if the Volume already exists, if it does it just passes back the info for the existing volume, otherwise it runs through the create process and creates the Volume on the Nexenta backend.