netappdvp

NetApp Docker Volume Plugin

The NetApp Docker Volume Plugin (nDVP) provides direct integration with the Docker ecosystem for NetApp's ONTAP, E-Series, and SolidFire storage platforms. The nDVP package supports the provisioning and management of storage resources from the storage platform to Docker hosts, with a robust framework for adding additional platforms in the future.

Multiple instances of the nDVP can run concurrently on the same host. The allows simultaneous connections to multiple storage systems and storage types, with the ablity to customize the storage used for the Docker volume(s).

• Quick Start
• Running Multiple nDVP Instances
• Configuring your Docker host for NFS or iSCSI
  • NFS
    • RHEL / CentOS
    • Ubuntu / Debian
  • iSCSI
    • RHEL / CentOS
    • Ubuntu / Debian
• Global Config File Variables
  • Storage Prefix
• ONTAP Config File Variables
  • Example ONTAP Config Files
• E-Series Config File Variables
  • Example E-Series Config Files
  • E-Series Array Setup Notes
• SolidFire Config File Variables
  • Example Solidfire Config Files

Quick Start

1. Ensure you have Docker version 1.10 or above.

   docker --version
   

   If your version is out of date, update to the latest.

   curl -fsSL https://get.docker.com/ | sh
   

   Or, follow the instructions for your distribution.

2. After ensuring the correct version of Docker is installed, install and configure the NetApp Docker Volume Plugin. Note, you will need to ensure that NFS and/or iSCSI is configured for your system. See the installation instructions below for detailed information on how to do this.

   # download and unpack the application
   wget https://github.com/NetApp/netappdvp/releases/download/v1.4.0/netappdvp-1.4.0.tar.gz
   tar zxf netappdvp-1.4.0.tar.gz
   
   # move to a location in the bin path
   sudo mv netappdvp /usr/local/bin
   sudo chown root:root /usr/local/bin/netappdvp
   sudo chmod 755 /usr/local/bin/netappdvp
   
   # create a location for the config files
   sudo mkdir -p /etc/netappdvp
   
   # create the configuration file, see below for more configuration examples
   cat << EOF > /etc/netappdvp/ontap-nas.json
   {
       "version": 1,
       "storageDriverName": "ontap-nas",
       "managementLIF": "10.0.0.1",
       "dataLIF": "10.0.0.2",
       "svm": "svm_nfs",
       "username": "vsadmin",
       "password": "netapp123",
       "aggregate": "aggr1"
   }
   EOF
   

3. After placing the binary and creating the configuration file(s), start the nDVP daemon using the desired configuration file.

   Note: Unless specified, the default name for the volume driver will be "netapp".

   sudo netappdvp --config=/etc/netappdvp/ontap-nas.json
   

4. Once the daemon is started, create and manage volumes using the Docker CLI interface.

   docker volume create -d netapp --name ndvp_1
   

   Provision Docker volume when starting a container:

   docker run --rm -it --volume-driver netapp --volume ndvp_2:/my_vol alpine ash
   

   Destroy docker volume:

   docker volume rm ndvp_1
   docker volume rm ndvp_2
   

Running Multiple nDVP Instances

1. Launch the plugin with an NFS configuration using a custom driver ID:

   sudo netappdvp --volume-driver=netapp-nas --config=/path/to/config-nfs.json
   

2. Launch the plugin with an iSCSI configuration using a custom driver ID:

   sudo netappdvp --volume-driver=netapp-san --config=/path/to/config-iscsi.json
   

3. Provision Docker volumes each driver instance:

   NFS

   docker volume create -d netapp-nas --name my_nfs_vol
   

   iSCSI

   docker volume create -d netapp-san --name my_iscsi_vol
   

Configuring your Docker host for NFS or iSCSI

NFS

Install the following system packages:

RHEL / CentOS

sudo yum install -y nfs-utils

Ubuntu / Debian

sudo apt-get install -y nfs-common

iSCSI

RHEL / CentOS

1. Install the following system packages:

   sudo yum install -y lsscsi iscsi-initiator-utils sg3_utils device-mapper-multipath
   

2. Start the multipathing daemon:

   sudo mpathconf --enable --with_multipathd y
   

3. Ensure that iscsid and multipathd are enabled and running:

   sudo systemctl enable iscsid multipathd
   sudo systemctl start iscsid multipathd
   

4. Discover the iSCSI targets:

   sudo iscsiadm -m discoverydb -t st -p <DATA_LIF_IP> --discover
   

5. Login to the discovered iSCSI targets:

   sudo iscsiadm -m node -p <DATA_LIF_IP> --login
   

6. Start and enable iscsi:

   sudo systemctl enable iscsi
   sudo systemctl start iscsi
   

Ubuntu / Debian

1. Install the following system packages:

   sudo apt-get install -y open-iscsi lsscsi sg3-utils multipath-tools scsitools
   

2. Enable multipathing:

   sudo tee /etc/multipath.conf <<-'EOF'
   defaults {
       user_friendly_names yes
       find_multipaths yes
   }
   EOF
   
   sudo service multipath-tools restart
   

3. Ensure that iscsid and multipathd are running:

   sudo service open-iscsi start
   sudo service multipath-tools start
   

4. Discover the iSCSI targets:

   sudo iscsiadm -m discoverydb -t st -p <DATA_LIF_IP> --discover
   

5. Login to the discovered iSCSI targets:

   sudo iscsiadm -m node -p <DATA_LIF_IP> --login
   

Global Configuration File Variables

Storage Prefix

A new config file variable has been added in v1.2 called "storagePrefix" that allows you to modify the prefix applied to volume names by the plugin. By default, when you run docker volume create, the volume name supplied is prepended with "netappdvp_". ("netappdvp-" for SolidFire.)

If you wish to use a different prefix, you can specify it with this directive. Alternatively, you can use pre-existing volumes with the volume plugin by setting storagePrefix to an empty string, "".

solidfire specific recommendation do not use a storagePrefix (including the default) By default the SolidFire driver will ignore this setting and not use a prefix. We recommend using either a specific tenantID for docker volume mapping or using the attribute data which is populated with the docker version, driver info and raw name from docker in cases where any name munging may have been used.

A note of caution: docker volume rm will delete these volumes just as it does volumes created by the plugin using the default prefix. Be very careful when using pre-existing volumes!

ONTAP Config File Variables

In addition to the global configuration values above, when using clustered Data ONTAP, these options are avaialble.

Example ONTAP Config Files

NFS Example for ontap-nas driver

{
    "version": 1,
    "storageDriverName": "ontap-nas",
    "managementLIF": "10.0.0.1",
    "dataLIF": "10.0.0.2",
    "svm": "svm_nfs",
    "username": "vsadmin",
    "password": "netapp123",
    "aggregate": "aggr1"
}

iSCSI Example for ontap-san driver

{
    "version": 1,
    "storageDriverName": "ontap-san",
    "managementLIF": "10.0.0.1",
    "dataLIF": "10.0.0.3",
    "svm": "svm_iscsi",
    "username": "vsadmin",
    "password": "netapp123",
    "aggregate": "aggr1"
}

E-Series Config File Variables

In addition to the global configuration values above, when using E-Series, these options are available.

Example E-Series Config File

Example for eseries-iscsi driver

{
	"version": 1,
	"storageDriverName": "eseries-iscsi",
	"debug": true,
	"webProxyHostname": "localhost",
	"webProxyPort": "8443",
	"webProxyUseHTTP": false,
	"webProxyVerifyTLS": true,
	"username": "rw",
	"password": "rw",
	"controllerA": "10.0.0.5",
	"controllerB": "10.0.0.6",
	"passwordArray": "",
	"hostDataIP": "10.0.0.101"
}

E-Series Array Setup Notes

The E-Series Docker driver can provision Docker volumes in any storage pool on the array, including volume groups and DDP pools. To limit the Docker driver to a subset of the storage pools, set the poolNameSearchPattern in the configuration file to a regular expression that matches the desired pools.

When creating a docker volume you can specify the pool name, volume size, and disk media type using the '-o' option and the tags 'pool, 'size', and 'mediaType', respectively. Valid values for media type are 'hdd' and 'ssd'. Note that these are optional; if unspecified, the defaults will be a 1 GB volume allocated from an HDD pool. An example of using these tags to create a 2 GB volume from any available SSD-based pool with sufficient space available:

docker volume create -d netapp --name my_vol -o size=2g -o mediaType=ssd

The E-series Docker driver will detect and use any preexisting Host definitions without modification, and the driver will automatically define Host and Host Group objects as needed. The host type for hosts created by the driver defaults to "linux_dm_mp", the native DM-MPIO multipath driver in Linux.

The current E-series Docker driver only supports iSCSI.

SolidFire Config File Variables

In addition to the global configuration values above, when using SolidFire, these options are available.

LegacyNamePrefix If you used a version of ndvp prior to 1.3.2 and perform an upgrade with existing volumes, you'll need to set this value in order to access your old volumes that were mapped via the volume-name method.

Example Solidfire Config File

{
    "version": 1,
    "storageDriverName": "solidfire-san",
    "debug": false,
    "Endpoint": "https://admin:admin@192.168.160.3/json-rpc/7.0",
    "SVIP": "10.0.0.7:3260",
    "TenantName": "docker",
    "DefaultVolSz": 1,
    "InitiatorIFace": "default",
    "Types": [
        {
            "Type": "Bronze",
            "Qos": {
                "minIOPS": 1000,
                "maxIOPS": 2000,
                "burstIOPS": 4000
            }
        },
        {
            "Type": "Silver",
            "Qos": {
                "minIOPS": 4000,
                "maxIOPS": 6000,
                "burstIOPS": 8000
            }
        },
        {
            "Type": "Gold",
            "Qos": {
                "minIOPS": 6000,
                "maxIOPS": 8000,
                "burstIOPS": 10000
            }
        }
    ]

}

##Known Issues and Limitations

1. Volume names must be a minimum of 2 characters in length

   This is a Docker client limitation. The client will interpret a single character name as being a Windows path. Bug 25773